@sit-onyx/storybook-utils 1.0.0-beta.9 → 1.0.0-beta.91

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./actions";
 export * from "./preview";
+export * from "./sbType";
 export * from "./theme";
 export * from "./types";

package/src/preview.spec.ts

@@ -1,25 +1,19 @@
 import bellRing from "@sit-onyx/icons/bell-ring.svg?raw";
 import calendar from "@sit-onyx/icons/calendar.svg?raw";
 import placeholder from "@sit-onyx/icons/placeholder.svg?raw";
-import { describe, expect, test, vi } from "vitest";
+import { describe, expect, test } from "vitest";
 import { replaceAll, sourceCodeTransformer } from "./preview";
-import * as sourceCodeGenerator from "./source-code-generator";
 
 describe("preview.ts", () => {
   test("should transform source code and add icon/onyx imports", () => {
-    // ARRANGE
-    const generatorSpy = vi.spyOn(sourceCodeGenerator, "generateSourceCode")
-      .mockReturnValue(`<template>
+    // ACT
+    const sourceCode = sourceCodeTransformer(`<template>
 <OnyxTest icon='${placeholder}' test='${bellRing}' :obj="{foo:'${replaceAll(calendar, '"', "\\'")}'}" />
 <OnyxOtherComponent />
 <OnyxComp>Test</OnyxComp>
 </template>`);
 
-    // ACT
-    const sourceCode = sourceCodeTransformer("", { title: "OnyxTest", args: {} });
-
     // ASSERT
-    expect(generatorSpy).toHaveBeenCalledOnce();
     expect(sourceCode).toBe(`<script lang="ts" setup>
 import { OnyxComp, OnyxOtherComponent, OnyxTest } from "sit-onyx";
 import bellRing from "@sit-onyx/icons/bell-ring.svg?raw";

package/src/preview.ts

@@ -1,26 +1,22 @@
 import { getIconImportName } from "@sit-onyx/icons";
-import { type Preview, type StoryContext } from "@storybook/vue3";
+import type { Preview } from "@storybook/vue3";
+import { DARK_MODE_EVENT_NAME } from "@vueless/storybook-dark-mode";
 import { deepmerge } from "deepmerge-ts";
-import { DARK_MODE_EVENT_NAME } from "storybook-dark-mode";
 import { DOCS_RENDERED } from "storybook/internal/core-events";
 import { addons } from "storybook/internal/preview-api";
 import type { ThemeVars } from "storybook/internal/theming";
+import { enhanceEventArgTypes } from "./actions";
 import { requiredGlobalType, withRequired } from "./required";
-import { generateSourceCode } from "./source-code-generator";
-import { ONYX_BREAKPOINTS, createTheme } from "./theme";
-
-const themes = {
-  light: createTheme(),
-  dark: createTheme({ base: "dark" }),
-} as const;
+import { ONYX_BREAKPOINTS, createTheme, type BrandDetails } from "./theme";
 
 /**
  * Creates a default Storybook preview configuration for 'onyx' with the following features:
  * - Improved controls (sorting and expanded controls so descriptions etc. are also shown in a single story)
  * - Improved Vue-specific code highlighting (e.g. using `@` instead of `v-on:`)
- * - Setup for dark mode (including docs page). Requires addon `storybook-dark-mode` to be enabled in .storybook/main.ts file
+ * - Setup for dark mode (including docs page). Requires addon `@vueless/storybook-dark-mode` to be enabled in .storybook/main.ts file
  * - Custom Storybook theme using onyx colors (light and dark mode)
  * - Configure viewports / breakpoints as defined by onyx
+ * - Logs Vue emits as Storybook events
  *
  * @param overrides Custom preview / overrides, will be deep merged with the default preview.
  *
@@ -39,8 +35,20 @@ const themes = {
  * export default preview;
  * ```
  */
-export const createPreview = <T extends Preview = Preview>(overrides?: T) => {
+export const createPreview = <T extends Preview = Preview>(
+  overrides?: T,
+  brandDetails?: BrandDetails,
+) => {
+  const themes = {
+    light: createTheme("light", brandDetails),
+    dark: createTheme("dark", brandDetails),
+  } as const;
+
   const defaultPreview = {
+    argTypesEnhancers: [enhanceEventArgTypes],
+    initialGlobals: {
+      ["requiredMode" satisfies keyof typeof requiredGlobalType]: "required",
+    },
     globalTypes: {
       ...requiredGlobalType,
     },
@@ -54,6 +62,7 @@ export const createPreview = <T extends Preview = Preview>(overrides?: T) => {
         sort: "requiredFirst",
         // needed to also show props/events descriptions etc. when opening a single story
         expanded: true,
+        exclude: ["ref", "ref_for", "ref_key", "class", "style", "key", "$slots"],
       },
       docs: {
         // see: https://github.com/hipstersmoothie/storybook-dark-mode/issues/127#issuecomment-840701971
@@ -63,11 +72,9 @@ export const createPreview = <T extends Preview = Preview>(overrides?: T) => {
           if (isDark) {
             document.body.classList.remove("light");
             document.body.classList.add("dark");
-            document.documentElement.style.colorScheme = "dark";
           } else {
             document.body.classList.remove("dark");
             document.body.classList.add("light");
-            document.documentElement.style.colorScheme = "light";
           }
 
           return isDark ? themes.dark : themes.light;
@@ -123,16 +130,15 @@ export const createPreview = <T extends Preview = Preview>(overrides?: T) => {
  *
  * @see https://storybook.js.org/docs/react/api/doc-block-source
  */
-export const sourceCodeTransformer = (
-  sourceCode: string,
-  ctx: Pick<StoryContext, "title" | "component" | "args">,
-): string => {
+export const sourceCodeTransformer = (originalSourceCode: string): string => {
   const RAW_ICONS = import.meta.glob("../node_modules/@sit-onyx/icons/src/assets/*.svg", {
     query: "?raw",
     import: "default",
     eager: true,
   });
 
+  let code = originalSourceCode;
+
   /**
    * Mapping between icon SVG content (key) and icon name (value).
    * Needed to display a labelled dropdown list of all available icons.
@@ -145,8 +151,6 @@ export const sourceCodeTransformer = (
     {},
   );
 
-  let code = generateSourceCode(ctx);
-
   const additionalImports: string[] = [];
 
   // add icon imports to the source code for all used onyx icons
@@ -156,7 +160,10 @@ export const sourceCodeTransformer = (
     const escapedIconContent = `"${replaceAll(iconContent, '"', '\\"')}"`;
 
     if (code.includes(iconContent)) {
-      code = code.replace(new RegExp(` (\\S+)=['"]${iconContent}['"]`), ` :$1="${importName}"`);
+      code = code.replace(
+        new RegExp(` (\\S+)=['"]${escapeRegExp(iconContent)}['"]`),
+        ` :$1="${importName}"`,
+      );
       additionalImports.push(`import ${importName} from "@sit-onyx/icons/${iconName}.svg?raw";`);
     } else if (code.includes(singleQuotedIconContent)) {
       // support icons inside objects
@@ -206,3 +213,11 @@ ${code}`;
 export const replaceAll = (value: string, searchValue: string | RegExp, replaceValue: string) => {
   return value.replace(new RegExp(searchValue, "gi"), replaceValue);
 };
+
+/**
+ * Escapes the given string value to be used in `new RegExp()`.
+ * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping
+ */
+export const escapeRegExp = (string: string) => {
+  return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+};

package/src/required.ts

@@ -8,7 +8,6 @@ export const requiredGlobalType = {
   requiredMode: {
     name: "Required mode",
     description: "Switch between 'required' and 'optional' indicator",
-    defaultValue: "required",
     toolbar: {
       icon: "flag",
       items: [

package/src/sbType.spec.ts

@@ -0,0 +1,38 @@
+import type { SBType } from "storybook/internal/types";
+import { describe, expect, test, vi } from "vitest";
+import { walkTree } from "./sbType";
+
+describe("walkTree", () => {
+  test.each<{ input: SBType; expected: SBType["name"][] }>([
+    { input: { name: "array", value: { name: "number" } }, expected: ["array", "number"] },
+    { input: { name: "object", value: { a: { name: "number" } } }, expected: ["object", "number"] },
+    { input: { name: "enum", value: ["a"] }, expected: ["enum"] },
+    {
+      input: { name: "intersection", value: [{ name: "number" }] },
+      expected: ["intersection", "number"],
+    },
+    { input: { name: "union", value: [{ name: "number" }] }, expected: ["union", "number"] },
+    { input: { name: "other", value: "a" }, expected: ["other"] },
+  ])("should execute cb for $input.name correctly", ({ input, expected }) => {
+    const spy = vi.fn<(p: SBType) => void>();
+    const result = walkTree(input, spy);
+
+    expect(result).toBeUndefined();
+    expect(spy).toHaveBeenCalledTimes(expected.length);
+    const nameCalls = spy.mock.calls.map(([{ name }]) => name);
+    expect(nameCalls).toMatchObject(expected);
+  });
+
+  test("should return value if there is any returned", () => {
+    const target: SBType = { name: "number", raw: "here" };
+    const overshoot: SBType = { name: "boolean", raw: "here" };
+    const parent: SBType = { name: "intersection", value: [target, overshoot] };
+    const returned = 42;
+    const spy = vi.fn((p: SBType) => (p.raw === "here" ? returned : undefined));
+    const result = walkTree({ name: "union", value: [parent] }, spy);
+
+    expect(spy).toHaveBeenCalledTimes(3);
+    expect(spy).toHaveBeenLastCalledWith(target, parent);
+    expect(result).toBe(returned);
+  });
+});

package/src/sbType.ts

@@ -0,0 +1,104 @@
+import type {
+  ArgTypesEnhancer,
+  InputType,
+  SBType,
+  StrictInputType,
+} from "storybook/internal/types";
+
+/**
+ * Call a function `cb` for every type node in the storybook type tree.
+ * @param inputType the root type
+ * @param cb the function that is called for every type. If any non-nullish value is returned by `cb` the execution is stopped and this value is returned.
+ * @param parent optional, the parent type. Is only used as input for the `cb` function and provided when recursing.
+ * @returns the first non-nullish value that is returned by `cb`
+ */
+export const walkTree = <TValue>(
+  inputType: SBType,
+  cb: (sb: SBType, parent?: SBType) => TValue,
+  parent?: SBType,
+): TValue | undefined => {
+  const shouldReturn = cb(inputType, parent);
+  if (shouldReturn) {
+    return shouldReturn;
+  }
+
+  if (inputType.name === "union" || inputType.name === "intersection") {
+    return inputType.value.reduce<TValue | undefined>(
+      (prev, it) => prev ?? walkTree(it, cb, inputType),
+      undefined,
+    );
+  }
+  if (inputType.name === "array") {
+    return walkTree(inputType.value, cb, inputType);
+  }
+  if (inputType.name === "object") {
+    return Object.values(inputType.value).reduce<TValue | undefined>(
+      (prev, it) => prev ?? walkTree(it, cb, inputType),
+      undefined,
+    );
+  }
+};
+
+const SB_TYPE_CONTROL_MAP: Partial<Record<SBType["name"], InputType["control"]>> = {
+  boolean: { type: "boolean" },
+  string: { type: "text" },
+  number: { type: "number" },
+};
+
+const getFormInjectedParent = (symbol: string, inputType?: StrictInputType) => {
+  if (!inputType?.type || inputType.table?.defaultValue?.summary !== symbol) {
+    return undefined;
+  }
+
+  return walkTree(inputType.type, (elem, parent) =>
+    elem.name === "symbol" || (elem.name === "other" && elem.value === "unique symbol")
+      ? parent
+      : undefined,
+  );
+};
+
+/**
+ * Can be used to create an `ArgTypesEnhancer` which matches a Symbol that is used as default Prop.
+ * When it matches the passed  description text will be set.
+ *
+ * @param symbol description of the symbol that should be matched.
+ * @param description the description text that should be shown in Storybook for this prop.
+ * @returns An `ArgTypesEnhancer` which can be passed to storybook.
+ *
+ * @example
+ * ```ts
+ * import { createSymbolArgTypeEnhancer } from "@sit-onyx/storybook-utils";
+ *
+ * export const enhanceFormInjectedSymbol = createSymbolArgTypeEnhancer(
+ *   "FORM_INJECTED_SYMBOL",
+ *   "If no value (or `undefined`) is provided, `FORM_INJECTED_SYMBOL` is the internal default value for this prop.\n" +
+ *     "In that case the props value will be derived from it's parent form (if it exists).\n",
+ * );
+ * ```
+ */
+export const createSymbolArgTypeEnhancer = (
+  symbol: string,
+  description: string,
+): ArgTypesEnhancer => {
+  return (context) => {
+    Object.values(context.argTypes)
+      .map((argType) => {
+        const parent = getFormInjectedParent(symbol, argType);
+        return { argType, parent };
+      })
+      .filter(({ parent }) => parent)
+      .forEach(({ argType, parent }) => {
+        const firstAvailableControl = walkTree(
+          parent || argType.type!,
+          (sb) => SB_TYPE_CONTROL_MAP[sb.name],
+        );
+
+        if (firstAvailableControl && argType.table?.defaultValue) {
+          argType.control = firstAvailableControl;
+          argType.table.defaultValue.detail = description;
+        }
+      });
+
+    return context.argTypes;
+  };
+};

package/src/style.css

@@ -0,0 +1,161 @@
+.onyx-disclaimer {
+  border-radius: 0.5rem;
+  padding: 1rem;
+  line-height: var(--onyx-font-line-height-md);
+  margin: 1rem 0;
+
+  /* same color as VitePress var(--vp-c-tip-soft) */
+  background-color: color-mix(in srgb, var(--onyx-color-base-info-400) 25%, transparent);
+}
+
+.onyx-disclaimer__title {
+  font-weight: var(--onyx-font-weight-semibold);
+  margin-bottom: 0.5rem;
+}
+
+.onyx-disclaimer p {
+  margin: 0;
+}
+
+/* the Storybook table of content headline is always black so we need to manually set it for the dark mode */
+#storybook-docs .sbdocs-wrapper > aside > nav > h2 {
+  /* same as Storybook color "textMuted" inside ./theme.ts */
+  color: var(--onyx-color-text-icons-neutral-medium);
+}
+
+/* To prevent bg flashing when changing between elements in darkmode */
+.sb-preparing-story,
+.sb-preparing-docs {
+  background-color: transparent;
+}
+/* removed placeholder for the same reason */
+.sb-previewBlock,
+.sb-argstableBlock {
+  display: none;
+}
+
+/*
+  Copy of ../sit-onyx/src/styles/variables/themes/onyx.css
+  TODO: Find a way to automate this
+ */
+:where(:root),
+.onyx-theme-default {
+  --onyx-color-steel-100: #fafbfc;
+  --onyx-color-steel-200: #e3eaf0;
+  --onyx-color-steel-300: #c9d6e0;
+  --onyx-color-steel-400: #9db3c4;
+  --onyx-color-steel-500: #7392aa;
+  --onyx-color-steel-600: #506e84;
+  --onyx-color-steel-700: #3e596e;
+  --onyx-color-steel-800: #31495c;
+  --onyx-color-steel-900: #22384a;
+  --onyx-color-steel-1000: #11212d;
+  --onyx-color-steel-1100: #081723;
+  --onyx-color-steel-1200: #000e19;
+  --onyx-color-themed-primary-100: #e8fcfc;
+  --onyx-color-themed-primary-200: #bbeaed;
+  --onyx-color-themed-primary-300: #79dde2;
+  --onyx-color-themed-primary-400: #3dd0d8;
+  --onyx-color-themed-primary-500: #00c3cd;
+  --onyx-color-themed-primary-600: #00adb5;
+  --onyx-color-themed-primary-700: #00969d;
+  --onyx-color-themed-primary-800: #008085;
+  --onyx-color-themed-primary-900: #00696e;
+  --onyx-color-themed-primary-1000: #005356;
+  --onyx-color-themed-primary-1100: #003c3e;
+  --onyx-color-themed-primary-1200: #002626;
+  --onyx-color-themed-secondary-100: var(--onyx-color-themed-primary-100);
+  --onyx-color-themed-secondary-200: var(--onyx-color-themed-primary-200);
+  --onyx-color-themed-secondary-300: var(--onyx-color-themed-primary-300);
+  --onyx-color-themed-secondary-400: var(--onyx-color-themed-primary-400);
+  --onyx-color-themed-secondary-500: var(--onyx-color-themed-primary-500);
+  --onyx-color-themed-secondary-600: var(--onyx-color-themed-primary-600);
+  --onyx-color-themed-secondary-700: var(--onyx-color-themed-primary-700);
+  --onyx-color-themed-secondary-800: var(--onyx-color-themed-primary-800);
+  --onyx-color-themed-secondary-900: var(--onyx-color-themed-primary-900);
+  --onyx-color-themed-secondary-1000: var(--onyx-color-themed-primary-1000);
+  --onyx-color-themed-secondary-1100: var(--onyx-color-themed-primary-1100);
+  --onyx-color-themed-secondary-1200: var(--onyx-color-themed-primary-1200);
+  --onyx-color-universal-grayscale-black: #000000;
+  --onyx-color-universal-grayscale-white: #ffffff;
+  --onyx-color-universal-green-100: #ecf8f2;
+  --onyx-color-universal-green-200: #c6e4d5;
+  --onyx-color-universal-green-300: #98d1b3;
+  --onyx-color-universal-green-400: #6ebe94;
+  --onyx-color-universal-green-500: #44aa75;
+  --onyx-color-universal-green-600: #3b9b69;
+  --onyx-color-universal-green-700: #328c5e;
+  --onyx-color-universal-green-800: #297d52;
+  --onyx-color-universal-green-900: #216d46;
+  --onyx-color-universal-green-1000: #185e3a;
+  --onyx-color-universal-green-1100: #064023;
+  --onyx-color-universal-green-1200: #064023;
+  --onyx-color-universal-orange-100: #faf6f2;
+  --onyx-color-universal-orange-200: #f8e7d8;
+  --onyx-color-universal-orange-300: #f6d1b1;
+  --onyx-color-universal-orange-400: #f4b57e;
+  --onyx-color-universal-orange-500: #f2994a;
+  --onyx-color-universal-orange-600: #d98841;
+  --onyx-color-universal-orange-700: #bf7737;
+  --onyx-color-universal-orange-800: #a6662e;
+  --onyx-color-universal-orange-900: #8c5625;
+  --onyx-color-universal-orange-1000: #73451c;
+  --onyx-color-universal-orange-1100: #593412;
+  --onyx-color-universal-orange-1200: #402309;
+  --onyx-color-universal-purple-100: #f4f1f8;
+  --onyx-color-universal-purple-200: #dbcfea;
+  --onyx-color-universal-purple-300: #c2addc;
+  --onyx-color-universal-purple-400: #a98ace;
+  --onyx-color-universal-purple-500: #9068c0;
+  --onyx-color-universal-purple-600: #805aae;
+  --onyx-color-universal-purple-700: #704c9b;
+  --onyx-color-universal-purple-800: #603e89;
+  --onyx-color-universal-purple-900: #513077;
+  --onyx-color-universal-purple-1000: #412265;
+  --onyx-color-universal-purple-1100: #311452;
+  --onyx-color-universal-purple-1200: #210640;
+  --onyx-color-universal-quantitatives-100: #005795;
+  --onyx-color-universal-quantitatives-200: #ff8a25;
+  --onyx-color-universal-quantitatives-300: #e51718;
+  --onyx-color-universal-quantitatives-400: #36b16b;
+  --onyx-color-universal-quantitatives-500: #56d8fc;
+  --onyx-color-universal-quantitatives-600: #ff9990;
+  --onyx-color-universal-quantitatives-700: #ff3fd1;
+  --onyx-color-universal-quantitatives-800: #3c6475;
+  --onyx-color-universal-quantitatives-900: #c4bc81;
+  --onyx-color-universal-quantitatives-1000: #c3143f;
+  --onyx-color-universal-quantitatives-1100: #a09dfa;
+  --onyx-color-universal-quantitatives-1200: #00bcc6;
+  --onyx-color-universal-red-100: #fbefee;
+  --onyx-color-universal-red-200: #f1d2d1;
+  --onyx-color-universal-red-300: #e6a7a5;
+  --onyx-color-universal-red-400: #dc716e;
+  --onyx-color-universal-red-500: #d1332f;
+  --onyx-color-universal-red-600: #bc2d2a;
+  --onyx-color-universal-red-700: #a82824;
+  --onyx-color-universal-red-800: #93221f;
+  --onyx-color-universal-red-900: #7e1d19;
+  --onyx-color-universal-red-1000: #691714;
+  --onyx-color-universal-red-1100: #400c09;
+  --onyx-color-universal-red-1200: #400c09;
+  --onyx-number-radius-100: 0.125rem;
+  --onyx-number-radius-200: 0.25rem;
+  --onyx-number-radius-300: 0.5rem;
+  --onyx-number-radius-400: 1rem;
+  --onyx-number-radius-500: 2rem;
+  --onyx-number-radius-600: 62.5rem;
+  --onyx-number-spacing-0: 0rem;
+  --onyx-number-spacing-100: 0.125rem;
+  --onyx-number-spacing-200: 0.25rem;
+  --onyx-number-spacing-250: 0.375rem;
+  --onyx-number-spacing-300: 0.5rem;
+  --onyx-number-spacing-325: 0.625rem;
+  --onyx-number-spacing-350: 0.75rem;
+  --onyx-number-spacing-400: 1rem;
+  --onyx-number-spacing-500: 1.5rem;
+  --onyx-number-spacing-600: 2rem;
+  --onyx-number-spacing-700: 3rem;
+  --onyx-number-spacing-800: 4rem;
+  --onyx-number-spacing-900: 6rem;
+  --onyx-number-spacing-950: 8rem;
+}

package/src/theme.ts

@@ -1,33 +1,40 @@
-import onyxVariables from "sit-onyx/themes/onyx.json";
-import { ONYX_BREAKPOINTS as RAW_ONYX_BREAKPOINTS, type OnyxBreakpoint } from "sit-onyx/types";
-import { create, type ThemeVars, type ThemeVarsPartial } from "storybook/internal/theming";
-import onyxLogo from "./assets/logo-onyx.svg";
+import {
+  ONYX_BREAKPOINTS as RAW_ONYX_BREAKPOINTS,
+  type OnyxBreakpoint,
+} from "@sit-onyx/shared/breakpoints";
+import { create, type ThemeVars } from "storybook/internal/theming";
+
+export type BrandDetails = Pick<ThemeVars, "brandTitle" | "brandImage" | "brandUrl">;
+
+/**
+ * Get the computed value for a CSS custom property.
+ * Per default the property value is taken from the body element.
+ */
+export const getCustomProperty = (property: string, el: Element = document.body) =>
+  getComputedStyle(el).getPropertyValue(property);
 
 /**
  * Creates a custom theme for Storybook that uses onyx colors.
  *
  * @see https://storybook.js.org/docs/react/configure/theming#create-a-theme-quickstart
  */
-export const createTheme = (
-  options?: Pick<ThemeVarsPartial, "base" | "brandTitle" | "brandImage" | "brandUrl">,
-) => {
-  const base = options?.base ?? "light";
-  const primaryColor = onyxVariables["onyx-color-themed-primary-500"];
+export const createTheme = (base: "light" | "dark" = "light", brandDetails?: BrandDetails) => {
+  const primaryColor = getCustomProperty("--onyx-color-base-primary-500");
 
   return create({
-    brandTitle: options?.brandTitle ?? "onyx Storybook",
-    brandUrl: options?.brandUrl ?? "https://onyx.schwarz",
-    brandImage: options?.brandImage ?? onyxLogo,
+    brandTitle: brandDetails?.brandTitle,
+    brandUrl: brandDetails?.brandUrl,
+    brandImage: brandDetails?.brandImage,
     brandTarget: "_blank",
-    base: base,
+    base,
 
     // default theme values that are independent of the light/dark mode:
     colorPrimary: primaryColor,
-    colorSecondary: onyxVariables["onyx-color-themed-secondary-500"],
+    colorSecondary: getCustomProperty("--onyx-color-themed-secondary-500"),
     barSelectedColor: primaryColor,
     barHoverColor: primaryColor,
-    appBorderRadius: remToNumber(onyxVariables["onyx-number-radius-300"]),
-    inputBorderRadius: remToNumber(onyxVariables["onyx-number-radius-200"]),
+    appBorderRadius: remToNumber(getCustomProperty("--onyx-number-radius-300")),
+    inputBorderRadius: remToNumber(getCustomProperty("--onyx-number-radius-200")),
 
     // custom colors depending on light/dark theme
     ...(base === "light" ? getLightTheme() : getDarkTheme()),
@@ -36,21 +43,21 @@ export const createTheme = (
 
 const getLightTheme = (): Partial<ThemeVars> => {
   return defineTheme({
-    background: onyxVariables["onyx-color-universal-grayscale-white"],
-    contentBackground: onyxVariables["onyx-color-themed-neutral-100"],
-    text: onyxVariables["onyx-color-themed-neutral-700"],
-    textMuted: onyxVariables["onyx-color-themed-neutral-600"],
-    border: onyxVariables["onyx-color-themed-neutral-300"],
+    background: getCustomProperty("--onyx-color-universal-grayscale-white"),
+    contentBackground: getCustomProperty("--onyx-color-steel-100"),
+    text: getCustomProperty("--onyx-color-steel-700"),
+    textMuted: getCustomProperty("--onyx-color-steel-600"),
+    border: getCustomProperty("--onyx-color-steel-300"),
   });
 };
 
 const getDarkTheme = (): Partial<ThemeVars> => {
   return defineTheme({
-    background: onyxVariables["onyx-color-themed-neutral-1100"],
-    contentBackground: onyxVariables["onyx-color-themed-neutral-1200"],
-    text: onyxVariables["onyx-color-themed-neutral-200"],
-    textMuted: onyxVariables["onyx-color-themed-neutral-400"],
-    border: onyxVariables["onyx-color-themed-neutral-900"],
+    background: getCustomProperty("--onyx-color-steel-1100"),
+    contentBackground: getCustomProperty("--onyx-color-steel-1200"),
+    text: getCustomProperty("--onyx-color-steel-200"),
+    textMuted: getCustomProperty("--onyx-color-steel-400"),
+    border: getCustomProperty("--onyx-color-steel-900"),
   });
 };
 

package/src/types.ts

@@ -1,52 +1,3 @@
-import type { ComponentPropsAndSlots, Meta } from "@storybook/vue3";
-
-/**
- * Extracts all event names defined by e.g. `defineEmits()` from the given Vue component.
- *
- * @example
- * ```ts
- * import Input from "./Input.vue";
- * type InputEvents = ExtractVueEventNames<typeof Input>; // e.g. "input" | "change"
- * ```
- */
-export type ExtractVueEventNames<VueComponent> =
-  Extract<
-    // extract all props/events of the vue component that are functions
-    ExtractKeysByValueType<
-      // this generic type will extract ALL props and events from the given Vue component
-      ComponentPropsAndSlots<VueComponent>,
-      // emits are declared as functions, so we only take props/events that are functions and ignore the rest
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any -- We must use any here to match the type defined by Vue
-      ((...args: any) => any) | undefined
-    >,
-    // filter out potential function properties by just picking events that start with "on"
-    `on${string}`
-  > extends `on${infer EventName}`
-    ? // until now the extracted event names still start with "on" but we want to have the plain event name
-      // so we will remove the "on" prefix and uncapitalized the first letter so e.g. "onClick" becomes "click"
-      Uncapitalize<EventName>
-    : never;
-
-/**
- * Extracts only the keys from T whose value type satisfies U.
- *
- * @example
- * ```ts
- * type Test = ExtractKeysByValueType<{ a: boolean, b: number, c: boolean }, boolean>
- * // result: "a" | "c"
- * ```
- */
-export type ExtractKeysByValueType<T, U> = { [P in keyof T]: T[P] extends U ? P : never }[keyof T] &
-  keyof T;
-
-/**
- * Options for defining Storybook actions and v-models.
- */
-export type DefineStorybookActionsAndVModelsOptions<T> = Meta<T> & {
-  component: NonNullable<T>;
-  events: ExtractVueEventNames<T>[];
-};
-
 export type StorybookGlobalType<TValue> = {
   name: string;
   description: string;
@@ -55,5 +6,6 @@ export type StorybookGlobalType<TValue> = {
     icon: string;
     items: { value: TValue; right?: string; title: string }[];
     title?: string;
+    dynamicTitle?: boolean;
   };
 };