Native Angular directives for Bootstrap
TypeScript HTML CSS JavaScript

README.md

ng2-bootstrap npm version npm downloadsslack

Native Angular2 directives for Bootstrap, works with Bootstrap 3 and 4-alfa

Angular 2 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

ng2-bootstrap contains all core (and not only) Bootstrap components powered by Angular 2. 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 ng2-bootstrap from npm

npm install ng2-bootstrap --save

You will need bootstrap styles

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

How to use it with:

Usage & Demo

Main source of API documentation and usage scenarious available here: http://valor-software.github.io/ng2-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 ng2 modules readme for details, plans and approach

Credits

Crossbrowser testing sponsored by Browser Stack Browser Stack