Links

• Documentation
• Release Notes
• Slack Community

Table of contents

1. Getting Started
2. Installation instructions
3. Usage & Demo
4. API
5. Troubleshooting
6. Contributing
7. License

Getting Started

ngx-bootstrap contains all core (and not only) Bootstrap components powered by Angular. So you don't need to include original JS components, but we are using markup and css provided by Bootstrap.

Installation instructions

Install ngx-bootstrap from npm

npm install ngx-bootstrap --save

You will need bootstrap styles (Bootstrap 3)

<!-- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">

Or Bootstrap 4

<!--- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" rel="stylesheet">

To enable bootstrap 4 theme templates in ngx-bootstrap, please read here

<!-- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">

How to use it with:

• angular-cli please refer to getting-started-with-ng-cli
• angular-seed please refer to getting-started-with-angular-seed
• system.js (and angular2 quickstart) please checkout sample repository
• plnkr sample available here
• AoT using ngc and rollup please refer to ngx-bootstrap-with-aot
• Bootstrap 4 and angular-cli please refer to using-with-bootstrap-4-and-angular-cli

How to build lib for development

First time

• clone repository
• npm install
• npm run test it will build the lib and create a link in node_modules

To run bootstrap 3 and 4 demo:

• npm run demo.serve to serve local demo. This is for testing only, without watchers.

For local development run

• npm run build.watch in first terminal
• ng serve in second

Usage & Demo

Main source of API documentation and usage scenarios available here: http://valor-software.github.io/ngx-bootstrap/

API

Check demo page for API reference

Troubleshooting

So you are in trouble, where to get help:

• you can search and ask for help at StackOverflow
• you can join slack and ask a question
• if none of this helped please search and only then open new issue

Contribution

Are very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!

If you need more modules check here

Please read central ngx modules readme for details, plans and approach

Credits

Crossbrowser testing sponsored by Browser Stack