TypeScript JavaScript Other
Permalink
Failed to load latest commit information.
.github docs(ISSUE_TEMPLATE): add pointers to plunkers Oct 27, 2016
demo Revert "docs(datepicker): update overview with model type <D>" Jul 20, 2018
misc chore: fix umd bundle name for plunker (#2506) Jul 9, 2018
scripts chore: bump saucelabs versions and timeouts Apr 27, 2018
src refactor(carousel): re-implement with observables and clean up API Jul 20, 2018
.clang-format chore: format files with clang Sep 29, 2015
.editorconfig chore: remove end_of_line at editorconfig Nov 4, 2016
.gitattributes chore: normalize line endings Mar 31, 2016
.gitignore chore: use @angular/cli for build, tests and demo Jul 3, 2018
.travis.yml chore: use headless chrome for CI Jul 17, 2018
CHANGELOG.md chore: release 3.0.0-beta.1 Jul 6, 2018
CODE_OF_CONDUCT.md chore(coc): add Code of Conduct Sep 30, 2015
CONTRIBUTING.md docs: angular 2 -> angular branding change Feb 2, 2017
DEVELOPER.md chore: use @angular/cli for build, tests and demo Jul 3, 2018
LICENSE docs(LICENSE): update copyright year to 2018 Jan 24, 2018
README.md docs: update minimal required Angular version Jun 14, 2018
angular.json chore: use @angular/cli for build, tests and demo Jul 3, 2018
gulpfile.js chore: use @angular/cli for build, tests and demo Jul 3, 2018
package.json chore: release 3.0.0-beta.1 Jul 6, 2018
tsconfig.json chore: use @angular/cli for build, tests and demo Jul 3, 2018
tslint.json chore: use @angular/cli for build, tests and demo Jul 3, 2018
yarn.lock chore: use @angular/cli for build, tests and demo Jul 3, 2018

README.md

NG Bootstrap - Angular directives specific to Bootstrap 4

npm version Build Status devDependency Status Sauce Test Status

Welcome to the Angular version of the Angular UI Bootstrap library. This library is being built from scratch by the ui-bootstrap team. We are using TypeScript and targeting the Bootstrap 4 CSS framework.

As with Bootstrap 4, this library is a work in progress. Please check out our list of issues to see all the things we are implementing. Feel free to make comments there.

Table of Contents

Demo

View all the directives in action at https://ng-bootstrap.github.io

Dependencies

Installation

After installing the above dependencies, install ng-bootstrap via:

npm install --save @ng-bootstrap/ng-bootstrap

Once installed you need to import our main module:

import {NgbModule} from '@ng-bootstrap/ng-bootstrap';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice NgbModule.forRoot()):

import {NgbModule} from '@ng-bootstrap/ng-bootstrap';

@NgModule({
  declarations: [AppComponent, ...],
  imports: [NgbModule.forRoot(), ...],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import NgbModule:

import {NgbModule} from '@ng-bootstrap/ng-bootstrap';

@NgModule({
  declarations: [OtherComponent, ...],
  imports: [NgbModule, ...], 
})
export class OtherModule {
}

SystemJS

If you are using SystemJS, you should also adjust your configuration to point to the UMD bundle.

In your systemjs config file, map needs to tell the System loader where to look for ng-bootstrap:

map: {
  '@ng-bootstrap/ng-bootstrap': 'node_modules/@ng-bootstrap/ng-bootstrap/bundles/ng-bootstrap.js',
}

Supported browsers

We support the same browsers and versions supported by both Bootstrap 4 and Angular, whichever is more restrictive. See this for up-to-date Angular browser support.

  • Chrome (45+)
  • Firefox (40+)
  • IE (10+)
  • Edge (20+)
  • Safari (7+)

Also check Bootstrap 4's notes on browsers support.

Contributing to the project

Please check the CONTRIBUTING.md doc for contribution guidelines.

Getting Help

Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on StackOverflow where maintainers are looking at questions tagged with ng-bootstrap.

StackOverflow is a much better place to ask questions since:

  • there are hundreds of people willing to help on StackOverflow
  • questions and answers stay available for public viewing so your question / answer might help someone else
  • SO voting system assures that the best answers are prominently visible.

To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.

You think you've found a bug?

Oh, we are ashamed and want to fix it ASAP! But before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using http://plnkr.co. Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:

  • version of Angular used
  • version of this library that you are using
  • 3rd-party libraries used, if any
  • and most importantly - a use-case that fails

A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. The best part is that you do not need to create plunks from scratch - you can fork one from our demo page.

We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.

Unfortunately we are not able to investigate / fix bugs without a minimal reproduce scenario using http://plnkr.co, so if we don't hear back from you we are going to close an issue that don't have enough info to be reproduced.

Code of Conduct

Please take a moment and read our Code of Conduct