GithubHelp home page GithubHelp logo

y-a-n-n / ng-sq-ui Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sq-ui/ng-sq-ui

0.0 3.0 0.0 2.57 MB

Flexible and easily customizable UI-kit for Angular 6+

License: MIT License

JavaScript 3.03% TypeScript 69.80% HTML 16.63% CSS 10.54%

ng-sq-ui's Introduction

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 [email protected]:SQ-UI/ng-sq-ui.git
npm i
npm run build:libs
ng serve [--open]

-- or --

git clone [email protected]: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!

ng-sq-ui's People

Contributors

samuil4 avatar dependabot-support avatar ardentia avatar

Watchers

James Cloos avatar Yann avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.