brandeur v2.0.2

Brandeur

Brandeur is a convenience layer and tool belt on top of css-hooks for React.

Benefits

• Similar API
• Theming
• RTL Conversion
• Vendor Prefixing
• Fallback Value Support
• Keyframes Support
• Extendable Plugin System
• Fela Plugin Compatibility
• TypeScript Support

Installation

# npm
npm i --save brandeur
# yarn
yarn add brandeur
# pnpm
pnpm add brandeur

The Gist

import { createHooks } from 'brandeur'
import prefixer, { fallbacks } from 'brandeur-plugin-prefixer'

const theme = {
  colors: { primary: 'red' },
}

const [staticCSS, css] = createHooks({
  hooks: {
    // either custom hooks or @css-hooks/recommended
  },
  plugins: [prefixer()] as const,
  fallbacks: [
    ...fallbacks,
    { property: 'position', values: ['-webkit-sticky', 'sticky'] },
  ],
  keyframes: {
    fadeIn: {
      from: { opacity: 0 },
      to: { opacity: 1 },
    },
  },
  theme,
})

// fades in, red color, vendor prefixed and browser-compatible position: sticky
const style = css(({ theme, keyframes }) => ({
  animationName: keyframes.fadeIn,
  color: theme.colors.primary,
  position: 'sticky',
  appearance: 'none',
}))

Why

tbd.

API

Currently Brandeur only exposes two functions:

• createHooks
• fallbackValue

createHooks

The main API that wraps createHooks from css-hooks. It returns the same structural array including both the static CSS and the css function. The difference is that the static CSS includes more than just the hooks and the css function also accepts functions.

Arguments

It accepts the following arguments as an object.

Plugin

type Plugin = style => style

Plugins are simple functions that take a style object and return a new one, similar to Fela plugins.

Note: See Plugins for a list of all available plugins.

Fallback

type Fallback = {
  property: string | Array<string>
  values: Array<string>
  match?: string
}

Tip: The fallbackValue API provides a convenient way to create those fallback objects.

Returns

It returns an array where the first item is a static CSS string and the second item is the css function to create styles. The css function accepts both style object as well as functions where the first argument is an object that only has a theme property.

Example

See The Gist.

fallbackValue

A tiny helper function to create fallbacks in a more convenient way.

Arguments

It accepts the following arguments as an object.

Returns

(Fallback) An object with respective fallback properties.

Example

import { fallbackValue } from 'brandeur'

const positionSticky = fallbackValue('position', ['-webkit-sticky', 'sticky'])

Plugins

Brandeur becomes really powerful when utilising the rich plugin echosystem. That way, we can extend the styling engine to support our personal needs.

Brandeur Plugins

Fela Plugins

Thanks to similar architecture and API design, brandeur supports almost all Fela plugins out of the box.

Tip: In order to get proper types, make sure that you import brandeur in the same file where Fela plugins are imported as types for all Fela plugins are shipped with the core package.

Incompatible Plugins

TypeScript

Brandeur comes with native TypeScript support, but requires some manual setup to get the correct types for all plugins.

Style Object

By default, Brandeur automatically infers the type just like css-hooks does. It supports all React.CSSProperties. For convenience, we also export a Style type from brandeur.

In order to extend the type with plugins, we need to set them up correctly.

import { createHooks } from 'brandeur'

import extend from 'fela-plugin-extend'
import responsiveValue, {
  ResponsiveStyle,
} from 'brandeur-plugin-responsive-value'

const [staticCSS, css] = createHooks({
  // ... config
  plugins: [
    // allow responsvie array values in extended styles
    extend<ResponsiveStyle>(),
    responsiveValue([
      '@media (min-width: 480px)',
      '@media (min-width: 1024px)',
    ]),
    prefixer(),
    // use "as const" to get fixed types
  ] as const,
})

Fela Plugins

Make sure to import brandeur in your configuration file to load all the plugin types for Fela plugins. Otherwise you'll get the native ones from Fela which have conflicting types.

// load types
import 'brandeur'

import extend from 'fela-plugin-extend'
import hoverMedia from 'fela-plugin-hover-media'

Keyframes

Brandeur provides a simple way to create and consume global keyframes. Check the gist for an example.

Sometimes however we want to have dynamic keyframes and/or not render all keyframes upfront. In such cases, we recommend using a separate package to deal with that. I created react-create-keyframe for exactly those use cases. Feel free to check it out!

Roadmap

• Theming Primitives
• Framework-Agnostic API

License

Brandeur is licensed under the MIT License. Documentation is licensed under Creative Commons License. Created with ♥ by @robinweser.