@zendeskgarden/react-theming

@zendeskgarden/react-theming

The Theming package includes several utility components relating to theming and RTL capabilities in the Garden Design System.

Installation

npm install @zendeskgarden/react-theming

# Peer Dependencies - Also Required
npm install react react-dom prop-types styled-components @zendeskgarden/react-theming

Usage

The ThemeProvider component can be used to apply granular theming to Garden (and custom) components as well as providing a RTL context.

It is intended to be used at the root of an application to provide a global context for RTL.

ThemeProvider components can be nested within each other for areas that require additional, custom theming.

Theming

All themes are auto-prefixed and has access to the props provided to the component.

import { ThemeProvider } from '@zendeskgarden/react-theming';
import { Notification } from '@zendeskgarden/react-notifications';

const theme = {
  'notification': `
    color: red;

    :hover {
      color: blue;
    }
  `
}

<ThemeProvider theme={theme}>
  <Notification>
    This notification content will have custom styling.
  </Notification>
</ThemeProvider>

RTL

import { ThemeProvider } from '@zendeskgarden/react-theming';
import { Notification } from '@zendeskgarden/react-notifications';

<ThemeProvider rtl>
  <Notification>This notification content will have custom styling.</Notification>
</ThemeProvider>;

The withTheme HOC utility allows any component to interact with its ThemeProvider.

import { withTheme } from '@zendeskgarden/react-theming';

const StyledDiv = ({ theme, children }) => (
  <div style={{ direction: theme.rtl ? 'rtl' : 'ltr' }}>{children}</div>
);

const LocalizedComponent = withTheme(StyledDiv);

<ThemeProvider rtl>
  <LocalizedComponent>RTL localizable</LocalizedComponent>
</ThemeProvider>;

Target

You can change the target location that style-components injects its CSS into e.g. if you're using an iframe or shadow DOM.

import { ThemeProvider } from '@zendeskgarden/react-theming';
import { Notification } from '@zendeskgarden/react-notifications';

<ThemeProvider target={document.querySelector('.some-element')}>
  <Notification>This notification content will have custom styling.</Notification>
</ThemeProvider>;

WARNING

Theming is meant to be used for small, global changes to a component (i.e accent color, padding changes, etc.)

If you find yourself "skinning" a component, it may be much easier (and maintainable) if you were to create these presentation assets as standalone components and use them with our advanced Container abstractions.