This package is used to easily precompile Sass files within the Stencil components.
First, npm install within the project:
npm install @stencil/sass --save-dev
Next, within the project's stencil.config.js file, import the plugin and add it to the config's plugins config:
import { Config } from '@stencil/core';
import { sass } from '@stencil/sass';
export const config: Config = {
plugins: [
sass()
]
};During development, this plugin will kick-in for .scss or .sass style urls, and precompile them to CSS.
Sass options can be passed to the plugin within stencil.config.js, which are used directly by node-sass. Please reference node-sass documentation for all available options. Note that this plugin automatically adds the component's directory to the includePaths array.
The injectGlobalPaths config is an array of paths that automatically get added as @import declarations to all components. This can be useful to inject Sass variables, mixins and functions to override defaults of external collections. For example, apps can override default Sass variables of Ionic components. Relative paths within injectGlobalPaths should be relative to the stencil.config.js file.
exports.config = {
plugins: [
sass({
injectGlobalPaths: [
'src/globals/variables.scss',
'src/globals/mixins.scss'
]
})
]
};Note that each of these files are always added to each component, so in most cases they shouldn't contain CSS because it'll get duplicated in each component. Instead, injectGlobalPaths should only be used for Sass variables, mixins and functions, but not contain any CSS.
Please see our Contributor Code of Conduct for information on our rules of conduct.