https://github.com/swimlane/ngx-ui

🚀 Style and Component Library for Angular
https://github.com/swimlane/ngx-ui

angular component css dialog directive drawer hacktoberfest icons library select split styles tabs tree

Last synced: about 23 hours ago
JSON representation

🚀 Style and Component Library for Angular

• Host: GitHub
• URL: https://github.com/swimlane/ngx-ui
• Owner: swimlane
• License: mit
• Created: 2016-08-17T12:16:19.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T18:39:45.000Z (8 months ago)
• Last Synced: 2024-05-23T03:29:32.937Z (8 months ago)
• Topics: angular, component, css, dialog, directive, drawer, hacktoberfest, icons, library, select, split, styles, tabs, tree
• Language: TypeScript
• Homepage: https://swimlane.github.io/ngx-ui/
• Size: 265 MB
• Stars: 700
• Watchers: 47
• Forks: 113
• Open Issues: 62
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-angular-components - ngx-ui - Style and Component Library for Angular2 and beyond! (Uncategorized / Uncategorized)
• awesome-angular - ngx-ui - Style and Component Library for Angular2 and beyond! (Table of contents / Third Party Components)
• fucking-awesome-angular - ngx-ui - Style and Component Library for Angular2 and beyond! (Table of contents / Third Party Components)
• fucking-awesome-angular - ngx-ui - Style and Component Library for Angular2 and beyond! (Table of contents / Third Party Components)
• fucking-awesome-angular - ngx-ui - Style and Component Library for Angular2 and beyond! (Table of contents / Third Party Components)

README

        
# ngx-ui

Component & Style Library for Angular by Swimlane.

## Installing

- `npm i @swimlane/ngx-ui --S`

- Install the project's [peer dependencies](https://github.com/swimlane/ngx-ui/blob/master/projects/swimlane/ngx-ui/package.json#L27) (moment, moment-timezone, ngx-moment, ng-in-viewport, codemirror, angular/cdk, resize-observer-polyfill)

- Add `NgxUIModule` and `IconModule` to your application module

- Add the ngx-ui theme in the angular.json file (`node_modules/@swimlane/ngx-ui/index.css`)

## Building ngx-ui

Run `npm run build:lib` to build ngx-ui. This must be done prior to building the demo.

## Development server

Run `npm run start` to serve the demo at `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## Building

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running tests

- Run `npm run test` to execute unit tests

- Run `ng cypress` to execute the end-to-end tests via Cypress.

## Release

- Checkout master (`git checkout master`)

- Pull master (`git pull`)

- Refresh node modules (`npm ci`)

- Run tests (`npm test`)

- Examine log to determine next version (X.Y.Z)

- Run `git checkout -b release/X.Y.Z`

- Update version in `projects/swimlane/ngx-ui/package.json`.

- Update changelog in `projects/swimlane/ngx-ui/CHANGELOG.md`

- Run `git commit -am "(release): X.Y.Z"`

- Run `git tag X.Y.Z`

- Run `git push origin HEAD --tags`

- Run `npm run publish:lib`

- Submit PR