FastyBird Web UI library

What is FastyBird Web UI library?

This library is a collection of Vue 3 framework components used for FastyBird IoT web applications user interfaces.

FastyBird IoT Web UI library is an Apache2 licensed distributed library, developed in Typescript on top of the Vue 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

Installation

The best way to install @fastybird/web-ui-library is using Yarn:

yarn add @fastybird/web-ui-library

or if you prefer npm:

npm install @fastybird/web-ui-library

Setup in your application

Register Vue plugin:

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:

<template>
    <div>
        Your fancy content here

        <fb-ui-button
          href="/new/page"
          variant="primary"
          size="md"
        >
            Click here
        </fb-ui-button>
    </div>
</template>

Typescript setup

Add the types to your "types" array in tsconfig.json.

{
  "compilerOptions": {
    "types": [
      "@fastybird/web-ui-library"
    ]
  }
}

Documentation

Learn how to use ui components in documentation.

Feedback

Use the issue tracker for bugs or mail or Tweet us for any idea that can improve the project.

Thank you for testing, reporting and contributing.

Changelog

For release info check release page.

Contribute

The sources of this package are contained in the FastyBird monorepo. We welcome contributions for this package on FastyBird/fastybird.

Maintainers

Adam Kadlec

---

Homepage https://www.fastybird.com and repository https://github.com/FastyBird/web-ui-library.