{"id":13497145,"url":"https://github.com/SQ-UI/ng-sq-ui","last_synced_at":"2025-03-28T21:32:02.539Z","repository":{"id":33118163,"uuid":"144196505","full_name":"SQ-UI/ng-sq-ui","owner":"SQ-UI","description":"Flexible and easily customizable UI-kit for Angular 11+","archived":false,"fork":false,"pushed_at":"2024-03-19T13:45:08.000Z","size":8838,"stargazers_count":99,"open_issues_count":21,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-13T14:21:53.403Z","etag":null,"topics":["angular","angular-library","angular11","angular6","autocomplete","components","datepicker","form","modal","ng-sq-ui","sq-ui","timepicker","typeahead","typescript","ui","ui-components","ui-kit","uikit"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SQ-UI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-08-09T19:44:01.000Z","updated_at":"2023-12-01T07:05:25.000Z","dependencies_parsed_at":"2024-01-16T09:55:39.827Z","dependency_job_id":"c296a6ec-a98e-49d1-93cd-44748096a0e4","html_url":"https://github.com/SQ-UI/ng-sq-ui","commit_stats":{"total_commits":681,"total_committers":6,"mean_commits":113.5,"dds":0.5903083700440528,"last_synced_commit":"f3921e78d6a349f886810cef9d7b98002529d546"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SQ-UI%2Fng-sq-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SQ-UI%2Fng-sq-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SQ-UI%2Fng-sq-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SQ-UI%2Fng-sq-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SQ-UI","download_url":"https://codeload.github.com/SQ-UI/ng-sq-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246105252,"owners_count":20724277,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-library","angular11","angular6","autocomplete","components","datepicker","form","modal","ng-sq-ui","sq-ui","timepicker","typeahead","typescript","ui","ui-components","ui-kit","uikit"],"created_at":"2024-07-31T20:00:24.559Z","updated_at":"2025-03-28T21:32:01.993Z","avatar_url":"https://github.com/SQ-UI.png","language":"TypeScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# NG-SQ-UI\n\n\u003e Simple Quality UI kit for Angular\n\n\u003e built by developers for developers!\n\n![angular](https://badge.fury.io/js/angular.svg)\n![travis](https://travis-ci.com/SQ-UI/ng-sq-ui.svg?branch=master)\n[![contributions welcome](https://img.shields.io/badge/issues-welcome-brightgreen.svg?style=flat)](https://github.com/SQ-UI/ng-sq-ui/issues)\n[![Maintainability](https://api.codeclimate.com/v1/badges/d53c1670c301071be452/maintainability)](https://codeclimate.com/github/SQ-UI/ng-sq-ui/maintainability)\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors)\n[![Mentioned in Awesome Angular](https://awesome.re/mentioned-badge.svg)](https://github.com/gdi2290/awesome-angular)\n![Package download](https://img.shields.io/npm/dm/@sq-ui/ng-sq-ui.svg?logo=ng-sq-ui)\n[![Stake to support us](https://badge.devprotocol.xyz/0x014f98F05c0BeD44B4Cf0532a93312a2135afaB8/descriptive)](https://stakes.social/0x014f98F05c0BeD44B4Cf0532a93312a2135afaB8)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/f9cb1185-dc56-4886-99b9-57627d0e892d/deploy-status)](https://app.netlify.com/sites/sq-ui-preview-develop/deploys)\n [![](https://data.jsdelivr.com/v1/package/npm/@sq-ui/ng-sq-ui/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@sq-ui/ng-sq-ui)\n\n## Docs\n\nYou will find a description of the public API for each component.\nThe 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.\n\nAny types of public interfaces and services are also included.\n\n- [Home Page](http://bit.ly/ng-sq-ui-docs-home)\n- [Installation](http://bit.ly/ng-sq-ui-docs-installation)\n- [FormElementsModule](http://bit.ly/ng-sq-ui-docs-form-elements)\n- [ModalModule](http://bit.ly/ng-sq-ui-docs-modal)\n- [ProgressBarModule](http://bit.ly/ng-sq-ui-docs-progressbar)\n- [DatetimePickerModule](http://bit.ly/ng-sq-ui-docs-datetime-picker)\n- [DatatableModule](http://bit.ly/ng-sq-ui-docs-datatable)\n- [CommonModule](http://bit.ly/ng-sq-ui-docs-common)\n- [About us](http://bit.ly/ng-sq-ui-docs-about-us)\n- [Bounty Program](http://bit.ly/bounty-program)\n- [Live examples](http://bit.ly/ng-sq-ui-docs-live-examples)\n- [Troubleshooting](http://bit.ly/ng-sq-ui-docs-troubleshooting)\n\n## BREAKING CHANGES:\nThe 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.\n\n**Note:**\u003cbr\u003e\nFor projects that use the View Engine, instead Ivy (Angular 10 ~ Angular 12), please use the following version for each package:\n\n**@sq-ui/ng-sq-ui:** 1.3.3\n\u003cbr\u003e\n**@sq-ui/ng-datetime-picker:** 1.1.2\n\u003cbr\u003e\n**@sq-ui/ng-sq-common:** 1.1.5\n\u003cbr\u003e\n**@sq-ui/ng-modal:** 1.1.2\n\u003cbr\u003e\n**@sq-ui/ng-datatable:** 1.1.3\n\n\u003cbr\u003e\nFor projects that use Angular version \u003c 9, please use the following version for each package:\n\n**@sq-ui/ng-sq-ui:** 1.1.5 \u003cbr\u003e\n**@sq-ui/ng-datetime-picker:** 1.1.0 \u003cbr\u003e\n**@sq-ui/ng-sq-common:** 1.0.3 \u003cbr\u003e\n**@sq-ui/ng-modal:** 1.0.6 \u003cbr\u003e\n**@sq-ui/ng-datatable:** 1.0.3\u003cbr\u003e\n\n## Installation\n\n\u003e You can clone / download this repo or install it as a node dependency.\n\n```\nnpm i @sq-ui/ng-sq-ui@latest --save\n```\n\n-- or --\n\n```\nyarn add @sq-ui/ng-sq-ui@latest\n```\n\n## Usage\n\nImport the NgSqUiModule in your module:\n\n```\nimport { NgSqUiModule } from '@sq-ui/ng-sq-ui';\n```\n\nand then include it in the `imports` array of your @NgModule() decorator:\n\n```\n@NgModule({\n  declarations: [ //... ],\n  imports: [\n    NgSqUiModule,\n    //...\n  ],\n  //...\n```\n\nng-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).\n\nNeed a grid? [We've got you covered](https://sq-ui.github.io/sq-grid/)!\n\n### Add styles to angular.json\n\n```json\n\"styles\": [\n  \"src/styles.css\",\n  \"./node_modules/@sq-ui/ng-sq-common/sq-ui-theme.scss\",\n  \"./node_modules/@sq-ui/ng-sq-ui/styles/form-elements.scss\",\n  \"./node_modules/@fortawesome/fontawesome-free/css/fontawesome.min.css\",\n  \"./node_modules/@fortawesome/fontawesome-free/css/solid.min.css\",\n  \"./node_modules/@fortawesome/fontawesome-free/css/regular.min.css\",\n],\n```\n\n### Apply styling to the components\n\nTo use our styling just add the `class=\"sq\"` on a parent element.\n\n```html\n\u003cbody class=\"sq\"\u003e\n  \u003cdiv class=\"row\"\u003e\n    \u003csq-input ...\u003e\u003c/sq-input\u003e\n  \u003c/div\u003e\n\u003c/body\u003e\n```\n\n## Dependencies\n\nng-sq-ui depends on:\n\nfont-awesome and immutable.js (both will be installed with ng-sq-ui)\n\n## Try it out locally\n\n```\ngit clone git@github.com:SQ-UI/ng-sq-ui.git\nnpm i\nnpm start\n```\n\n-- or --\n\n```\ngit clone git@github.com:SQ-UI/ng-sq-ui.git\nyarn install\nnpm start\n```\n\nThe libraries are watched automatically when you run `npm start`:\n* 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.\n\n## Support\n\n- Use NG-SQ-UI in your daily work.\n- **Star** ⭐ it if you like.\n- Join us on \u003ca href=\"http://bit.ly/ng-sq-ui-slack\"\u003eng slack\u003c/a\u003e or our main \u003ca href=\"http://bit.ly/ng-sq-slack\"\u003eSQ slack channel\u003c/a\u003e.\n- Follow us on [twitter](https://twitter.com/sq_ui_kit) to get latest updates.\n- Or simply send an email to contact[at]sq-ui.xyz.\n- Sponsor with [DevToken](https://stakes.social/0x014f98F05c0BeD44B4Cf0532a93312a2135afaB8)\n- Tip us with BAT from brave awards or download [brave](https://brave.com/ngs747)\n\n## Contribution\n\nWant to file a bug, contribute some code, or improve documentation? Read up on our [Contributing Guide](CONTRIBUTING.md) before making a pull request.\n\n## LICENSE\n\n- [MIT](http://opensource.org/licenses/MIT)\n- Feel free to use and contribute to the development.\n\n## Contributors\n\nThanks goes to these wonderful \u003ca href=\"https://github.com/sq-ui/ng-sq-ui/graphs/contributors\"\u003epeople\u003c/a\u003e!\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/ardentia\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/41083417?v=4?s=50\" width=\"50px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003ePlamena Radneva\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/SQ-UI/ng-sq-ui/commits?author=ardentia\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/SQ-UI/ng-sq-ui/commits?author=ardentia\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/SQ-UI/ng-sq-ui/commits?author=ardentia\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"#tutorial-ardentia\" title=\"Tutorials\"\u003e✅\u003c/a\u003e \u003ca href=\"#blog-ardentia\" title=\"Blogposts\"\u003e📝\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/samuil4\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/797921?v=4?s=50\" width=\"50px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSamuil Gospodinov\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/SQ-UI/ng-sq-ui/commits?author=samuil4\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/SQ-UI/ng-sq-ui/commits?author=samuil4\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/SQ-UI/ng-sq-ui/commits?author=samuil4\" title=\"Tests\"\u003e⚠️\u003c/a\u003e \u003ca href=\"#talk-samuil4\" title=\"Talks\"\u003e📢\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSQ-UI%2Fng-sq-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSQ-UI%2Fng-sq-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSQ-UI%2Fng-sq-ui/lists"}