react-native-typed-css-transformer
v0.10.2
Published
CSS transformer with Typescript support for React Native
Downloads
45
Readme
react-native-typed-css-transformer
Load CSS files to react native style objects.
This transformer also generates .d.ts
Typescript typings for the CSS files. Notice that platform specific extensions are not supported in the Typescript typings.
This transformer can be used together with React Native CSS modules.
Usage
Step 1: Install
yarn add --dev react-native-typed-css-transformer
Step 2: Configure the react native packager
For React Native v0.57 or newer / Expo SDK v31.0.0 or newer
Add this to metro.config.js
in your project's root (create the file if it does not exist already):
const { getDefaultConfig } = require("metro-config");
module.exports = (async () => {
const {
resolver: { sourceExts }
} = await getDefaultConfig();
return {
transformer: {
babelTransformerPath: require.resolve(
"react-native-typed-css-transformer"
)
},
resolver: {
sourceExts: [...sourceExts, "css"]
}
};
})();
If you are using Expo, you also need to add this to app.json
:
{
"expo": {
"packagerOpts": {
"config": "metro.config.js"
}
}
}
For React Native v0.56 or older
If you are using React Native without Expo, add this to rn-cli.config.js
in your project's root (create the file if you don't have one already):
module.exports = {
getTransformModulePath() {
return require.resolve("react-native-typed-css-transformer");
},
getSourceExts() {
return ["ts", "tsx", "css"];
}
};
For Expo SDK v30.0.0 or older
If you are using Expo, instead of adding the rn-cli.config.js
file, you need to add this to app.json
:
{
"expo": {
"packagerOpts": {
"sourceExts": ["ts", "tsx", "css"],
"transformer": "node_modules/react-native-typed-css-transformer/index.js"
}
}
}
How does it work?
Your App.css
file might look like this:
.myClass {
color: blue;
}
.myOtherClass {
color: red;
}
When you import your stylesheet:
import styles from "./App.css";
Your imported styles will look like this:
var styles = {
myClass: {
color: "blue"
},
myOtherClass: {
color: "red"
}
};
The generated App.css.d.ts
file looks like this:
export const myClass: string;
export const myOtherClass: string;
You can then use that style object with an element:
<MyElement style={styles.myClass} />