###Warning - this is still a WIP
###ember-cli-bootstrap requires ember-cli version '0.0.41' or later
###You will need to have bower installed globablly to use this addon.
If you don't have bower installed, install it with:
npm install -g bower
This is an ember-cli addon that includes styles from Twitter Bootstrap into your ember-cli project.
This addon utilizes the bootstrap_for_ember library, which provides a collection of Ember components based on Twitter Bootstrap V3. You can find documentation for usage here.
#Usage
In the root of your ember-cli project directory, run:
npm install --save-dev ember-cli-bootstrap
You should now have access to bootstrap styles and the components provided by bootstrap_for_ember. Enjoy!
##Importing specific bootstrap_for_ember components
By default, all of the bootstrap_for_ember components will be imported
into the project. You can optionally specify exactly which components
should be imported into the project via the component
option, which
accepts an array of component names:
//your-bootstrap-app/Brocfile.js
/* global require, module */
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var app = new EmberApp({
'ember-cli-bootstrap': {
'components': ['bs-alert', 'bs-notifications', 'bs-nav']
}
});
module.exports = app.toTree();
The goal of this addon is to utilize the bootstrap_for_ember library to be able to implement Twitter Bootstrap's styles and components in a more 'Embery' way. As such, the addon does not include the javascript from Twitter Bootstrap by default.
In situations where you need functionality that is not provided by
bootstrap_for_ember, you can optionally import the Twitter Bootstrap
javascript into your ember-cli project by setting the
importBootstrapJS
option to true in your Brocfile.js
:
//your-bootstrap-app/Brocfile.js
/* global require, module */
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var app = new EmberApp({
'ember-cli-bootstrap': {
'importBootstrapJS': true
}
});
module.exports = app.toTree();
Bootstrap comes with an optional theme CSS with various visual enhancements. To include this file you can import it by setting importBootstrapTheme
to true in your Brocfile.js
:
//your-bootstrap-app/Brocfile.js
/* global require, module */
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var app = new EmberApp({
'ember-cli-bootstrap': {
'importBootstrapTheme': true
}
});
module.exports = app.toTree();
In situations where you prefer to use another strategy for importing Bootstrap CSS,
you can opt out of CSS import by setting the importBootstrapCSS
option to false in your Brocfile.js
:
//your-bootstrap-app/Brocfile.js
/* global require, module */
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var app = new EmberApp({
'ember-cli-bootstrap': {
'importBootstrapCSS': false
}
});
module.exports = app.toTree();
In situations where you prefer to use another strategy for importing the Bootstrap font,
you can opt out of the font import by setting the importBootstrapFont
option to false in your Brocfile.js
:
//your-bootstrap-app/Brocfile.js
/* global require, module */
var EmberApp = require('ember-cli/lib/broccoli/ember-app');
var app = new EmberApp({
'ember-cli-bootstrap': {
'importBootstrapFont': false
}
});
module.exports = app.toTree();