Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@zendeskgarden/react-theming

Package Overview
Dependencies
Maintainers
1
Versions
215
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@zendeskgarden/react-theming

Theming utilities and components within the Garden Design System

  • 8.53.3
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

@zendeskgarden/react-theming npm version

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 styled-components

Usage

The ThemeProvider component can be used to apply granular theming to Garden (and custom) components. It is intended to be used at the root of an application to provide a global context for RTL. ThemeProvider components can be nested for areas that require additional, custom theming.

Theming

Garden provides several levels of customization, listed here from simple to complex, depending on your needs:

  • Via the theme prop passed to ThemeProvider. Garden gives you access to many of the font, pixel, and color values used to style individual components. By modifying the theme you have the ability to customize whole aspects of the design system with minimal effort. Example: use theme to customize component primary accents with your brand color.
  • Via the theme.components object within the theme prop. Using COMPONENT_ID keys, you can target precise CSS properties for customization. Example: use theme.components to override the 20px bottom margin of tabs.tablist.
  • Via Garden's react-containers (outside the scope of this component). At some point, the flexibility provided by theme and theme.components has diminishing returns. If you find yourself fully re-skinning a component, then you should check out Garden's container abstractions. Example: retain the accessible keyboard behavior and RTL layout of Garden's tabs component with an alternate visual design (i.e. closer to the look of browser tabs).

RTL

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

<ThemeProvider theme={{ ...DEFAULT_THEME, rtl: true }}>
  <Notification>This notification content will render with RTL layout.</Notification>
</ThemeProvider>;

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

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

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

const LocalizedComponent = withTheme(Div);

<ThemeProvider theme={{ ...DEFAULT_THEME, rtl: true }}>
  <LocalizedComponent>RTL localizable</LocalizedComponent>
</ThemeProvider>;

Keywords

FAQs

Package last updated on 14 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc