\r\n\r\n## Links\r\n\r\n- [Documentation](http://valor-software.com/ngx-bootstrap/)\r\n- [Release Notes](https://github.com/valor-software/ngx-bootstrap/blob/development/CHANGELOG.md)\r\n- [Slack Community](https://ngx-slack.herokuapp.com)\r\n\r\n\r\n\r\n\r\n\r\n## Table of contents\r\n1. [Getting Started](#getting-started)\r\n2. [Installation instructions](#installation-instructions)\r\n3. [Usage & Demo](#usage--demo)\r\n4. [API](#api)\r\n5. [Troubleshooting](#troubleshooting)\r\n6. [Contributing](#contribution)\r\n\r\n## Getting Started\r\n\r\nngx-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.\r\n\r\n## Installation instructions\r\n##### Method 1\r\nInstall `ngx-bootstrap` from `npm`:\r\n```bash\r\nnpm install ngx-bootstrap --save\r\n```\r\n\r\nAdd needed package to NgModule imports:\r\n```\r\nimport { TooltipModule } from 'ngx-bootstrap/tooltip';\r\n\r\n@NgModule({\r\n ...\r\n imports: [TooltipModule.forRoot(),...]\r\n ...\r\n})\r\n```\r\n\r\nAdd component to your page:\r\n```\r\n\r\n```\r\n\r\nYou will need bootstrap styles:\r\n- `Bootstrap 3`\r\n```\r\n\r\n\r\n```\r\n\r\n- `Bootstrap 4`\r\n```\r\n\r\n\r\n```\r\n##### Method 2\r\nUse the Angular CLI ng add command for updating your Angular project\r\n```bash\r\nng add ngx-bootstrap\r\n```\r\nOR use `ng add` to add needed component (for example tooltip)\r\n```bash\r\nng add ngx-bootstrap --component tooltip\r\n```\r\nAdd component to your page:\r\n```\r\n\r\n```\r\n### Setting up the bootstrap version manually\r\nSometimes, your project might contain some library that could interfear with the bootstrap framework, or you might have a customized version of bootstrap. The consequence is that the process of determining bootstrap version might be failed, which can break the UI. In that case, we can still set the bootstrap version manually in the boostraping component (i.e. `AppComonent`):\r\n```\r\nimport { setTheme } from 'ngx-bootstrap/utils';\r\n\r\n@Component({...})\r\nexport class AppComponent {\r\n constructor() {\r\n setTheme('bs3'); // or 'bs4'\r\n ...\r\n }\r\n}\r\n```\r\n\r\n## Usage & Demo\r\n\r\nMain source of API documentation and usage scenarios available here:\r\n[https://valor-software.com/ngx-bootstrap/](https://valor-software.com/ngx-bootstrap/)\r\n\r\nAdditionally you can find demos and docs deployed from latest code with angular v4 and angular v5\r\n\r\nServer side rendered version of this documentation available here\r\n\r\n## API\r\nCheck demo page for API [reference](https://valor-software.com/ngx-bootstrap/)\r\n\r\n### How to use it with:\r\n - `Bootstrap and angular-cli` please refer to [using-with-bootstrap-and-angular-cli](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/bootstrap.md)\r\n - `angular-seed` please refer to [getting-started-with-angular-seed](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/angular-seed.md)\r\n - `system.js` (and [angular2 quickstart](https://angular.io/docs/ts/latest/quickstart.html)) please checkout [sample repository](https://github.com/valor-software/angular2-quickstart)\r\n - `plnkr` sample available [here](https://plnkr.co/edit/0NipkZrnckZZROAcnjzB?p=preview)\r\n - `AoT using ngc and rollup` please refer to [ngx-bootstrap-with-aot](https://github.com/valor-software/ngx-bootstrap/tree/development/docs/getting-started/aot.md)\r\n - `ASP.NET Core 2.0` please refer to [using-with-asp.net-core-2](https://github.com/csegyud/ASPNETCore_ngx-bootstrap_Sample/blob/master/README.md)\r\n\r\n### How to build lib for development\r\n\r\nFirst time:\r\n - clone repository\r\n - `npm install`\r\n - `npm run build`\r\n\r\nTo update your fork and prepare it for local usage:\r\n - `git pull upstream development`\r\n - `rm -rf node_modules`\r\n - `npm install`\r\n - `npm run build`\r\n\r\nTo run the demo:\r\n - `npm run demo.serve` _*// to serve local demo. This is for testing only, without watchers.*_\r\n\r\nFor local development run:\r\n - `npm run build.watch` _*// in first terminal*_\r\n - `ng serve` _*// in second*_\r\n\r\nIf you want to run the demo with Angular Universal:\r\n - `npm run demo.serve-universal`\r\n\r\n## Troubleshooting\r\n\r\nSo if you are in trouble, here's where you can look for help.\r\n\r\nThe best place to ask questions is on [StackOverflow (under the `ngx-bootstrap` tag)](https://stackoverflow.com/questions/tagged/ngx-bootstrap)\r\nYou can also join [our Slack channel](https://ngx-slack.herokuapp.com/) and link your stackoverflow question there. But try to avoid asking generic help questions directly on Slack since they can easily get lost in the chat. You can also [search among the existing GitHub issues](https://github.com/valor-software/ngx-bootstrap/issues?utf8=%E2%9C%93&q=is%3Aissue).\r\n\r\nIf, **and only if**, none of the above helped, please open a [new issue](https://github.com/valor-software/ngx-bootstrap/issues/new).\r\n\r\n## Contribution\r\n\r\nAre 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!\r\n\r\nPlease read our [contribution guidelines](https://github.com/valor-software/ngx-bootstrap/blob/development/CONTRIBUTING.md).\r\n\r\n### If you need more modules check [here](https://github.com/valor-software/ng2-plans)\r\n\r\nPlease read central `ngx` modules [readme](https://github.com/valor-software/ng2-plans) for details, plans and approach\r\n\r\n### Credits\r\nCrossbrowser testing sponsored by [Browser Stack](https://www.browserstack.com)\r\n[](https://www.browserstack.com)\r\n\r\n### License\r\n\r\nMIT\r\n","readmeFilename":"README.md"}
![\"npm](\"https://badge.fury.io/js/ngx-bootstrap.svg\"){kind=icon}
\r\n![\"npm](\"https://img.shields.io/npm/dm/ngx-bootstrap.svg\")
\r\n![\"\"](\"https://travis-ci.org/valor-software/ngx-bootstrap.svg?branch=development\")
\r\n\r\n![\"slack\"](\"https://ngx-slack.herokuapp.com/badge.svg\"){kind=icon}
\r\n