Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 1.33 KB

README.md

File metadata and controls

64 lines (44 loc) · 1.33 KB





Component library based on Vue and Tailwind

Documentation

For full documentation, visit Documentation.

Quick start

1 Install npm

npm install @solfacil/components-ui

or yarn

yarn add @solfacil/components-ui

2 Import and use @solfacil/components-ui

import { Button, RadioButton, ToggleSwitch } from '@solfacil/components-ui';

export default {
  components: {
    Button,
    RadioButton,
    ToggleSwitch,
  },
};

3 Import style Sass

Include pattern based on style guide and tailwind styles

@import '~@solfacil/components-ui/src/assets/scss/core';

Or all styles

@import '~@solfacil/components-ui/src/assets/scss/solfacil';

Optional / style component

@import '~@solfacil/components-ui/src/assets/scss/buttons';
@import '~@solfacil/components-ui/src/assets/scss/radio-button';

License

Released under the MIT License. Copyright (c) Solfácil.