valor-software/ngx-bootstrap


Fast and reliable Bootstrap widgets in Angular (supports Ivy engine)

https://valor-software.com/ngx-bootstrap

License: MIT

Language: TypeScript

Keywords: angular, bootstrap, carousel, components, datepicker, daterangepicker, modals, popover, select, sortable, typeahead, widgets


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. Supporting
  3. Installation instructions
  4. Usage & Demo
  5. API
  6. Troubleshooting
  7. 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.

Supporting NGX-Bootstrap

ngx-bootstrap is an Open Source (MIT Licensed) project, it's an independent project with ongoing development made possible thanks to the support of our awesome backers. If you also would like to show support or simply give back to Open Source community, please consider becoming a backer sponsor of ngx-bootstrap on OpenCollective

All donated funds are managed transparently on OpenCollective and will be used solely for compensating work and expenses for contributors. Valor Software employees and contractors are not eligible to use these funds.

What's there for you? Proper recognition and exposure of your name/logo/website on our page. Our main sponsors will be presented under this section! Be the first!

Installation instructions

Method 1

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">
Method 2

Use the Angular CLI ng add command for updating your Angular project

ng add ngx-bootstrap

OR use ng add to add needed component (for example tooltip)

ng add ngx-bootstrap --component tooltip

Add component to your page:

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

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@latest and angular@next

Server side rendered version of this documentation available here served with Anguar universal and nest.js

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 build

To update your fork and prepare it for local usage:

  • git pull upstream development
  • rm -rf node_modules
  • npm install
  • npm run build

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 Saucelabs Saucelabs

End-to-end testing sponsored by Cypress Cypress

License

MIT

Project Statistics

Sourcerank 19
Repository Size 16.5 MB
Stars 4,930
Forks 1,596
Watchers 239
Open issues 408
Dependencies 1,478
Contributors 239
Tags 123
Created
Last updated
Last pushed

Top Contributors See all

Dmitriy Shekhovtsov Ilya Surmay Greenkeeper Ludmila Nesvitiy Domainv svetoldo4444ka YevheniiaMazur Oleksandr Telnov tarusin Oleksii Aleksandrov Art Olshansky Irina Ershova Yuriy Musienko Marçal Juan Llaó Natali Soloviova Nikita Adrian Fâciu Oleg Rybnikov Edin Fazlic Leo

Packages Referencing this Repo

ngx-bootstrap-ga
Native Angular Bootstrap Components
Latest release 2.0.9 - Updated - 4.93K stars
ngx-bootstrap-ci
Native Angular Bootstrap Components
Latest release 5.3.2-dev.20191213125816 - Updated - 4.93K stars
ngx-bootstrap-travis-ci
Native Angular Bootstrap Components
Latest release 3.3.0 - Published - 4.93K stars
ngx-bs-travis
Native Angular Bootstrap Components
Latest release 3.3.0 - Published - 4.93K stars
@nk-dev/ngx-bootstrap
Native Angular Bootstrap Components
Latest release 3.1.1-rc.25 - Updated - 4.93K stars
@kwall2004/ngx-bootstrap
Native Angular Bootstrap Components
Latest release 3.1.1 - Updated - 4.93K stars
lux-ngx-bootstrap
Native Angular Bootstrap Components
Latest release 3.1.1-rc.72 - Updated - 4.93K stars
nk-ngx-bootstrap
Native Angular Bootstrap Components
Latest release 3.1.1-rc.21 - Updated - 4.93K stars
@zari/ngx-bootstrap-deprecate2
Native Angular Bootstrap Components
Latest release 2.0.2 - Published - 4.93K stars
ngx-bootstrap-custome
Native Angular Bootstrap Components
Latest release 1.0.0 - Published - 4.93K stars
xello-ngx-bootstrap
Native Angular Bootstrap Components
Latest release 2.0.301 - Published - 4.93K stars
@perfectlynormal/ngx-bootstrap
Native Angular Bootstrap Components
Latest release 2.0.0-beta.7 - Published - 4.93K stars
rc-ngx-bootstrap
Native Angular directives for Bootstrap 3 and Bootstrap 4
Latest release 2.0.4 - Updated - 4.93K stars
zoomsphere.ngx-bootstrap
Native Angular Bootstrap Components
Latest release 1.8.0 - Updated - 4.93K stars
ng2-bootstrap-typeahead-mod
Native Angular Bootstrap Components
Latest release 1.1.6 - Updated - 4.93K stars
ng2-bootstrap-base-modified
Native Angular Bootstrap Components Typeahead modified
Latest release 1.4.2 - Updated - 4.93K stars
ng2-bootstrap_runwzj_test
Native Angular Bootstrap Components
Latest release 1.3.3 - Published - 4.93K stars
@danielkucal/ng2-bootstrap
Native Angular Bootstrap Components
Latest release 1.2.6 - Published - 4.93K stars
zoomsphere.ng2-bootstrap
Native Angular Bootstrap Components
Latest release 1.2.6 - Published - 4.93K stars
sallar-ng2-bootstrap
angular2 bootstrap components
Latest release 1.1.16-10 - Published - 4.93K stars

Recent Tags See all

v5.3.2 October 28, 2019
v5.3.1 October 25, 2019
v5.3.0 October 11, 2019
v5.2.0 September 13, 2019
v5.1.2 August 07, 2019
v5.1.1 July 10, 2019
v5.1.0 June 24, 2019
v5.0.0 June 10, 2019
v4.3.0 May 21, 2019
v4.2.0 April 26, 2019
v4.1.1 April 10, 2019
v4.0.1 March 29, 2019
v4.0.0 March 22, 2019
v3.3.0 February 12, 2019
v3.2.0 January 21, 2019

Interesting Forks See all

dart-league/ng2_strap
Native Angular2 directives for Bootstrap
Dart - MIT - Last pushed - 17 stars - 7 forks
DanielKucal/ngx-bootstrap
Native Angular2 directives for Bootstrap
TypeScript - MIT - Last pushed - 2 stars
Karthikeyan1993/ngx-bootstrap
Fast and reliable Bootstrap widgets in Angular
TypeScript - MIT - Updated - 1 stars
ningkexin/ngx-bootstrap
Fock Fast and reliable Bootstrap widgets in Angular,Maintaining 1.9.3
TypeScript - MIT - Last pushed - 1 stars
assmass/ngx-bootstrap
Native Angular directives for Bootstrap
TypeScript - Updated - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-05-16 15:45:15 UTC

Login to resync this repository