storybookjs / addon-knobs

Storybook addon prop editor component

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

addon-knobs select typedef missing Record

oreqizer opened this issue Β· comments

commented

Hi! πŸ‘‹

Firstly, thanks for your work on this project! πŸ™‚

Today I used patch-package to patch @storybook/addon-knobs@6.2.1 for the project I'm working on.

The select knob typedefs are missing an option for including Record types. This fixes the problem

Here is the diff that solved my problem:

diff --git a/node_modules/@storybook/addon-knobs/dist/ts3.9/components/types/Select.d.ts b/node_modules/@storybook/addon-knobs/dist/ts3.9/components/types/Select.d.ts
index 41b5844..60527a4 100644
--- a/node_modules/@storybook/addon-knobs/dist/ts3.9/components/types/Select.d.ts
+++ b/node_modules/@storybook/addon-knobs/dist/ts3.9/components/types/Select.d.ts
@@ -1,6 +1,6 @@
 import { FunctionComponent } from 'react';
 import { KnobControlConfig, KnobControlProps } from './types';
-export declare type SelectTypeKnobValue = string | number | boolean | null | undefined | PropertyKey[];
+export declare type SelectTypeKnobValue = string | number | boolean | null | undefined | PropertyKey[] | Record<string, unknown>;
 export declare type SelectTypeOptionsProp<T extends SelectTypeKnobValue = SelectTypeKnobValue> = Record<PropertyKey, T> | Record<Extract<T, PropertyKey>, T[keyof T]> | T[] | readonly T[];
 export interface SelectTypeKnob<T extends SelectTypeKnobValue = SelectTypeKnobValue> extends KnobControlConfig<T> {
     options: SelectTypeOptionsProp<T>;

This issue body was partially generated by patch-package.

FYI, we’ve released addon-controls in Storybook 6.0. Controls are portable, auto-generated knobs that are intended to replace addon-knobs, which are slated for deprecation.

Please upgrade and try out controls today!