@microsoft/load-themed-styles

Functions

• clearStyles()
• configureLoadStyles()
• configureRunMode()
• detokenize()
• flush()
• loadStyles()
• loadTheme()
• splitStyles()

Interfaces

• ITheme
• IThemingInstruction

  • defaultValue
  • rawString
  • theme

Enums

• ClearStyleOptions

  • all
  • onlyNonThemable
  • onlyThemable
• Mode

  • async
  • sync

Type Aliases

• ThemableArray

function clearStyles

clearStyles: (option?: ClearStyleOptions) => void;

• Clear already registered style elements and style records in theme_State object

  Parameter option

  specify which group of registered styles should be cleared. Default to be both themable and non-themable styles will be cleared

function configureLoadStyles

configureLoadStyles: (
    loadStylesFn: (
        processedStyles: string,
        rawStyles?: string | ThemableArray
    ) => void
) => void;

• Allows for customizable loadStyles logic. e.g. for server side rendering application

  Parameter a

  loadStyles callback that gets called when styles are loaded or reloaded

function configureRunMode

configureRunMode: (mode: Mode) => void;

• Configure run mode of load-themable-styles

  Parameter mode

  load-themable-styles run mode, async or sync

function detokenize

detokenize: (styles: string | undefined) => string | undefined;

• Find theme tokens and replaces them with provided theme values.

  Parameter styles

  Tokenized styles to fix.

function flush

flush: () => void;

• external code can call flush to synchronously force processing of currently buffered styles

function loadStyles

loadStyles: (styles: string | ThemableArray, loadAsync?: boolean) => void;

• Loads a set of style text. If it is registered too early, we will register it when the window.load event is fired.

  Parameter styles

  Themable style text to register.

  Parameter loadAsync

  When true, always load styles in async mode, irrespective of current sync mode.

function loadTheme

loadTheme: (theme: ITheme | undefined) => void;

• Registers a set theme tokens to find and replace. If styles were already registered, they will be replaced.

  Parameter theme

  JSON object of theme tokens to values.

function splitStyles

splitStyles: (styles: string) => ThemableArray;

• Split tokenized CSS into an array of strings and theme specification objects

  Parameter styles

  Tokenized styles to split.

type ThemableArray

type ThemableArray = IThemingInstruction[];