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.

Installation

You can clone / download this repo or install it as a node dependency.

npm i @sq-ui/ng-sq-ui@latest --save

-- or --

yarn add @sq-ui/ng-sq-ui@latest

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.

Need a grid? We've got you covered!

Add styles to angular.json

"styles": [
  "src/styles.css",
  "./node_modules/@sq-ui/ng-sq-common/sq-ui-theme.scss",
  "./node_modules/@sq-ui/ng-sq-ui/styles/form-elements.scss",
  "./node_modules/font-awesome/scss/font-awesome.scss"
],

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>

Dependencies

ng-sq-ui depends on:

font-awesome and immutable.js (both will be installed with ng-sq-ui)

Try it out locally

git clone git@github.com:SQ-UI/ng-sq-ui.git
npm i
npm run build:libs
ng serve [--open]

-- or --

git clone git@github.com:SQ-UI/ng-sq-ui.git
yarn install
yarn build:libs
ng serve [--open]

Every time you make changes to any of the libraries, you should run npm run build-libs to compile the latest versions of them before serving the main app.

Support

Use NG-SQ-UI in your daily work.
Star it if you like.
Join us on spectrum.chat.
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.

Thank you to all contributers!

_{Plamena Radneva} 💻 📖 ⚠️	_{Samuil Gospodinov} 💻 📖 ⚠️ 📢

LICENSE

MIT
Feel free to use and contribute to the development.

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

CreativeSlave/ng-sq-ui