-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
44 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,19 @@ | |
|
||
This library is a collection of [Vue](https://vuejs.org) framework components used for [FastyBird](https://www.fastybird.com) web application user interfaces. | ||
|
||
[FastyBird](https://www.fastybird.com) [IoT](https://en.wikipedia.org/wiki/Internet_of_things) web-ui theme library is an [Apache2 licensed](http://www.apache.org/licenses/LICENSE-2.0) distributed library, developed in [Typescript](https://www.typescriptlang.org) with [Vue](https://vuejs.org) and [Nuxt](https://nuxtjs.org). | ||
|
||
### 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-theme** is using [Yarn](https://yarnpkg.com/): | ||
|
@@ -68,14 +81,35 @@ Add the types to your `"types"` array in **tsconfig.json**. | |
} | ||
``` | ||
|
||
#### Some constants: | ||
## Documentation | ||
|
||
Learn how to use ui components in [documentation](https://storybook.fastybird.com/). | ||
|
||
## Feedback | ||
|
||
Use the [issue tracker](https://github.com/FastyBird/web-ui-theme/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/web-ui-theme/releases) | ||
|
||
Defined sizes are: | ||
## Maintainers | ||
|
||
- small: 5px | ||
- normal: 10px | ||
- medium: 15px | ||
- large: 30px | ||
<table> | ||
<tbody> | ||
<tr> | ||
<td align="center"> | ||
<a href="https://github.com/akadlec"> | ||
<img width="80" height="80" src="https://avatars3.githubusercontent.com/u/1866672?s=460&v=4"> | ||
</a> | ||
<br> | ||
<a href="https://github.com/akadlec">Adam Kadlec</a> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
*** | ||
Homepage [https://www.fastybird.com](https://www.fastybird.com) and repository [https://github.com/FastyBird/web-ui-theme](https://github.com/FastyBird/web-ui-theme). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters