@atlaskit/tokens
Version:
Design tokens are the single source of truth to name and store design decisions.
27 lines (26 loc) • 1.75 kB
TypeScript
import { type UnbindFn } from 'bind-event-listener';
import { type ThemeIdsWithOverrides, type ThemeState } from './theme-config';
/**
* Synchronously sets the theme globally at runtime. Themes are not loaded;
* use `getThemeStyles` and other server-side utilities to generate and load them.
*
* @param {Object<string, string>} themeState The themes and color mode that should be applied.
* @param {string} themeState.colorMode Determines which color theme is applied. If set to `auto`, the theme applied will be determined by the OS setting.
* @param {string} themeState.dark The color theme to be applied when the color mode resolves to 'dark'.
* @param {string} themeState.light The color theme to be applied when the color mode resolves to 'light'.
* @param {string} themeState.motion The motion theme to be applied.
* @param {string} themeState.shape The shape theme to be applied.
* @param {string} themeState.spacing The spacing theme to be applied.
* @param {string} themeState.typography The typography theme to be applied.
* @param {Object} themeState.UNSAFE_themeOptions The custom branding options to be used for custom theme generation
* @param {function} themeLoader Callback function used to override the default theme loading functionality.
*
* @returns An unbind function, that can be used to stop listening for changes to system theme.
*
* @example
* ```
* enableGlobalTheme({colorMode: 'auto', light: 'light', dark: 'dark', spacing: 'spacing'});
* ```
*/
declare const enableGlobalTheme: ({ colorMode, contrastMode, dark, light, motion, shape, spacing, typography, UNSAFE_themeOptions, }?: Partial<ThemeState>, themeLoader?: (id: ThemeIdsWithOverrides) => void) => UnbindFn;
export default enableGlobalTheme;