Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastybird/web-ui-library
:books: [READ-ONLY] FastyBird basic theme & Vue components for web apps
https://github.com/fastybird/web-ui-library
components fastybird fb theme typescript ui user-interface vue vue3 vuejs
Last synced: about 1 month ago
JSON representation
:books: [READ-ONLY] FastyBird basic theme & Vue components for web apps
- Host: GitHub
- URL: https://github.com/fastybird/web-ui-library
- Owner: FastyBird
- License: apache-2.0
- Created: 2020-05-07T14:08:42.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T19:05:38.000Z (about 2 months ago)
- Last Synced: 2024-11-15T20:17:33.062Z (about 2 months ago)
- Topics: components, fastybird, fb, theme, typescript, ui, user-interface, vue, vue3, vuejs
- Language: Vue
- Homepage:
- Size: 57.5 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-1.0.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# FastyBird Web UI library
[](https://github.com/FastyBird/web-ui-library/actions)
[](https://github.com/FastyBird/web-ui-library/blob/main/LICENSE.md)
[](https://www.npmjs.com/package/@fastybird/web-ui-library)
[](https://www.npmjs.com/package/@fastybird/web-ui-library)
## What is FastyBird Web UI library?
This library is a collection of [Vue 3](https://vuejs.org) framework components used for [FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) web applications user interfaces.
[FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) Web UI library is an [Apache2 licensed](http://www.apache.org/licenses/LICENSE-2.0) distributed library, developed in [Typescript](https://www.typescriptlang.org) on top of the [Vue](https://vuejs.org) framework.
### Features:
- Web user interface elements like modal windows, buttons, alerts, switches etc.
- Forms elements with support for pre and post-fixes
- Page layout components for desktop and mobile views
- Customizable styles
## Requirements
Library is tested against [ECMAScript 6](https://www.w3schools.com/JS/js_es6.asp)
## Installation
The best way to install **@fastybird/web-ui-library** is using [Yarn](https://yarnpkg.com/):
```sh
yarn add @fastybird/web-ui-library
```
or if you prefer npm:
```sh
npm install @fastybird/web-ui-library
```
## Setup in your application
Register Vue plugin:
```js
import { createApp } from 'vue';
import { createWebUiTheme } from '@fastybird/web-ui-library'
import App from '@/App.vue';
const app = createApp(App);
app.use(createWebUiTheme());
```
## Usage
In you component you could use registered visual, form and layouts components:
```vue
Your fancy content here
Click here
```
## Typescript setup
Add the types to your `"types"` array in **tsconfig.json**.
```json
{
"compilerOptions": {
"types": [
"@fastybird/web-ui-library"
]
}
}
```
## Documentation
Learn how to use ui components in [documentation](https://storybook.fastybird.com/).
## Feedback
Use the [issue tracker](https://github.com/FastyBird/fastybird/issues) for bugs
or [mail](mailto:[email protected]) or [Tweet](https://twitter.com/fastybird) us for any idea that can improve the
project.
Thank you for testing, reporting and contributing.
## Changelog
For release info check [release page](https://github.com/FastyBird/fastybird/releases).
## Contribute
The sources of this package are contained in the [FastyBird monorepo](https://github.com/FastyBird/fastybird). We welcome contributions for this package on [FastyBird/fastybird](https://github.com/FastyBird/).
## Maintainers
***
Homepage [https://www.fastybird.com](https://www.fastybird.com) and repository [https://github.com/FastyBird/web-ui-library](https://github.com/FastyBird/web-ui-library).
