ng2-bootstrap

Native Angular Bootstrap Components

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
ng2-bootstrap
1.6.35 years ago7 years agoMinified + gzip package size for ng2-bootstrap in KB

Readme

this package was renamed to ngx-bootstrap
ngx-bootstrap npm version npm downloadsslack
Native Angular directives for Bootstrap 3 and Bootstrap 4
Angular Style Guide Build Status codecov Dependency Status
NPM NPM Sauce Test Status

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.
Additionally to allow reach experience while working with Dates we are using moment.js, de facto base date manipulation library at the moment.
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-alpha.6/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
Usage & Demo
Main source of API documentation and usage scenarious 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 gitter or slack and ask a question ( response in slack will be faster )
  • 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 Browser Stack