@sq-ui/ng-sq-common
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

@sq-ui/ng-sq-common

Simple Quality UI kit for Angular

built by developers for developers!

angular travis contributions welcome Maintainability All Contributors Mentioned in Awesome Angular Package download Stake to support us

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.

Installation

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

-- or --

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

Usage

Import the NgSqUiModule in your module:

import { NgSqCommonModule } from '@sq-ui/ng-sq-common';

and then include it in the imports array of your @NgModule() decorator:

@NgModule({
  declarations: [ //... ],
  imports: [
    NgSqCommonModule,
    //...
  ],
  //...

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/@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">
  <sq-paginator ...></sq-paginator>
</body>

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!

Readme

Keywords

none

Package Sidebar

Install

npm i @sq-ui/ng-sq-common

Weekly Downloads

50

Version

2.0.3

License

MIT

Unpacked Size

141 kB

Total Files

40

Last publish

Collaborators

  • ardentia
  • samuil4