ngx-plug-n-play

The ngx-plug-n-play library is an Angular library that contains services, components, directives, pipes, etc that are easily implemented into any project. The goal is to provide functionality while not defining any default styles. Directives don't provide a template, so those will inherently use the styles defined by the user. Components will use ng-template, ng-content, and other forms of transclusion so that the user can style components to match their application.

Demo Sites:

• ngx-plug-n-play.netlify.com
• Stackblitz Demo

In both of these example apps, we used Bootstrap to make it look nice. However, this library does not require the use of Bootstrap or any other UI framework or requirements. You can use your own styles on all the elements.

Installation

npm i ngx-plug-n-play

More Info

Each module is exported, so only what's needed in a given application will be imported.

The library contains the following modules:

• Typeahead Module
• Alert Toaster Module
• Dropdown Module
• Accordion Module

Developing Locally

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name --project=ngx-plug-n-play-lib to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run npm run build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build. Run npm run build:demo to build the demo project and npm run build:demo:prod to build the demo project for production. Run npm run build:lib to build the library project and npm run build:lib:prod to build the library for production.

Running unit tests

Run npm run test to execute the unit tests via Karma. Run npm run test:lib to execute the unit tests for the library via Karma.

Running end-to-end tests

Run npm run e2e to execute the end-to-end tests via Protractor.

Contributions

Please submit an issue for desired components or services or anything else to be added to the library or if any issues are found.

Thanks goes to these wonderful people (emoji key):

Preston Lamb ⚠️ 💻

Wes Grimes 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!