storybook-addon-pseudo-states 1.14.0 → 1.15.1

package/CHANGELOG.md

@@ -1,3 +1,42 @@
+# v1.15.1 (Wed Jun 22 2022)
+
+#### 🐛 Bug Fix
+
+- Update react and react-dom peer dependencies level [#35](https://github.com/chromaui/storybook-addon-pseudo-states/pull/35) ([@dsueltenfuss](https://github.com/dsueltenfuss))
+
+#### Authors: 1
+
+- Dave Sueltenfuss ([@dsueltenfuss](https://github.com/dsueltenfuss))
+
+---
+
+# v1.15.0 (Thu Jun 16 2022)
+
+#### 🚀 Enhancement
+
+- Add support for targeting specific elements [#25](https://github.com/chromaui/storybook-addon-pseudo-states/pull/25) (sagiv.bengiat@appsflyer.com [@ghengeveld](https://github.com/ghengeveld) [@sag1v](https://github.com/sag1v))
+
+#### Authors: 3
+
+- Gert Hengeveld ([@ghengeveld](https://github.com/ghengeveld))
+- Sagiv ben giat ([@sag1v](https://github.com/sag1v))
+- sagiv.bengiat (sagiv.bengiat@appsflyer.com)
+
+---
+
+# v1.14.1 (Wed Jun 15 2022)
+
+#### ⚠️ Pushed to `main`
+
+- Fix toolbar toggles ([@ghengeveld](https://github.com/ghengeveld))
+- Upgrade Storybook ([@ghengeveld](https://github.com/ghengeveld))
+
+#### Authors: 1
+
+- Gert Hengeveld ([@ghengeveld](https://github.com/ghengeveld))
+
+---
+
 # v1.0.0 (Tue May 24 2022)
 
 #### 🚀 Enhancement

package/README.md

@@ -41,9 +41,32 @@ module.exports = {
 
 You can have your stories automatically use a specific set of pseudo states, by setting the `pseudo` property on `parameters`:
 
-```js
+```jsx
 export const Hover = () => <Button>Label</Button>
 Hover.parameters = { pseudo: { hover: true } }
 ```
 
 This is what enables snapshot testing your pseudo states in [Chromatic](https://www.chromatic.com/).
+
+### Targeting specific elements
+
+If you don't want to force or toggle pseudo styles to all elements that use them, but rather only enable them on specific elements, you can set a string or array value instead of a boolean:
+
+```jsx
+export const Buttons = () => (
+  <>
+    <Button id="one">Hover</Button>
+    <Button id="two">Hover focus</Button>
+    <Button id="three">Hover focus active</Button>
+  </>
+)
+Buttons.parameters = {
+  pseudo: {
+    hover: ["#one", "#two", "#three"],
+    focus: ["#two", "#three"],
+    active: "#three",
+  },
+}
+```
+
+This accepts a single CSS selector (string), or an array of CSS selectors on which to enable that pseudo style.

package/dist/cjs/PseudoStateTool.js

@@ -1,7 +1,5 @@
 "use strict";
 
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -17,37 +15,23 @@ var _theming = require("@storybook/theming");
 
 var _constants = require("./constants");
 
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-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 _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
-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 _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-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; }
-
-function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
-
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-
-var LinkTitle = _theming.styled.span(function (_ref) {
-  var active = _ref.active;
+const LinkTitle = _theming.styled.span(_ref => {
+  let {
+    active
+  } = _ref;
   return {
     color: active ? _theming.color.secondary : "inherit"
   };
 });
 
-var LinkIcon = (0, _theming.styled)(_components.Icons)(function (_ref2) {
-  var active = _ref2.active;
+const LinkIcon = (0, _theming.styled)(_components.Icons)(_ref2 => {
+  let {
+    active
+  } = _ref2;
   return {
     opacity: active ? 1 : 0,
     path: {
@@ -55,54 +39,41 @@ var LinkIcon = (0, _theming.styled)(_components.Icons)(function (_ref2) {
     }
   };
 });
-var options = Object.keys(_constants.PSEUDO_STATES).sort();
-
-var PseudoStateTool = function PseudoStateTool() {
-  var _useGlobals = (0, _api.useGlobals)(),
-      _useGlobals2 = _slicedToArray(_useGlobals, 2),
-      pseudo = _useGlobals2[0].pseudo,
-      updateGlobals = _useGlobals2[1];
-
-  var hasSelection = (0, _react.useMemo)(function () {
-    return !!pseudo && Object.values(pseudo).includes(true);
-  }, [pseudo]);
-  var getValue = (0, _react.useCallback)(function (option) {
-    return pseudo ? pseudo[option] : false;
-  }, [pseudo]);
-  var toggleOption = (0, _react.useCallback)(function (option) {
-    return function () {
-      return updateGlobals({
-        pseudo: _objectSpread(_objectSpread({}, pseudo), {}, _defineProperty({}, option, !getValue(option)))
-      });
-    };
-  }, [pseudo, getValue]);
+const options = Object.keys(_constants.PSEUDO_STATES).sort();
+
+const PseudoStateTool = () => {
+  const [{
+    pseudo
+  }, updateGlobals] = (0, _api.useGlobals)();
+  const isActive = (0, _react.useCallback)(option => (pseudo === null || pseudo === void 0 ? void 0 : pseudo[option]) === true, [pseudo]);
+  const toggleOption = (0, _react.useCallback)(option => () => updateGlobals({
+    pseudo: { ...pseudo,
+      [option]: !isActive(option)
+    }
+  }), [pseudo]);
   return /*#__PURE__*/_react.default.createElement(_components.WithTooltip, {
     placement: "top",
     trigger: "click",
-    tooltip: function tooltip() {
-      return /*#__PURE__*/_react.default.createElement(_components.TooltipLinkList, {
-        links: options.map(function (option) {
-          return {
-            id: option,
-            title: /*#__PURE__*/_react.default.createElement(LinkTitle, {
-              active: getValue(option)
-            }, ":", _constants.PSEUDO_STATES[option]),
-            right: /*#__PURE__*/_react.default.createElement(LinkIcon, {
-              icon: "check",
-              width: 12,
-              height: 12,
-              active: getValue(option)
-            }),
-            onClick: toggleOption(option),
-            active: getValue(option)
-          };
-        })
-      });
-    }
+    tooltip: () => /*#__PURE__*/_react.default.createElement(_components.TooltipLinkList, {
+      links: options.map(option => ({
+        id: option,
+        title: /*#__PURE__*/_react.default.createElement(LinkTitle, {
+          active: isActive(option)
+        }, ":", _constants.PSEUDO_STATES[option]),
+        right: /*#__PURE__*/_react.default.createElement(LinkIcon, {
+          icon: "check",
+          width: 12,
+          height: 12,
+          active: isActive(option)
+        }),
+        onClick: toggleOption(option),
+        active: isActive(option)
+      }))
+    })
   }, /*#__PURE__*/_react.default.createElement(_components.IconButton, {
     key: "pseudo-state",
     title: "Select CSS pseudo states",
-    active: hasSelection
+    active: options.some(isActive)
   }, /*#__PURE__*/_react.default.createElement(_components.Icons, {
     icon: "button"
   })));

package/dist/cjs/constants.js

@@ -4,13 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.TOOL_ID = exports.PSEUDO_STATES = exports.ADDON_ID = void 0;
-var ADDON_ID = "storybook/pseudo-states";
+const ADDON_ID = "storybook/pseudo-states";
 exports.ADDON_ID = ADDON_ID;
-var TOOL_ID = "".concat(ADDON_ID, "/tool"); // Dynamic pseudo-classes
+const TOOL_ID = "".concat(ADDON_ID, "/tool"); // Dynamic pseudo-classes
 // @see https://www.w3.org/TR/2018/REC-selectors-3-20181106/#dynamic-pseudos
 
 exports.TOOL_ID = TOOL_ID;
-var PSEUDO_STATES = {
+const PSEUDO_STATES = {
   hover: "hover",
   active: "active",
   focusVisible: "focus-visible",

package/dist/cjs/preset/manager.js

@@ -6,12 +6,14 @@ var _constants = require("../constants");
 
 var _PseudoStateTool = require("../PseudoStateTool");
 
-_addons.addons.register(_constants.ADDON_ID, function () {
+_addons.addons.register(_constants.ADDON_ID, () => {
   _addons.addons.add(_constants.TOOL_ID, {
     type: _addons.types.TOOL,
     title: "CSS pseudo states",
-    match: function match(_ref) {
-      var viewMode = _ref.viewMode;
+    match: _ref => {
+      let {
+        viewMode
+      } = _ref;
       return viewMode === "story";
     },
     render: _PseudoStateTool.PseudoStateTool

package/dist/cjs/preset/preview.js

@@ -7,5 +7,5 @@ exports.decorators = void 0;
 
 var _withPseudoState = require("../withPseudoState");
 
-var decorators = [_withPseudoState.withPseudoState];
+const decorators = [_withPseudoState.withPseudoState];
 exports.decorators = decorators;

package/dist/cjs/rewriteStyleSheet.js

@@ -0,0 +1,87 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.rewriteStyleSheet = void 0;
+
+var _constants = require("./constants");
+
+var _splitSelectors = require("./splitSelectors");
+
+const pseudoStates = Object.values(_constants.PSEUDO_STATES);
+const matchOne = new RegExp(":(".concat(pseudoStates.join("|"), ")"));
+const matchAll = new RegExp(":(".concat(pseudoStates.join("|"), ")"), "g");
+const warnings = new Set();
+
+const warnOnce = message => {
+  if (warnings.has(message)) return; // eslint-disable-next-line no-console
+
+  console.warn(message);
+  warnings.add(message);
+};
+
+const rewriteRule = (cssText, selectorText, shadowRoot) => {
+  return cssText.replace(selectorText, (0, _splitSelectors.splitSelectors)(selectorText).flatMap(selector => {
+    if (selector.includes(".pseudo-")) {
+      return [];
+    }
+
+    if (!matchOne.test(selector)) {
+      return [selector];
+    }
+
+    const states = [];
+    const plainSelector = selector.replace(matchAll, (_, state) => {
+      states.push(state);
+      return "";
+    });
+    const classSelector = states.reduce((acc, state) => acc.replace(new RegExp(":".concat(state), "g"), ".pseudo-".concat(state)), selector);
+
+    if (selector.startsWith(":host(") || selector.startsWith("::slotted(")) {
+      return [selector, classSelector];
+    }
+
+    const ancestorSelector = shadowRoot ? ":host(".concat(states.map(s => ".pseudo-".concat(s)).join(""), ") ").concat(plainSelector) : "".concat(states.map(s => ".pseudo-".concat(s)).join(""), " ").concat(plainSelector);
+    return [selector, classSelector, ancestorSelector].filter(selector => !selector.includes(":not()"));
+  }).join(", "));
+}; // Rewrites the style sheet to add alternative selectors for any rule that targets a pseudo state.
+// A sheet can only be rewritten once, and may carry over between stories.
+
+
+const rewriteStyleSheet = (sheet, shadowRoot, shadowHosts) => {
+  if (sheet.__pseudoStatesRewritten) return;
+  sheet.__pseudoStatesRewritten = true;
+
+  try {
+    let index = 0;
+
+    for (const {
+      cssText,
+      selectorText
+    } of sheet.cssRules) {
+      if (matchOne.test(selectorText)) {
+        const newRule = rewriteRule(cssText, selectorText, shadowRoot);
+        sheet.deleteRule(index);
+        sheet.insertRule(newRule, index);
+        if (shadowRoot) shadowHosts.add(shadowRoot.host);
+      }
+
+      index++;
+
+      if (index > 1000) {
+        warnOnce("Reached maximum of 1000 pseudo selectors per sheet, skipping the rest.");
+        break;
+      }
+    }
+  } catch (e) {
+    if (e.toString().includes("cssRules")) {
+      warnOnce("Can't access cssRules, likely due to CORS restrictions: ".concat(sheet.href));
+    } else {
+      // eslint-disable-next-line no-console
+      console.error(e, sheet.href);
+    }
+  }
+};
+
+exports.rewriteStyleSheet = rewriteStyleSheet;

package/dist/cjs/rewriteStyleSheet.test.js

@@ -0,0 +1,70 @@
+"use strict";
+
+var _rewriteStyleSheet = require("./rewriteStyleSheet");
+
+class Sheet {
+  constructor() {
+    this.__pseudoStatesRewritten = false;
+
+    for (var _len = arguments.length, rules = new Array(_len), _key = 0; _key < _len; _key++) {
+      rules[_key] = arguments[_key];
+    }
+
+    this.cssRules = rules.map(cssText => ({
+      cssText,
+      selectorText: cssText.slice(0, cssText.indexOf(" {"))
+    }));
+  }
+
+  deleteRule(index) {
+    this.cssRules.splice(index, 1);
+  }
+
+  insertRule(cssText, index) {
+    this.cssRules.splice(index, 0, cssText);
+  }
+
+}
+
+describe("rewriteStyleSheet", () => {
+  it("adds alternative selector targeting the element directly", () => {
+    const sheet = new Sheet("a:hover { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toContain("a.pseudo-hover");
+  });
+  it("adds alternative selector targeting an ancestor", () => {
+    const sheet = new Sheet("a:hover { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toContain(".pseudo-hover a");
+  });
+  it("adds alternative selector for each pseudo selector", () => {
+    const sheet = new Sheet("a:hover, a:focus { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toContain("a.pseudo-hover");
+    expect(sheet.cssRules[0]).toContain("a.pseudo-focus");
+    expect(sheet.cssRules[0]).toContain(".pseudo-hover a");
+    expect(sheet.cssRules[0]).toContain(".pseudo-focus a");
+  });
+  it("keeps non-pseudo selectors as-is", () => {
+    const sheet = new Sheet("a.class, a:hover, a:focus, a#id { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toContain("a.class");
+    expect(sheet.cssRules[0]).toContain("a#id");
+  });
+  it("supports combined pseudo selectors", () => {
+    const sheet = new Sheet("a:hover:focus { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toContain("a.pseudo-hover.pseudo-focus");
+    expect(sheet.cssRules[0]).toContain(".pseudo-hover.pseudo-focus a");
+  });
+  it('supports ":host"', () => {
+    const sheet = new Sheet(":host(:hover) { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toEqual(":host(:hover), :host(.pseudo-hover) { color: red }");
+  });
+  it('supports ":not"', () => {
+    const sheet = new Sheet(":not(:hover) { color: red }");
+    (0, _rewriteStyleSheet.rewriteStyleSheet)(sheet);
+    expect(sheet.cssRules[0]).toEqual(":not(:hover), :not(.pseudo-hover) { color: red }");
+  });
+});

package/dist/cjs/splitSelectors.js

@@ -5,19 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.splitSelectors = void 0;
 
-var isAtRule = function isAtRule(selector) {
-  return selector.indexOf("@") === 0;
-};
+const isAtRule = selector => selector.indexOf("@") === 0;
 
-var splitSelectors = function splitSelectors(selectors) {
+const splitSelectors = selectors => {
   if (isAtRule(selectors)) return [selectors];
-  var result = [];
-  var parentheses = 0;
-  var brackets = 0;
-  var selector = "";
+  let result = [];
+  let parentheses = 0;
+  let brackets = 0;
+  let selector = "";
 
-  for (var i = 0, len = selectors.length; i < len; i++) {
-    var char = selectors[i];
+  for (let i = 0, len = selectors.length; i < len; i++) {
+    const char = selectors[i];
 
     if (char === "(") {
       parentheses += 1;

package/dist/cjs/splitSelectors.test.js

@@ -2,16 +2,16 @@
 
 var _splitSelectors = require("./splitSelectors");
 
-describe("splitSelectors", function () {
-  test("handles basic selectors", function () {
+describe("splitSelectors", () => {
+  test("handles basic selectors", () => {
     expect((0, _splitSelectors.splitSelectors)(".a")).toEqual([".a"]);
     expect((0, _splitSelectors.splitSelectors)(".a, .b")).toEqual([".a", ".b"]);
   });
-  test("supports ::slotted and :is", function () {
+  test("supports ::slotted and :is", () => {
     expect((0, _splitSelectors.splitSelectors)("::slotted(:is(button, a):active)")).toEqual(["::slotted(:is(button, a):active)"]);
     expect((0, _splitSelectors.splitSelectors)("::slotted(:is(button, a):active), ::slotted(:is(button, a):hover)")).toEqual(["::slotted(:is(button, a):active)", "::slotted(:is(button, a):hover)"]);
   });
-  test("supports :host", function () {
+  test("supports :host", () => {
     expect((0, _splitSelectors.splitSelectors)(":host([type='secondary']) ::slotted(:is(button, a)), :host([type='primary']) ::slotted(:is(button, a):active)")).toEqual([":host([type='secondary']) ::slotted(:is(button, a))", ":host([type='primary']) ::slotted(:is(button, a):active)"]);
     expect((0, _splitSelectors.splitSelectors)(":host([outline]) ::slotted(:is(button, a):focus-within:focus-visible:not(:active))")).toEqual([":host([outline]) ::slotted(:is(button, a):focus-within:focus-visible:not(:active))"]);
   });