storybook-dark-mode
Version:
Toggle between light and dark mode in Storybook
261 lines (248 loc) • 15.5 kB
JavaScript
;
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.DarkMode = DarkMode;
exports.updateStore = exports.store = exports.prefersDark = exports["default"] = void 0;
var React = _interopRequireWildcard(require("react"));
var _theming = require("storybook/theming");
var _components = require("storybook/internal/components");
var _icons = require("@storybook/icons");
var _coreEvents = require("storybook/internal/core-events");
var _managerApi = require("storybook/manager-api");
var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
var _constants = require("./constants");
var _excluded = ["current", "stylePreview"];
var _win$matchMedia;
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n["default"] = e, t && t.set(e, n), n; }
function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
var modes = ['light', 'dark'];
var STORAGE_KEY = 'sb-addon-themes-3';
var win = globalThis.window;
var doc = globalThis.document;
var prefersDark = exports.prefersDark = win === null || win === void 0 || (_win$matchMedia = win.matchMedia) === null || _win$matchMedia === void 0 ? void 0 : _win$matchMedia.call(win, '(prefers-color-scheme: dark)');
var defaultParams = {
classTarget: 'body',
dark: _theming.themes.dark,
darkClass: ['dark'],
light: _theming.themes.light,
lightClass: ['light'],
stylePreview: false,
userHasExplicitlySetTheTheme: false
};
/** Persist the dark mode settings in localStorage */
var updateStore = exports.updateStore = function updateStore(newStore) {
var _win$localStorage;
win === null || win === void 0 || (_win$localStorage = win.localStorage) === null || _win$localStorage === void 0 || _win$localStorage.setItem(STORAGE_KEY, JSON.stringify(newStore));
};
/** Add the light/dark class to an element */
var toggleDarkClass = function toggleDarkClass(el, _ref) {
var current = _ref.current,
_ref$darkClass = _ref.darkClass,
darkClass = _ref$darkClass === void 0 ? defaultParams.darkClass : _ref$darkClass,
_ref$lightClass = _ref.lightClass,
lightClass = _ref$lightClass === void 0 ? defaultParams.lightClass : _ref$lightClass;
if (current === 'dark') {
var _el$classList, _el$classList2;
(_el$classList = el.classList).remove.apply(_el$classList, _toConsumableArray(arrayify(lightClass)));
(_el$classList2 = el.classList).add.apply(_el$classList2, _toConsumableArray(arrayify(darkClass)));
} else {
var _el$classList3, _el$classList4;
(_el$classList3 = el.classList).remove.apply(_el$classList3, _toConsumableArray(arrayify(darkClass)));
(_el$classList4 = el.classList).add.apply(_el$classList4, _toConsumableArray(arrayify(lightClass)));
}
};
/** Coerce a string to a single item array, or return an array as-is */
var arrayify = function arrayify(classes) {
var arr = [];
return arr.concat(classes).map(function (item) {
return item;
});
};
/** Update the preview iframe class */
var updatePreview = function updatePreview(store) {
var _iframe$contentWindow;
var iframe = doc === null || doc === void 0 ? void 0 : doc.getElementById('storybook-preview-iframe');
if (!iframe) {
return;
}
var iframeDocument = iframe.contentDocument || ((_iframe$contentWindow = iframe.contentWindow) === null || _iframe$contentWindow === void 0 ? void 0 : _iframe$contentWindow.document);
var target = iframeDocument === null || iframeDocument === void 0 ? void 0 : iframeDocument.querySelector(store.classTarget);
if (!target) {
return;
}
toggleDarkClass(target, store);
};
/** Update the manager iframe class */
var updateManager = function updateManager(store) {
var manager = doc === null || doc === void 0 ? void 0 : doc.querySelector(store.classTarget);
if (!manager) {
return;
}
toggleDarkClass(manager, store);
};
/** Update changed dark mode settings and persist to localStorage */
var store = exports.store = function store() {
var _win$localStorage2;
var userTheme = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
var storedItem = win === null || win === void 0 || (_win$localStorage2 = win.localStorage) === null || _win$localStorage2 === void 0 ? void 0 : _win$localStorage2.getItem(STORAGE_KEY);
if (typeof storedItem === 'string') {
try {
var stored = JSON.parse(storedItem);
if (Object.keys(userTheme).length > 0) {
if (userTheme.dark && !(0, _fastDeepEqual["default"])(stored.dark, userTheme.dark)) {
stored.dark = userTheme.dark;
updateStore(stored);
}
if (userTheme.light && !(0, _fastDeepEqual["default"])(stored.light, userTheme.light)) {
stored.light = userTheme.light;
updateStore(stored);
}
}
return stored;
} catch (_unused) {
// Ignore invalid localStorage payloads and fall through to defaults.
}
}
return _objectSpread(_objectSpread({}, defaultParams), userTheme);
};
// On initial load, set the dark mode class on the manager
// This is needed if you're using mostly CSS overrides to styles the storybook
// Otherwise the default theme is set in src/preset/manager.tsx
updateManager(store());
/** A toolbar icon to toggle between dark and light themes in storybook */
function DarkMode(_ref2) {
var api = _ref2.api;
var _React$useState = React.useState(store().current === 'dark'),
_React$useState2 = _slicedToArray(_React$useState, 2),
isDark = _React$useState2[0],
setDark = _React$useState2[1];
var darkModeParams = (0, _managerApi.useParameter)('darkMode', {});
var defaultMode = darkModeParams.current,
stylePreview = darkModeParams.stylePreview,
params = _objectWithoutProperties(darkModeParams, _excluded);
var channel = api.getChannel();
// Save custom themes on init
var userHasExplicitlySetTheTheme = React.useMemo(function () {
return store(params).userHasExplicitlySetTheTheme;
}, [params]);
/** Set the theme in storybook, update the local state, and emit an event */
var setMode = React.useCallback(function (mode) {
var currentStore = store();
api.setOptions({
theme: currentStore[mode]
});
setDark(mode === 'dark');
channel.emit(_constants.DARK_MODE_EVENT_NAME, mode === 'dark');
updateManager(currentStore);
if (stylePreview) {
updatePreview(currentStore);
}
}, [api, channel, stylePreview]);
/** Update the theme settings in localStorage, react, and storybook */
var updateMode = React.useCallback(function (mode) {
var currentStore = store();
var current = mode || (currentStore.current === 'dark' ? 'light' : 'dark');
updateStore(_objectSpread(_objectSpread({}, currentStore), {}, {
current: current
}));
setMode(current);
}, [setMode]);
/** Update the theme based on the color preference */
var prefersDarkUpdate = React.useCallback(function (event) {
if (userHasExplicitlySetTheTheme || defaultMode) {
return;
}
updateMode(event.matches ? 'dark' : 'light');
}, [defaultMode, updateMode, userHasExplicitlySetTheTheme]);
/** Render the current theme */
var renderTheme = React.useCallback(function () {
var _store = store(),
_store$current = _store.current,
current = _store$current === void 0 ? 'light' : _store$current;
setMode(current);
}, [setMode]);
/** Handle the user event and side effects */
var handleIconClick = function handleIconClick() {
updateMode();
var currentStore = store();
updateStore(_objectSpread(_objectSpread({}, currentStore), {}, {
userHasExplicitlySetTheTheme: true
}));
};
/** When storybook params change update the stored themes */
React.useEffect(function () {
var currentStore = store();
// Ensure we use the stores `current` value first to persist
// themeing between page loads and story changes.
updateStore(_objectSpread(_objectSpread(_objectSpread({}, currentStore), darkModeParams), {}, {
current: currentStore.current || darkModeParams.current
}));
renderTheme();
}, [darkModeParams, renderTheme]);
React.useEffect(function () {
channel.on(_coreEvents.STORY_CHANGED, renderTheme);
channel.on(_coreEvents.DOCS_RENDERED, renderTheme);
if (prefersDark !== null && prefersDark !== void 0 && prefersDark.addEventListener) {
prefersDark.addEventListener('change', prefersDarkUpdate);
}
return function () {
channel.off(_coreEvents.STORY_CHANGED, renderTheme);
channel.off(_coreEvents.DOCS_RENDERED, renderTheme);
if (prefersDark !== null && prefersDark !== void 0 && prefersDark.removeEventListener) {
prefersDark.removeEventListener('change', prefersDarkUpdate);
}
};
}, [channel, renderTheme, prefersDarkUpdate]);
React.useEffect(function () {
channel.on(_constants.UPDATE_DARK_MODE_EVENT_NAME, updateMode);
return function () {
channel.off(_constants.UPDATE_DARK_MODE_EVENT_NAME, updateMode);
};
}, [channel, updateMode]);
// Storybook's first render doesn't have the global user params loaded so we
// need the effect to run whenever defaultMode is updated
React.useEffect(function () {
// If a users has set the mode this is respected
if (userHasExplicitlySetTheTheme) {
return;
}
if (defaultMode) {
updateMode(defaultMode);
} else if (prefersDark !== null && prefersDark !== void 0 && prefersDark.matches) {
updateMode('dark');
}
}, [defaultMode, updateMode, userHasExplicitlySetTheTheme]);
return /*#__PURE__*/React.createElement(_components.IconButton, {
key: "dark-mode",
variant: "ghost",
padding: "small",
ariaLabel: isDark ? 'Change theme to light mode' : 'Change theme to dark mode',
tooltip: isDark ? 'Change theme to light mode' : 'Change theme to dark mode',
onClick: handleIconClick
}, isDark ? /*#__PURE__*/React.createElement(_icons.SunIcon, {
"aria-hidden": "true"
}) : /*#__PURE__*/React.createElement(_icons.MoonIcon, {
"aria-hidden": "true"
}));
}
var _default = exports["default"] = DarkMode;