epic-inline

Concise way to write runtime inline CSS styles.

Usage

import { ei } from 'epic-inline'

export const Button = () => <button style={ei('flex center')}>Click me!</button>

Breakpoints

Breakpoints can be used to apply styles conditionally based on the current window width. By default they will match upwards, add -only to match only the specific breakpoint.

small:flex medium-only:grid large:block inline or shorter s:flex m-only:grid l:block inline.

Sizes

Sizes serve as readable values.

"width-small" => { width: 5 } // small medium large huge
"width-md" => { width: 10 }   // sm md lg hg
"width-l" => { width: 20 }    // s m l h
"width-huge" => { width: 40 }

Colors

Lots of named colors are available and can be combined with a tone between 50 and 900, where 400 matches the exact color.

"color-red-400" => { color: '#FF0000'}
"color-blue-200" => { color: '#3333FF'}
"background-lavenderblush-900" => { background: '#FF70A0'}

Shortcuts

Shortcuts generate several properties and are thought to encapsulate often used patterns.

"button" => { outline: 'none', border: 'none' }
"link" => { textDecoration: 'none' }

Complex Values

Using methods it's possible to create more complex styles. The methods can receive both a size and a color.

ei('shadow') => { boxShadow: '0 5px 5px 3px #000000AA' }
ei('boxShadow-large') => { boxShadow: '0 10px 10px 5px #000000AA' }
ei('textShadow') => { textShadow: '2px 2px 2px black' }
ei('textShadow-large-gray') => { textShadow: '4px 4px 4px gray' }

Configuration

Various behaviours and sizes can be configured.

import { configure, Type } from 'epic-inline'

configure({
  type: Type.css | Type.js | Type.native,
  size: (value) => `${value / 10}rem`,
  object: (value) => JSON.stringify(value),
  classPrefix: 'another-',
  shortcuts: { image: 'width-50 height-50' },
  sizes: { '4xl': 80 },
  breakpoints: { phone: 500, tablet: 800, desktop: 1200 },
  properties: {
    // Additional CSS property.
    borderStroke: ['border-stroke', 'solid'],
    // Shortcut to existing property with value
    outlineFlex: 'display-outline-flex',
  },
})

React `className` Polyfill

While generally considered criminal, for low-quality projects this plugin provides a JSX override that will automatically transform any className on a React component to matching inline styles.

import 'epic-inline/register-react'

export const Button = () => <button className="flex center">Click me!</button>

React Native

import { View, Text } from 'react-native'
import { ei, configure, Type } from 'epic-inline'

configure({ type: Type.native })

const MyView = (
  <View style={ei('pv-medium marginHorizontal-small center')}>
    <Text>Hello React Native</Text>
  </View>
)

Using the className polyfill with types declared below:

import { View, Text } from 'react-native'
import 'epic-inline/register-react'
import { configure, Type } from 'epic-inline'

configure({ type: Type.native })

const MyText = <Text className="color-red">Hello React Native</Text>

declare module 'react-native' {
  export interface TextProps {
    className?: string
  }
}

Vue, Svelte and SolidJS

Inline styles can be configured to work with various frameworks using Presets.

import { ei, configure, Preset } from 'epic-inline'

configure(Preset.vue)
const MyVue = <div :style="ei('paddingLeft-10')">content</div>
// <div :style="{ paddingLeft: '10px' }">content</div>

configure(Preset.svelte)
const MySvelete = <div style={ei('paddingLeft-10')}>content</div>
// <div style="padding-left: 10px;">content</div>

configure(Preset.solid)
const MySolid = <div style={ei('paddingLeft-10')}>content</div>
// <div style={{ 'padding-left': '10px' }}>content</div>

Credits

The approach to parse short form strings into complex CSS style sheets is inspired by Tailwind CSS which parses className during build time and outputs stylesheets containing only the necessary properties.

tobua/epic-inline