ngx-bootstrap

Best way to quickly integrate Bootstrap 3 or Bootstrap 4 Components with Angular

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
``bash
npm install ngx-bootstrap --save
`

You will need bootstrap styles (Bootstrap 3)

`


`

Or Bootstrap 4
`


`
To enable bootstrap 4 theme templates in ngx-bootstrap, please read
this .

Usage & Demo

Main source of API documentation and usage scenarios available here:
https://valor-software.com/ngx-bootstrap/

Additionally you can find demos and docs deployed from latest code with angular v4 and href="https://ngx-bootstrap-latest.surge.sh/">angular v5

Server side rendered version of this documentation available here

API

Check demo page for API reference

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

If you want to run the demo with Angular Universal:
- npm run demo.serve-universal

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