fela-plugin-named-keys

fela-plugin-named-keys

Note: This plugin was named fela-plugin-named-media-query before. It was renamed to semantically also match @supports rules.

This plugin is basically a convenient plugin for more readable code and better maintenance.
It allows to define custom key names that are later replaced for valid keys.

Installation

yarn add fela-plugin-named-keys

You may alternatively use npm i --save fela-plugin-named-keys.

Usage

Make sure to read the documentation on how to use plugins.

import { createRenderer } from 'fela'
import namedKeys from 'fela-plugin-named-keys'

const renderer = createRenderer({
  plugins: [ namedKeys() ]
})

Configuration

Parameters

Parameter	Value	Default	Description
keyMap	(Object)	{}	An object with key-replacement pairs

Example

import { createRenderer } from 'fela'
import namedKeys from 'fela-plugin-named-keys'

const namedKeysPlugin = namedKeys({
  desktop: '@media (min-width: 1024px)',
  tablet: '@media (min-width: 768px)',
  supportsFlex: '@supports (display: flex)',
  supportsGrid: '@supports (display: grid)'
})

const renderer = createRenderer({
  plugins: [ namedKeysPlugin ]
})

Example

Using the above example code:

Input

{
  color: 'red',
  supportsGrid: {
    color: 'green'
  },
  desktop: {
    color: 'blue',
    supportsGrid: {
      color: 'yellow'
    }
  }
}

Output

{
  color: 'red',
  '@supports (display: grid)' : {
    color: 'green'
  },
  '@media (min-width: 1024px)': {
    color: 'blue',
    '@supports (display: grid)' : {
      color: 'yellow'
    },
  }
}

License

Fela is licensed under the MIT License.
Documentation is licensed under Creative Common License.
Created with ♥ by @rofrischmann and all the great contributors.

Changelog

10.2.0

| Package | Changes | | --- | --- | | fela | (#671) Updated Typings to use union types instead of enums. | | fela<br>fela-dom | (#667) Added the rendererId option to the renderer configuration which allows using multiple renderers with each maintaining their own set of style nodes. | | fela-plugin-rtl<br>fela-plugin-bidi | (#670) Added the ability to switch the transformation direction dynamically using a special theme property. | | react-fela | (#669) Now correctly pass the theme to useFela's props as well.<br>Now correctly pass key and ref to the FelaComponent directly instead of piping them to its rendered children. | | fela-plugin-named-keys | Added the ability to dynamically set named keys using the given props of each rule. |