Skip to content
Flexible and easily customizable UI-kit for Angular 6+
Branch: master
Clone or download
Latest commit 65c96bc Mar 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
.vscode
docs edited troubleshooting in docs Feb 11, 2019
e2e
projects
src
.all-contributorsrc
.codeclimate.yml
.editorconfig fixing project structure Aug 11, 2018
.gitignore fixing project structure Aug 11, 2018
.travis.yml prepared reamdes and refactored npm commands Feb 10, 2019
CONTRIBUTING.md
LICENSE Update LICENSE Aug 9, 2018
README.md updated main README Feb 11, 2019
angular.json
package-lock.json Bump @types/jasmine from 3.3.9 to 3.3.10 Mar 18, 2019
package.json Bump @types/jasmine from 3.3.9 to 3.3.10 Mar 18, 2019
tsconfig.json
tslint.json
yarn.lock Bump @types/jasmine from 3.3.9 to 3.3.10 Mar 18, 2019

README.md

NG-SQ-UI

Simple Quality UI kit for Angular

built by developers for developers!

angular travis contributions welcome Maintainability All Contributors Mentioned in Awesome Angular Package download @sq-ui/ng-sq-ui Dev Token

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

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!

You can’t perform that action at this time.