UNPKG

1.22 kBTypeScriptView Raw
1import { ConfiguratorConfig, ConfiguratorHideOption, OptionsConfig } from "vis-util/esnext";
2declare const allOptions: OptionsConfig;
3/**
4 * This provides ranges, initial values, steps and dropdown menu choices for the
5 * configuration.
6 *
7 * @remarks
8 * Checkbox: `boolean`
9 * The value supllied will be used as the initial value.
10 *
11 * Text field: `string`
12 * The passed text will be used as the initial value. Any text will be
13 * accepted afterwards.
14 *
15 * Number range: `[number, number, number, number]`
16 * The meanings are `[initial value, min, max, step]`.
17 *
18 * Dropdown: `[Exclude<string, "color">, ...(string | number | boolean)[]]`
19 * Translations for people with poor understanding of TypeScript: the first
20 * value always has to be a string but never `"color"`, the rest can be any
21 * combination of strings, numbers and booleans.
22 *
23 * Color picker: `["color", string]`
24 * The first value says this will be a color picker not a dropdown menu. The
25 * next value is the initial color.
26 */
27declare const configureOptions: ConfiguratorConfig;
28export declare const configuratorHideOption: ConfiguratorHideOption;
29export { allOptions, configureOptions };
30//# sourceMappingURL=options.d.ts.map
\No newline at end of file