UNPKG

1.92 kBTypeScriptView Raw
1import { Knob, KnobType, Mutable } from './type-defs';
2import { NumberTypeKnobOptions, ButtonTypeOnClickProp, RadiosTypeOptionsProp, SelectTypeOptionsProp, SelectTypeKnobValue, OptionsTypeKnobValue, OptionsTypeOptionsProp, OptionsTypeKnobSingleValue, OptionsKnobOptions, RadiosTypeKnobValue, ArrayTypeKnobValue } from './components/types';
3export declare function knob<T extends KnobType, V = Mutable<Knob<T>['value']>>(name: string, options: Knob<T>): V;
4export declare function text(name: string, value: string, groupId?: string): string;
5export declare function boolean(name: string, value: boolean, groupId?: string): boolean;
6export declare function number(name: string, value: number, options?: NumberTypeKnobOptions, groupId?: string): number;
7export declare function color(name: string, value: string, groupId?: string): string;
8export declare function object<T>(name: string, value: T, groupId?: string): T;
9export declare function select<T extends SelectTypeKnobValue>(name: string, options: SelectTypeOptionsProp<T>, value: T, groupId?: string): T;
10export declare function radios<T extends RadiosTypeKnobValue>(name: string, options: RadiosTypeOptionsProp<T>, value: T, groupId?: string): T;
11export declare function array(name: string, value: ArrayTypeKnobValue, separator?: string, groupId?: string): string[];
12export declare function date(name: string, value?: Date, groupId?: string): number;
13export declare function button(name: string, callback: ButtonTypeOnClickProp, groupId?: string): undefined;
14export declare function files(name: string, accept: string, value?: string[], groupId?: string): string[];
15export declare function optionsKnob<T extends OptionsTypeKnobSingleValue>(name: string, valuesObj: OptionsTypeOptionsProp<T>, value: OptionsTypeKnobValue<T>, optionsObj: OptionsKnobOptions, groupId?: string): T;
16export declare const withKnobs: (...args: any) => any;
17export * from './shared';