theme-query

Theme Query

Utility function to query Styled System / Theme UI themes.

Motivation

The System UI specification allows us to write coherent and consistent UIs. It's a solid approach for providing branding compliance across web applications. On the other hand, Styled System offers an ergonomic approach for styling React components using constraint-based style props. Styled Factory offers an alternative to querying design tokens defined in the themes object without the need to depend on a theme provider.

We develop UI components in a dedicated component library as part of an overall design system. These libraries are stateless components with the responsibility to provide corporate identity consistency and maximum reusability. At the same time, support developers create UIs in no time. At this first level of UI development, it would be nice to have to access theme tokens without depending on the theme provider.

Benefits

• Portable and dependency-free styling for components.
• Library agnostic styling. Although I would always pick Emotion 👩‍🎤⚡️.
• Access design tokens without using a <ThemeProvider theme={theme} /> .
• Complete freedom to unit test components without unnecessary component dependency.

Requirements

🚀 Node.js >= 10 🌲 Git 🐈 yarn >= 1.12

Getting started

  yarn install styled-factory
  yarn install theme-UI
  yarn install @emotion-core

Example

Create your theme

It follows the (System UI Theme Specification)[https://system-ui.com/theme/].

export default {
  colors: {
    corals: ['rgb(255, 113, 99)', 'rgb(229, 85, 78)'],
    sand: 'rgb(204, 153, 102)',
  },
  fonts: {
    body: 'system-ui, sans-serif',
    heading: { display: '"museo300", serif', secondary: '"museo500", serif' },
  },
  fontSizes: [12, 14, 16, 18, 20, 24, 32, 44],
};

Style your components

/** @jsx jsx */
import * as ThemeQuery from 'theme-query';
import { jsx } from 'theme-ui';

const qt = ThemeQuery.create({ theme, styles: 'object' });

export default props => (
  <h1
    sx={{
      fontSize: qt('fontSizes')(4),
      fontFamily: qt('heading.secondary'),
      color: qt('sand'),
      bg: qt('corals')(0),
    }}>
    Themed Component
  </h1>
);

Development

git clone [e-mail]:woodlike/wdlk.git
cd component-library
# Install packages
yarn
# Start development mode
yarn dev
# Run and watch Jest unit tests
yarn test --watch