# @startupjs/babel-plugin-rn-stylename-to-style

> Dynamically resolve styleName in RN with support for multi-class selectors (for easier modifiers)

Latest version **0.55.8** (published 2023-12-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @startupjs/babel-plugin-rn-stylename-to-style
pnpm add @startupjs/babel-plugin-rn-stylename-to-style
yarn add @startupjs/babel-plugin-rn-stylename-to-style
bun add @startupjs/babel-plugin-rn-stylename-to-style
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.55.8 |
| Published | 2023-12-16 |
| First published | 2020-05-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 32.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 109 |
| Author | Pavel Zhukov |
| Maintainers | cray0000, yska, zag2art, fctsvirus, maestro.sc, byshock |
| Keywords | babel, babel-plugin, react-native, stylename, style |

## Links

- npm: https://www.npmjs.com/package/@startupjs/babel-plugin-rn-stylename-to-style
- Repository: https://github.com/startupjs/startupjs
- Homepage: https://github.com/startupjs/startupjs#readme
- Issues: https://github.com/startupjs/startupjs/issues
- npm.io page: https://npm.io/package/@startupjs/babel-plugin-rn-stylename-to-style

## Dependencies (5)

- [@babel/types](https://npm.io/package/@babel/types.md) ^7.0.0
- [@babel/template](https://npm.io/package/@babel/template.md) ^7.4.0
- [@startupjs/cache](https://npm.io/package/@startupjs/cache.md) ^0.55.8
- [@nx-js/observer-util](https://npm.io/package/@nx-js/observer-util.md) ^4.1.3
- [react-native-dynamic-style-processor](https://npm.io/package/react-native-dynamic-style-processor.md) ^0.21.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.55.8 (latest) — 2023-12-16
- 0.59.0-canary.0 (canary) — 2024-11-08
- 0.56.0-alpha.34 (next) — 2024-02-24
- 0.58.0-canary.0 — 2024-11-08
- 0.57.0-canary.75 — 2024-09-23
- 0.57.0-canary.0 — 2024-05-25
- 0.56.0-alpha.33 — 2024-02-23
- 0.56.0-alpha.32 — 2024-02-23
- 0.56.0-alpha.4 — 2024-02-01
- 0.56.0-alpha.0 — 2024-01-15
- 0.55.0 — 2023-11-29
- 0.55.0-alpha.12 — 2023-11-17
- 0.55.0-alpha.11 — 2023-11-15
- 0.55.0-alpha.1 — 2023-11-08
- 0.55.0-alpha.0 — 2023-11-07
- … 75 more at https://npm.io/package/@startupjs/babel-plugin-rn-stylename-to-style/versions

## README

# @startupjs/babel-plugin-rn-stylename-to-style

Transform JSX `styleName` property to `style` property in react-native. The `styleName` attribute and syntax are based on [babel-plugin-react-css-modules](https://github.com/gajus/babel-plugin-react-css-modules#conventions).

## Information

This is the fork of https://github.com/kristerkari/babel-plugin-react-native-stylename-to-style

The differences are:

1. Support resolving multi-class selectors in CSS:

```jsx
import classnames from 'classnames'

function Button ({
  variant,  // [string] 'primary' | 'secondary'
  dark,     // [bool]
  disabled  // [bool]
}) {
  return (
    <Text
      styleName={classnames('button', [variant, { dark, disabled }])}
    >CLICK ME</Text>
  )
}
```

```sass
.button
  background-color: blue
  &.primary
    color: #ff0000
    &.disabled
      color: rgba(#ff0000, 0.5)
  &.secondary
    color: #00ff00
    &.disabled
      color: rgba(#00ff00, 0.5)
  &.disabled
    color: #777

.dark
  &.button
    background-color: purple
    &.primary
      color: white
      &.disabled
        color: #ddd
  &.disabled
    color: #eee
```

And what's important is that selectors` specificity is properly emulated. For example:

Styles for `.button.primary.disabled` (specificity *30*) will override styles of `.button.disabled` (specificity *20*),
even though `.button.disabled` is written later in the CSS.

This simple change brings a lot more capabilities in theming your components for a dynamic look.

2. Convert any `*StyleName` attribute to the according `*Style` attribute. This is very useful for passing the sub-element styles (which are usually exposed by react-native libraries) directly from CSS.

3. If the `styleName` value is an object or an array, automatically pipe it through the `classnames`-like library.

4. Support for multiple named css file imports is removed

## Usage

**WARNING:** This plugin is already built in into the `babel-preset-startupjs` and is included into the default StartupJS project.

If you want to use this plugin separately from StartupJS:

### Step 1: Install

```sh
yarn add --dev @startupjs/babel-plugin-rn-stylename-to-style
```

or

```sh
npm install --save-dev @startupjs/babel-plugin-rn-stylename-to-style
```

### Step 2: Configure `.babelrc`

You must give one or more file extensions inside an array in the plugin options.

```
{
  "presets": [
    "react-native"
  ],
  "plugins": [
    ["react-native-dynamic-stylename-to-style", {
      "extensions": ["css"]
    }]
  ]
}
```

### Plugin Options

#### `extensions`

**Required**

List of css extensions to process (`css`, `styl`, `sass`, etc.)

#### `useImport`

**Default:** `false`

Whether to generate ESM `import` instead of CJS `require`.

#### `parseJson`

**Default:** `false`

Whether the imported css is expected to be a JSON string or an object.
If this flag is specified then JSON string is expected and it will do `JSON.parse` on it.

## Syntax

## Anonymous reference

Anonymous reference can be used when there is only one stylesheet import.

### Single class

```jsx
import "./Button.css";

<View styleName="wrapper">
  <Text>Foo</Text>
</View>;
```

↓ ↓ ↓ ↓ ↓ ↓

```jsx
import Button from "./Button.css";

<View style={Button.wrapper}>
  <Text>Foo</Text>
</View>;
```

### Multiple classes

```jsx
import "./Button.css";

<View styleName="wrapper red-background">
  <Text>Foo</Text>
</View>;
```

↓ ↓ ↓ ↓ ↓ ↓

```jsx
import Button from "./Button.css";

<View style={[Button.wrapper, Button["red-background"]]}>
  <Text>Foo</Text>
</View>;
```

### Expression

```jsx
import "./Button.css";
const name = "wrapper";

<View styleName={name}>
  <Text>Foo</Text>
</View>;
```

↓ ↓ ↓ ↓ ↓ ↓

```jsx
import Button from "./Button.css";
const name = "wrapper";

<View
  style={(name || "")
    .split(" ")
    .filter(Boolean)
    .map(function(name) {
      Button[name];
    })}
>
  <Text>Foo</Text>
</View>;
```

### Expression with ternary

```jsx
import "./Button.css";

const condition = true;
const name = "wrapper";

<View styleName={condition ? name : "bar"}>
  <Text>Foo</Text>
</View>;
```

↓ ↓ ↓ ↓ ↓ ↓

```jsx
import Button from "./Button.css";

const condition = true;
const name = "wrapper";

<View
  style={((condition ? name : "bar") || "")
    .split(" ")
    .filter(Boolean)
    .map(function(name) {
      Button[name];
    })}
>
  <Text>Foo</Text>
</View>;
```

### with `styleName` and `style`:

```jsx
import "./Button.css";

<View styleName="wrapper" style={{ height: 10 }}>
  <Text>Foo</Text>
</View>;
```

↓ ↓ ↓ ↓ ↓ ↓

```jsx
import Button from "./Button.css";

<View style={[Button.wrapper, { height: 10 }]}>
  <Text>Foo</Text>
</View>;
```

## ::part() selector

### Preprocess `part` attribute.

- Each `part` gets its styles from the `{part}Style` prop.
- `part='root'` is magic -- it's linked to the pure `style` prop.

Here is an example `<Card>` component which specifies its root container, title and footer as stylizable parts:

```jsx
// Card.js

function Card ({ title }) {
  return (
    <View part='root'>
      <Text part='header'>{title}</Text>
      <Text part='footer'>Copyright</Text>
    </View>
  )
}
```

**↓ ↓ ↓ ↓ ↓ ↓**

```jsx
function Card ({ title, style, headerStyle, footerStyle }) {
  return (
    <View style={style}>
      <Text style={headerStyle}>{title}</Text>
      <Text style={footerStyle}>Copyright</Text>
    </View>
  )
}
```

### Preprocess `::part()` selector from CSS file to style any component which uses `part` attributes.

Following an example `<Card>` component above, we can call `<Card>` from the `<App>` and customize its parts styles:

```jsx
// App.js

import Card from './Card'
import './index.styl'

function App ({ users }) {
  return users.map(user => (
    <Card styleName='user' title={user.name} />
  ))
}
```

```styl
// index.styl

.user
  margin-top 16px

  &:part(header)
    background-color black
    color white

  &:part(footer)
    font-weight bold
```

---
_Source: https://npm.io/package/@startupjs/babel-plugin-rn-stylename-to-style · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._