ember-cli-less
v3.0.2
Published
Use less to preprocess your ember-cli app css
Downloads
22,399
Readme
ember-cli-less
Use Less to preprocess your ember-cli app's css.
Compatibility
- Ember.js v3.12 or above
- Ember CLI v2.13 or above
- Node.js v10 or above
Installation
npm install --save-dev ember-cli-less
Usage
By default, this addon will compile app/styles/app.less
into dist/assets/app.css
.
Additional options can be specified using the lessOptions
config property in ember-cli-build.js
:
let app = new EmberApp({
lessOptions: {...}
});
Available Options:
paths
: An array of include pathssourceMap
: Whether to generate source maps. Defaults totrue
in development and can also take an object of sub options: http://lesscss.org/usage/#programmatic-usagemergeTrees
: An object of the available options to pass to the internal merge trees plugin
Configuring Input/Output Paths
You can configure the input and output files using ember-cli's outputPaths
option in ember-cli-build.js
:
let app = new EmberApp({
outputPaths: {
app: {
css: {
app: '/assets/my-project.css',
},
},
},
});
You can also configure multiple input/output paths to generate multiple css files:
let app = new EmberApp({
outputPaths: {
app: {
css: {
'theme-orange': '/assets/theme-orange.css',
'theme-purple': '/assets/theme-purple.css',
},
},
},
});
Notice that you cannot specify the name of the Source Map if multiple input/output paths are used.
The name gets generated from the output path (/assets/theme-orange.css
-> /assets/theme-orange.css.map
).
Usage in Addons
You can also use this to precompile less files in an addon. By default, this
will compile addon/styles/addon.less
into css that will be merged into the
host app's css:
- Install
ember-cli-less
in your addon'spackage.json
underdependencies
- Create your addon less file at
addon/styles/addon.less
(or where you specify in your options) - To run the addon's dummy app, be sure to create
tests/dummy/app/styles/app.less
if it doesn't exist - To make less files available for applications that consume this addon, create
app/styles/app.less
in your addon and add@import 'addon/styles/addon';
to its content
To include custom css files, use @import
statment in addon/styles/addon.less
. For example:
// addon/styles/addon.less
@import 'node_modules/bootstrap-less/bootstrap/bootstrap'; // look for "node_modules/bootstrap-less/bootstrap/bootstrap.less"
Examples
Using Bootstrap Less source in your app:
Install Bootstrap source:
npm install --save-dev bootstrap-less
Specify the include paths in ember-cli-build.js
:
let app = new EmberApp({
lessOptions: {
paths: ['node_modules/bootstrap-less/bootstrap/'],
},
});
Import into app.less:
@import 'bootstrap';
Linking source maps
When sourcemaps are enabled, you'll see the correct references to the original less files and their corresponding line numbers in Dev Tools. If you would like to link the less source files directly, you have to link them to your local filesystem in Chrome:
- Open dev tools > Sources tab
- Expand the sources pane on the left if it's not open
- Right-click anywhere, Add folder to workspace, add your project's folder
- Locate any less source file in the tree, right-click, Map to Network Resource... to create the mapping
Contributing
See the Contributing guide for details.
References
- Code inspired by: ember-cli-sass. Credits to the author.
- broccoli-less-single
- less