UNPKG

@atlaskit/app-provider

Version:

A top level provider for the Design System.

155 lines (154 loc) 6.61 kB
/* index.tsx generated by @compiled/babel-plugin v3.0.2 */ import _extends from "@babel/runtime/helpers/extends"; import "./index.compiled.css"; import { ax, ix } from "@compiled/react/runtime"; import React, { useCallback, useEffect, useRef, useState } from 'react'; import { bind } from 'bind-event-listener'; import { SUBTREE_THEME_ATTRIBUTE } from '@atlaskit/tokens/constants'; import { getThemeHtmlAttrs } from '@atlaskit/tokens/get-theme-html-attrs'; import { setGlobalTheme } from '@atlaskit/tokens/set-global-theme'; import { useIsAppProviderThemingEnabled } from '../use-is-app-provider-theming-enabled'; import { useIsInsideAppProvider } from '../use-is-inside-app-provider'; import { ColorModeContext } from './context/color-mode'; import { InsideThemeProviderContext } from './context/inside-theme-provider'; import { SetColorModeContext } from './context/set-color-mode-context'; import { SetThemeContext, ThemeContext } from './context/theme'; import { useIsInsideThemeProvider } from './hooks/use-is-inside-theme-provider'; import { loadAndMountThemes } from './utils/load-and-mount-themes'; const defaultThemeSettings = { dark: 'dark', light: 'light', shape: 'shape', spacing: 'spacing', typography: 'typography' }; const isMatchMediaAvailable = typeof window !== 'undefined' && 'matchMedia' in window; const prefersDarkModeMql = isMatchMediaAvailable ? window.matchMedia('(prefers-color-scheme: dark)') : undefined; // TODO: currently 'auto' color mode will always return 'light' in SSR. // Additional work required: https://product-fabric.atlassian.net/browse/DSP-9781 function getReconciledColorMode(colorMode) { if (colorMode === 'auto') { return prefersDarkModeMql !== null && prefersDarkModeMql !== void 0 && prefersDarkModeMql.matches ? 'dark' : 'light'; } return colorMode; } const contentStyles = { body: "_1e0c1bgi" }; /** * __Theme provider__ * * Provides global theming configuration. */ export function ThemeProvider({ children, defaultColorMode = 'auto', defaultTheme }) { const [chosenColorMode, setChosenColorMode] = useState(defaultColorMode); const [reconciledColorMode, setReconciledColorMode] = useState(getReconciledColorMode(defaultColorMode)); const [theme, setTheme] = useState(() => ({ ...defaultThemeSettings, ...defaultTheme })); const setColorMode = useCallback(colorMode => { setChosenColorMode(colorMode); setReconciledColorMode(getReconciledColorMode(colorMode)); }, []); const setPartialTheme = useCallback(nextTheme => { setTheme(theme => ({ ...theme, ...nextTheme })); }, []); const lastSetGlobalThemePromiseRef = useRef(null); const isInsideAppProvider = useIsInsideAppProvider(); const isAppProviderThemingEnabled = useIsAppProviderThemingEnabled(); const isInsideThemeProvider = useIsInsideThemeProvider(); /** * A top-level ThemeProvider is detected by being the first ThemeProvider inside an AppProvider. * * This will not use sub-tree theming but instead set the global theme state using the * `@atlaskit/tokens` APIs, as it's required for styling root `html` and `body` elements * for compatibility with `@atlaskit/css-reset`. * * In the future we could consider moving away from DOM mutations and require AppProvider to wrap * `html` in order to apply global theme state, which would allow a more consistent approach to * theme loading. */ const isRootThemeProvider = isInsideAppProvider && !isInsideThemeProvider && isAppProviderThemingEnabled; useEffect(() => { if (isRootThemeProvider) { /** * We need to wait for any previous `setGlobalTheme` calls to finish before calling it again. * This is to prevent race conditions as `setGlobalTheme` is async and mutates the DOM (e.g. sets the * `data-color-mode` attribute on the root element). * * Since we can't safely abort the `setGlobalTheme` execution, we need to wait for it to properly finish before * applying the new theme. * * Without this, we can end up in the following scenario: * 1. app loads with the default 'light' theme, kicking off `setGlobalTheme` * 2. app switches to 'dark' theme after retrieving value persisted in local storage, calling `setGlobalTheme` again * 3. `setGlobalTheme` function execution for `dark` finishes before the initial `light` execution * 4. `setGlobalTheme` function execution for `light` then finishes, resulting in the 'light' theme being applied. */ const cleanupLastFnCall = async () => { if (lastSetGlobalThemePromiseRef.current) { const unbindFn = await lastSetGlobalThemePromiseRef.current; unbindFn(); lastSetGlobalThemePromiseRef.current = null; } }; const safelySetGlobalTheme = async () => { await cleanupLastFnCall(); const promise = setGlobalTheme({ ...theme, colorMode: reconciledColorMode }); lastSetGlobalThemePromiseRef.current = promise; }; safelySetGlobalTheme(); return function cleanup() { cleanupLastFnCall(); }; } // For other theme providers (whether outside AppProvider or nested inside a ThemeProvider), // we treat them as sub-tree themes that do not load global theme state. loadAndMountThemes(theme); }, [isInsideAppProvider, isInsideThemeProvider, isRootThemeProvider, reconciledColorMode, theme]); useEffect(() => { if (!prefersDarkModeMql) { return; } const unbindListener = bind(prefersDarkModeMql, { type: 'change', listener: event => { if (chosenColorMode === 'auto') { setReconciledColorMode(event.matches ? 'dark' : 'light'); } } }); return unbindListener; }, [chosenColorMode]); const attrs = { ...getThemeHtmlAttrs({ ...theme, colorMode: reconciledColorMode }), [SUBTREE_THEME_ATTRIBUTE]: true }; return /*#__PURE__*/React.createElement(InsideThemeProviderContext.Provider, { value: true }, /*#__PURE__*/React.createElement(ColorModeContext.Provider, { value: reconciledColorMode }, /*#__PURE__*/React.createElement(SetColorModeContext.Provider, { value: setColorMode }, /*#__PURE__*/React.createElement(ThemeContext.Provider, { value: theme }, /*#__PURE__*/React.createElement(SetThemeContext.Provider, { value: setPartialTheme }, !isRootThemeProvider ? /*#__PURE__*/React.createElement("div", _extends({}, attrs, { className: ax([contentStyles.body]) }), children) : children))))); }