Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    ngx-bootstrappublic

    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

    install

    npm i ngx-bootstrap

    Downloadsweekly downloads

    49,041

    version

    3.0.0

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar