Use Stylus to style your React Native apps.
Behind the scenes the .styl files are transformed to react native style objects (look at the examples).
This transformer can be used together with React Native CSS modules.
Your App.styl file might look like this:
.myClass {
color: blue;
}
.myOtherClass {
color: red;
}
.my-dashed-class {
color: green;
}When you import your stylesheet:
import styles from "./App.styl";Your imported styles will look like this:
var styles = {
myClass: {
color: "blue"
},
myOtherClass: {
color: "red"
},
"my-dashed-class": {
color: "green"
}
};You can then use that style object with an element:
Plain React Native:
<MyElement style={styles.myClass} />
<MyElement style={styles["my-dashed-class"]} />React Native CSS modules using className property:
<MyElement className={styles.myClass} />
<MyElement className={styles["my-dashed-class"]} />React Native CSS modules using styleName property:
<MyElement styleName="myClass my-dashed-class" />npm install --save-dev react-native-stylus-transformer stylusor
yarn add --dev react-native-stylus-transformer stylusMerge the contents from your project's metro.config.js file with this config (create the file if it does not exist already).
metro.config.js:
const { getDefaultConfig } = require("expo/metro-config");
module.exports = (() => {
const config = getDefaultConfig(__dirname);
const { transformer, resolver } = config;
config.transformer = {
...transformer,
babelTransformerPath: require.resolve("react-native-stylus-transformer")
};
config.resolver = {
...resolver,
sourceExts: [...sourceExts, "styl"]
};
return config;
})();Merge the contents from your project's metro.config.js file with this config (create the file if it does not exist already).
metro.config.js:
const { getDefaultConfig, mergeConfig } = require("@react-native/metro-config");
const defaultConfig = getDefaultConfig(__dirname);
const { assetExts, sourceExts } = defaultConfig.resolver;
/**
* Metro configuration
* https://reactnative.dev/docs/metro
*
* @type {import('metro-config').MetroConfig}
*/
const config = {
transformer: {
babelTransformerPath: require.resolve("react-native-stylus-transformer")
},
resolver: {
sourceExts: [...sourceExts, "styl"]
}
};
module.exports = mergeConfig(defaultConfig, config);You need version 1.2.0 or newer
:root {
--text-color: blue;
}
.blue {
color: var(--text-color);
}CSS variables are not supported by default, but you can add support for them by using PostCSS and postcss-css-variables plugin.
Start by installing dependencies:
npm install postcss postcss-css-variables react-native-postcss-transformer --save-devor
yarn add postcss postcss-css-variables react-native-postcss-transformer --devAdd postcss-css-variables to your PostCSS configuration with one of the supported config formats, e.g. package.json, .postcssrc, postcss.config.js, etc.
After that create a transformer.js file and do the following:
const upstreamTransformer = require("@react-native/metro-babel-transformer");
const stylusTransformer = require("react-native-stylus-transformer");
const postCSSTransformer = require("react-native-postcss-transformer");
module.exports.transform = function({ src, filename, ...rest }) {
if (filename.endsWith(".styl")) {
return stylusTransformer
.renderToCSS({ src, filename, options })
.then(css =>
postCSSTransformer.transform({ src: css, filename, ...rest })
);
} else {
return upstreamTransformer.transform({ src, filename, ...rest });
}
};After that in metro.config.js point the babelTransformerPath to that file:
-require.resolve("react-native-stylus-transformer")
+require.resolve("./transformer.js")This library has the following Node.js modules as dependencies: