flare-ui
v0.3.0
Published
Modern widget toolkit for chromium-based browsers.
Downloads
7
Readme
Flare UI
Flare UI is a web based widget toolkit using custom elements.
This toolkit adds additional HTML elements, such as or .
Browser compatibility
This widget toolkit is designed to be used in Electron, which is Chrome-based. This should make browsers based on that engine compatible, including Microsoft Edge and Opera.
Other browsers are probably not or only partly supported.
Getting started
In order to get Flare UI running, you only need a single JavaScript file that provides the custom elements. You can get it in various ways:
- Download the latest release from GitHub
- Install via npm:
npm install flare-ui
- Install via yarn:
yarn add flare-ui
- Clone the repo with
git clone https://github.com/tenry92/flare-ui.git
, runnpm install
(oryarn
) andnpm run build
(oryarn build
)
Now you can link the script and theme files in your HTML and start writing your web application:
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<title>Welcome Flare UI</title>
<script src="dist/flare-ui.js" type="module"></script>
</head>
<body>
...
</body>
</html>
In the docs you will find a list of each available widget and their options.
License
Flare UI is licensed under the MIT License.