@sq-ui/ng-sq-ui
v2.1.0
Published
Simple Quality UI kit for Angular
Downloads
85
Readme
NG-SQ-UI
Simple Quality UI kit for Angular
built by developers for developers!
Docs
You will find a description of the public API for each component. The components are grouped by modules. Any properties you can see through code inspection that are left out from this documentation are for internal use and you should not rely on them.
Any types of public interfaces and services are also included.
- Home Page
- Installation
- FormElementsModule
- ModalModule
- ProgressBarModule
- DatetimePickerModule
- DatatableModule
- CommonModule
- About us
- Live examples
- Troubleshooting
Installation
npm i @sq-ui/ng-sq-ui --save
-- or --
yarn add @sq-ui/ng-sq-ui
Usage
Import the NgSqUiModule in your module:
import { NgSqUiModule } from '@sq-ui/ng-sq-ui';
and then include it in the imports
array of your @NgModule() decorator:
@NgModule({
declarations: [ //... ],
imports: [
NgSqUiModule,
//...
],
//...
ng-sq-ui does not come with a specific font. Including the default theme is also optional. Refer to our Live examples page.
Add styles to angular.json
"styles": [
"src/styles.css",
"./node_modules/@sq-ui/ng-sq-ui/sq-ui-theme.scss",
"./node_modules/@fortawesome/fontawesome-free/css/fontawesome.min.css",
"./node_modules/@fortawesome/fontawesome-free/css/solid.min.css",
"./node_modules/@fortawesome/fontawesome-free/css/regular.min.css",
],
Apply styling to the components
To use our styling just add the class="sq"
on a parent element.
<body class="sq">
<div class="row">
<sq-input ...></sq-input>
</div>
</body>
Custom templates
The FormElementsModule
exposes form controls that support custom templating. Refer to the FormElementsModule documentation for more information.
Support
- Use NG-SQ-UI in your daily work.
- Star ⭐ it if you like.
- Join us on ng slack or our main SQ slack channel.
- Follow us on twitter to get latest updates.
- Or simply send an email to contact[at]sq-ui.xyz.
- Sponsor with DevToken
- Tip us with BAT from brave awards or download brave
Contribution
Want to file a bug, contribute some code, or improve documentation? Read up on our Contributing Guide before making a pull request.
LICENSE
- MIT
- Feel free to use and contribute to the development.
Contributors
Thanks goes to these wonderful people!
This project follows the all-contributors specification. Contributions of any kind welcome!