Fast and reliable Bootstrap widgets in Angular
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github fix(docs): fix stackblitz link (#2980) Nov 6, 2017
cypress chore(package): removed dependecies on ts and rxjs (#4113) May 2, 2018
demo fix(Demo): typeahead, wrong filtering (#4559) Aug 21, 2018
docs/getting-started chore(docs): updated instructions for angular-seed (#4252) Apr 24, 2018
scripts feat(angular): upgraded angular and rxjs to v6 May 11, 2018
src fix(tooltip): fix containerClass when isOpen is true (#4579) Sep 3, 2018
.angular-cli.json.bak feat(angular): upgraded angular and rxjs to v6 May 11, 2018
.editorconfig Webpack build working Aug 10, 2015
.gitignore feat(build): use npm ci, it's faster then yarn (#4059) Mar 23, 2018
.npmrc feat(build): use npm ci, it's faster then yarn (#4059) Mar 23, 2018
.prettierrc feat(package): drop support of ng v2 and add support of ng v4 and v5 (#… Sep 14, 2017
.travis.yml chore(ci): deploy vd+ commits May 31, 2018
CHANGELOG.md chore(changelog): update [skip ci] Jun 19, 2018
CODE_OF_CONDUCT.md chore(docs): added code of conduct May 26, 2017
CONTRIBUTING.md chore(contributing): add anchor links (#2786) Oct 4, 2017
Dockerfile feat(demo): add universal support, add dockerfile (#2925) Nov 2, 2017
LICENSE chore(lint): fixed linting issues Dec 12, 2016
README.md chore(docs): Update set bootstrap version guide and docs (#4187) Apr 24, 2018
angular.json feat(angular): upgraded angular and rxjs to v6 May 11, 2018
cypress.json fix(tests): change run cypress tests for faster local run. Refactor t… Mar 29, 2018
karma-demo.conf.js chore(tests): xited empty expectations May 15, 2018
karma.conf.js feat(chronos): bs-moment renamed to chronos and all locales was suffi… Jan 15, 2018
mocha.opts feat(chronos): bs-moment renamed to chronos and all locales was suffi… Jan 15, 2018
package-lock.json 3.0.1 Jun 19, 2018
package.json 3.0.1 Jun 19, 2018
tsconfig.json feat(angular): upgraded angular and rxjs to v6 May 11, 2018
tslint.json feat(angular): upgraded angular and rxjs to v6 May 11, 2018
typedoc.js feat(demo): new build process with ng2-webpack-config Jun 24, 2016
wallaby.js feat(build): added config file for wallabyjs Oct 4, 2016

README.md

ngx-bootstrap

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

npm version npm downloads
slack

Links

Table of contents

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

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

Add needed package to NgModule imports:

import { TooltipModule } from 'ngx-bootstrap/tooltip';

@NgModule({
  ...
  imports: [TooltipModule.forRoot(),...]
  ...
})

Add component to your page:

<button type="button" class="btn btn-primary"
        tooltip="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Simple demo
</button>

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">
  • Bootstrap 4
<!--- index.html -->
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" rel="stylesheet">

Setting up the bootstrap version manually

Sometimes, 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):

import { setTheme } from 'ngx-bootstrap/utils';

@Component({...})
export class AppComponent {
  constructor() {
    setTheme('bs3'); // or 'bs4'
    ...
  }
}

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 angular v5

Server side rendered version of this documentation available here

API

Check demo page for API reference

How to use it with:

How to build lib for development

First time:

  • clone repository
  • npm install
  • npm run test

To update your fork and prepare it for local usage:

  • git pull upstream development
  • rm -rf node_modules
  • npm install
  • npm run test // it will build the lib, create a link in node_modules and run package's "test" script

To run the 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 if you are in trouble, here's where you can look for help.

The best place to ask questions is on StackOverflow (under the ngx-bootstrap tag) You can also join our Slack channel 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.

If, and only if, none of the above helped, please open a 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!

Please read our contribution guidelines.

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

License

MIT