NG-SQ-UI

Simple Quality UI kit for Angular

built by developers for developers!

travis

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.

BREAKING CHANGES:

The 2.0.1 relases of all packages are compatible with Angular 14+. If you need a backwards-compatible version, please refer to 1.x.y packages, as stated below.

Note:
For projects that use the View Engine, instead Ivy (Angular 10 ~ Angular 12), please use the following version for each package:

@sq-ui/ng-sq-ui: 1.3.3
@sq-ui/ng-datetime-picker: 1.1.2
@sq-ui/ng-sq-common: 1.1.5
@sq-ui/ng-modal: 1.1.2
@sq-ui/ng-datatable: 1.1.3

For projects that use Angular version < 9, please use the following version for each package:

@sq-ui/ng-sq-ui: 1.1.5
@sq-ui/ng-datetime-picker: 1.1.0
@sq-ui/ng-sq-common: 1.0.3
@sq-ui/ng-modal: 1.0.6
@sq-ui/ng-datatable: 1.0.3

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/@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>

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 start

-- or --

git clone git@github.com:SQ-UI/ng-sq-ui.git
yarn install
npm start

The libraries are watched automatically when you run npm start:

The TypeScript compiler for this project is configured to look for the libraries under dist/ and if dist/ does not exist, it refers to the libraries' source code. That is why you should run npm start instead of just ng serve --open - npm start removes dist/ (if it exists) and then runs ng serve --open. This prepares the compiler to listen for changes under the projects/ directory.

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!

_{Plamena Radneva}
💻 📖 ⚠️ ✅ 📝

_{Samuil Gospodinov}
💻 📖 ⚠️ 📢

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

SQ-UI / ng-sq-ui

readme