Merge pull request #75 from Shinigami92/improve-input-type

Improve InputType
ComponentDriven · Mar 14, 2024 · c372cc8 · c372cc8
2 parents cdc80df + 17be521
commit c372cc8
Showing 1 changed file with 120 additions and 3 deletions.
diff --git a/src/story.ts b/src/story.ts
@@ -34,15 +34,129 @@ export interface StrictParameters {
   [name: string]: unknown;
 }
 
+type ControlType =
+  | 'object'
+  | 'boolean'
+  | 'check'
+  | 'inline-check'
+  | 'radio'
+  | 'inline-radio'
+  | 'select'
+  | 'multi-select'
+  | 'number'
+  | 'range'
+  | 'file'
+  | 'color'
+  | 'date'
+  | 'text';
+
 type ConditionalTest = { truthy?: boolean } | { exists: boolean } | { eq: any } | { neq: any };
 type ConditionalValue = { arg: string } | { global: string };
 export type Conditional = ConditionalValue & ConditionalTest;
 export interface InputType {
-  name?: string;
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#control
+   */
+  control?:
+    | ControlType
+    | {
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controltype
+       */
+      type: ControlType;
+    }
+    | {
+      type: 'color';
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controlpresetcolors
+       */
+      presetColors?: string[];
+    }
+    | {
+      type: 'file';
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controlaccept
+       */
+      accept?: string;
+    }
+    | {
+      type: 'inline-check' | 'radio' | 'inline-radio' | 'select' | 'multi-select';
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controllabels
+       */
+      labels?: { [options: string]: string };
+    }
+    | {
+      type: 'number' | 'range';
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controlmax
+       */
+      max?: number;
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controlmin
+       */
+      min?: number;
+      /**
+       * @see https://storybook.js.org/docs/api/arg-types#controlstep
+       */
+      step?: number;
+    }
+    | false;
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#description
+   */
   description?: string;
-  defaultValue?: any;
-  type?: SBType | SBScalarType['name'];
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#if
+   */
   if?: Conditional;
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#mapping
+   */
+  mapping?: { [key: string]: { [option: string]: any } };
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#name
+   */
+  name?: string;
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#options
+   */
+  options?: string[];
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#table
+   */
+  table?: {
+    /**
+     * @see https://storybook.js.org/docs/api/arg-types#tablecategory
+     */
+    category?: string;
+    /**
+     * @see https://storybook.js.org/docs/api/arg-types#tabledefaultvalue
+     */
+    defaultValue?: { summary: string; detail?: string };
+    /**
+     * @see https://storybook.js.org/docs/api/arg-types#tabledisable
+     */
+    disable?: boolean;
+    /**
+     * @see https://storybook.js.org/docs/api/arg-types#tablesubcategory
+     */
+    subcategory?: string;
+    /**
+     * @see https://storybook.js.org/docs/api/arg-types#tabletype
+     */
+    type?: { summary?: string; detail?: string };
+  };
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#type
+   */
+  type?: SBType | SBScalarType['name'];
+  /**
+   * @see https://storybook.js.org/docs/api/arg-types#defaultvalue
+   *
+   * @deprecated Use `table.defaultValue.summary` instead.
+   */
+  defaultValue?: any;
   [key: string]: any;
 }
 
@@ -59,6 +173,9 @@ export interface StrictArgs {
   [name: string]: unknown;
 }
 
+/**
+ * @see https://storybook.js.org/docs/api/arg-types#argtypes
+ */
 export type ArgTypes<TArgs = Args> = { [name in keyof TArgs]: InputType };
 export type StrictArgTypes<TArgs = Args> = { [name in keyof TArgs]: StrictInputType };