README.md
# NG-SQ-UI
> Simple Quality UI kit for Angular
> built by developers for developers!
[](https://github.com/SQ-UI/ng-sq-ui/issues)
[](https://codeclimate.com/github/SQ-UI/ng-sq-ui/maintainability)
[](#contributors)
[](https://github.com/gdi2290/awesome-angular)
[](https://stakes.social/0x014f98F05c0BeD44B4Cf0532a93312a2135afaB8)
[](https://app.netlify.com/sites/sq-ui-preview-develop/deploys)
[](https://www.jsdelivr.com/package/npm/@sq-ui/ng-sq-ui)
## 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.
- [Home Page](http://bit.ly/ng-sq-ui-docs-home)
- [Installation](http://bit.ly/ng-sq-ui-docs-installation)
- [FormElementsModule](http://bit.ly/ng-sq-ui-docs-form-elements)
- [ModalModule](http://bit.ly/ng-sq-ui-docs-modal)
- [ProgressBarModule](http://bit.ly/ng-sq-ui-docs-progressbar)
- [DatetimePickerModule](http://bit.ly/ng-sq-ui-docs-datetime-picker)
- [DatatableModule](http://bit.ly/ng-sq-ui-docs-datatable)
- [CommonModule](http://bit.ly/ng-sq-ui-docs-common)
- [About us](http://bit.ly/ng-sq-ui-docs-about-us)
- [Bounty Program](http://bit.ly/bounty-program)
- [Live examples](http://bit.ly/ng-sq-ui-docs-live-examples)
- [Troubleshooting](http://bit.ly/ng-sq-ui-docs-troubleshooting)
## 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:**<br>
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
<br>
**@sq-ui/ng-datetime-picker:** 1.1.2
<br>
**@sq-ui/ng-sq-common:** 1.1.5
<br>
**@sq-ui/ng-modal:** 1.1.2
<br>
**@sq-ui/ng-datatable:** 1.1.3
<br>
For projects that use Angular version < 9, please use the following version for each package:
**@sq-ui/ng-sq-ui:** 1.1.5 <br>
**@sq-ui/ng-datetime-picker:** 1.1.0 <br>
**@sq-ui/ng-sq-common:** 1.0.3 <br>
**@sq-ui/ng-modal:** 1.0.6 <br>
**@sq-ui/ng-datatable:** 1.0.3<br>
## 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](http://bit.ly/ng-sq-ui-docs-live-examples).
Need a grid? [We've got you covered](https://sq-ui.github.io/sq-grid/)!
### Add styles to angular.json
```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.
```html
<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 <a href="http://bit.ly/ng-sq-ui-slack">ng slack</a> or our main <a href="http://bit.ly/ng-sq-slack">SQ slack channel</a>.
- Follow us on [twitter](https://twitter.com/sq_ui_kit) to get latest updates.
- Or simply send an email to contact[at]sq-ui.xyz.
- Sponsor with [DevToken](https://stakes.social/0x014f98F05c0BeD44B4Cf0532a93312a2135afaB8)
- Tip us with BAT from brave awards or download [brave](https://brave.com/ngs747)
## Contribution
Want to file a bug, contribute some code, or improve documentation? Read up on our [Contributing Guide](CONTRIBUTING.md) before making a pull request.
## LICENSE
- [MIT](http://opensource.org/licenses/MIT)
- Feel free to use and contribute to the development.
## Contributors
Thanks goes to these wonderful <a href="https://github.com/sq-ui/ng-sq-ui/graphs/contributors">people</a>!
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/ardentia"><img src="https://avatars2.githubusercontent.com/u/41083417?v=4?s=50" width="50px;" alt=""/><br /><sub><b>Plamena Radneva</b></sub></a><br /><a href="https://github.com/SQ-UI/ng-sq-ui/commits?author=ardentia" title="Code">💻</a> <a href="https://github.com/SQ-UI/ng-sq-ui/commits?author=ardentia" title="Documentation">📖</a> <a href="https://github.com/SQ-UI/ng-sq-ui/commits?author=ardentia" title="Tests">⚠️</a> <a href="#tutorial-ardentia" title="Tutorials">✅</a> <a href="#blog-ardentia" title="Blogposts">📝</a></td>
<td align="center"><a href="https://github.com/samuil4"><img src="https://avatars0.githubusercontent.com/u/797921?v=4?s=50" width="50px;" alt=""/><br /><sub><b>Samuil Gospodinov</b></sub></a><br /><a href="https://github.com/SQ-UI/ng-sq-ui/commits?author=samuil4" title="Code">💻</a> <a href="https://github.com/SQ-UI/ng-sq-ui/commits?author=samuil4" title="Documentation">📖</a> <a href="https://github.com/SQ-UI/ng-sq-ui/commits?author=samuil4" title="Tests">⚠️</a> <a href="#talk-samuil4" title="Talks">📢</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!