0.2.0 • Published 2 years ago

flare-ui v0.2.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

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 need the JavaScript that provides the custom elements (this repository) and any compatible CSS theme that is made for styling flare-* elements.

For the script, you only need a single flare-ui.js file, which you can get 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, run npm install (or yarn) and npm run build (or yarn build)

You will also need to download a compatible theme, such as one from the flare-ui-themes package.

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>
    <link rel="stylesheet" href="flare-ui-themes/flat/flat.css">
  </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.