Addon-knobs: select support for enum=like record types

storybookjs · Jul 17, 2019 · d3d6548 · d3d6548
1 parent 0ef6675
commit d3d6548
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/addons/knobs/src/__types__/knob-test-cases.ts b/addons/knobs/src/__types__/knob-test-cases.ts
@@ -86,6 +86,10 @@ enum SomeEnum {
   Type1 = 1,
   Type2,
 }
+enum ButtonVariant {
+  primary = 'primary',
+  secondary = 'secondary',
+}
 const stringLiteralArray: ('Apple' | 'Banana' | 'Grapes')[] = ['Apple', 'Banana', 'Grapes'];
 
 expectKnobOfType<string>(
@@ -101,13 +105,14 @@ expectKnobOfType<string>(
   select('select with string array', ['yes', 'no'], 'yes'),
   select('select with string literal array', stringLiteralArray, stringLiteralArray[0]),
   select('select with readonly array', ['red', 'blue'] as const, 'red'),
+  select<ButtonVariant>('select with string enum options', ButtonVariant, ButtonVariant.primary),
   select('select with null option', { a: 'Option', b: null }, null, groupId)
 );
 
 expectKnobOfType<number>(
   select('select with number options', { 'type a': 1, 'type b': 2 }, 1),
   select<SomeEnum>(
-    'select with enum options',
+    'select with numeric enum options',
     { 'type a': SomeEnum.Type1, 'type b': SomeEnum.Type2 },
     SomeEnum.Type2
   ),

diff --git a/addons/knobs/src/components/types/Select.tsx b/addons/knobs/src/components/types/Select.tsx
@@ -8,6 +8,7 @@ export type SelectTypeKnobValue = string | number | null | undefined;
 
 export type SelectTypeOptionsProp<T extends SelectTypeKnobValue = SelectTypeKnobValue> =
   | Record<string, T>
+  | Record<T, T[keyof T]>
   | T[]
   | readonly T[];