dialkit 1.1.0 → 1.2.0

package/dist/vue/index.d.cts

@@ -0,0 +1,675 @@
+import * as vue from 'vue';
+import { ComputedRef, ObjectDirective, InjectionKey, Ref, PropType, h } from 'vue';
+
+type SpringConfig = {
+    type: 'spring';
+    stiffness?: number;
+    damping?: number;
+    mass?: number;
+    visualDuration?: number;
+    bounce?: number;
+};
+type EasingConfig = {
+    type: 'easing';
+    duration: number;
+    ease: [number, number, number, number];
+};
+type TransitionConfig = SpringConfig | EasingConfig;
+type ActionConfig = {
+    type: 'action';
+    label?: string;
+};
+type SelectConfig = {
+    type: 'select';
+    options: (string | {
+        value: string;
+        label: string;
+    })[];
+    default?: string;
+};
+type ColorConfig = {
+    type: 'color';
+    default?: string;
+};
+type TextConfig = {
+    type: 'text';
+    default?: string;
+    placeholder?: string;
+};
+type DialValue = number | boolean | string | SpringConfig | EasingConfig | ActionConfig | SelectConfig | ColorConfig | TextConfig;
+type DialConfig = {
+    [key: string]: DialValue | [number, number, number, number?] | DialConfig;
+};
+type ResolvedValues<T extends DialConfig> = {
+    [K in keyof T]: T[K] extends [number, number, number, number?] ? number : T[K] extends SpringConfig ? TransitionConfig : T[K] extends EasingConfig ? TransitionConfig : T[K] extends SelectConfig ? string : T[K] extends ColorConfig ? string : T[K] extends TextConfig ? string : T[K] extends DialConfig ? ResolvedValues<T[K]> : T[K];
+};
+type ShortcutMode = 'fine' | 'normal' | 'coarse';
+type ShortcutInteraction = 'scroll' | 'drag' | 'move' | 'scroll-only';
+type ShortcutConfig = {
+    key?: string;
+    modifier?: 'alt' | 'shift' | 'meta';
+    mode?: ShortcutMode;
+    interaction?: ShortcutInteraction;
+};
+type ControlMeta = {
+    type: 'slider' | 'toggle' | 'spring' | 'transition' | 'folder' | 'action' | 'select' | 'color' | 'text';
+    path: string;
+    label: string;
+    min?: number;
+    max?: number;
+    step?: number;
+    children?: ControlMeta[];
+    defaultOpen?: boolean;
+    options?: (string | {
+        value: string;
+        label: string;
+    })[];
+    placeholder?: string;
+    shortcut?: ShortcutConfig;
+};
+type PanelConfig = {
+    id: string;
+    name: string;
+    controls: ControlMeta[];
+    values: Record<string, DialValue>;
+    shortcuts: Record<string, ShortcutConfig>;
+};
+type Listener = () => void;
+type ActionListener = (action: string) => void;
+type Preset = {
+    id: string;
+    name: string;
+    values: Record<string, DialValue>;
+};
+declare class DialStoreClass {
+    private panels;
+    private listeners;
+    private globalListeners;
+    private snapshots;
+    private actionListeners;
+    private presets;
+    private activePreset;
+    private baseValues;
+    registerPanel(id: string, name: string, config: DialConfig, shortcuts?: Record<string, ShortcutConfig>): void;
+    updatePanel(id: string, name: string, config: DialConfig, shortcuts?: Record<string, ShortcutConfig>): void;
+    unregisterPanel(id: string): void;
+    updateValue(panelId: string, path: string, value: DialValue): void;
+    updateSpringMode(panelId: string, path: string, mode: 'simple' | 'advanced'): void;
+    getSpringMode(panelId: string, path: string): 'simple' | 'advanced';
+    updateTransitionMode(panelId: string, path: string, mode: 'easing' | 'simple' | 'advanced'): void;
+    getTransitionMode(panelId: string, path: string): 'easing' | 'simple' | 'advanced';
+    getValue(panelId: string, path: string): DialValue | undefined;
+    getValues(panelId: string): Record<string, DialValue>;
+    getPanels(): PanelConfig[];
+    getPanel(id: string): PanelConfig | undefined;
+    subscribe(panelId: string, listener: Listener): () => void;
+    subscribeGlobal(listener: Listener): () => void;
+    subscribeActions(panelId: string, listener: ActionListener): () => void;
+    triggerAction(panelId: string, path: string): void;
+    savePreset(panelId: string, name: string): string;
+    loadPreset(panelId: string, presetId: string): void;
+    deletePreset(panelId: string, presetId: string): void;
+    getPresets(panelId: string): Preset[];
+    getActivePresetId(panelId: string): string | null;
+    clearActivePreset(panelId: string): void;
+    resolveShortcutTarget(key: string, modifier?: 'alt' | 'shift' | 'meta'): {
+        panelId: string;
+        path: string;
+        control: ControlMeta;
+    } | null;
+    resolveScrollOnlyTargets(): Array<{
+        panelId: string;
+        path: string;
+        control: ControlMeta;
+        shortcut: ShortcutConfig;
+    }>;
+    private findControlByPath;
+    private notify;
+    private notifyGlobal;
+    private initTransitionModes;
+    private parseConfig;
+    private flattenValues;
+    private isSpringConfig;
+    private isEasingConfig;
+    private isActionConfig;
+    private isSelectConfig;
+    private isColorConfig;
+    private isTextConfig;
+    private isHexColor;
+    private formatLabel;
+    private inferRange;
+    private inferStep;
+    private normalizePreservedValue;
+    private roundToStep;
+    private stepPrecision;
+    private mapControlsByPath;
+}
+declare const DialStore: DialStoreClass;
+
+interface UseDialOptions {
+    onAction?: (action: string) => void;
+    shortcuts?: Record<string, ShortcutConfig>;
+}
+declare function useDialKit<T extends DialConfig>(name: string, config: T, options?: UseDialOptions): ComputedRef<ResolvedValues<T>>;
+
+type DialPosition = 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
+type DialMode = 'popover' | 'inline';
+type DialTheme = 'light' | 'dark' | 'system';
+declare const DialRoot: vue.DefineComponent<vue.ExtractPropTypes<{
+    position: {
+        type: () => DialPosition;
+        default: string;
+    };
+    defaultOpen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    mode: {
+        type: () => DialMode;
+        default: string;
+    };
+    theme: {
+        type: () => DialTheme;
+        default: string;
+    };
+    productionEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}> | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    position: {
+        type: () => DialPosition;
+        default: string;
+    };
+    defaultOpen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    mode: {
+        type: () => DialMode;
+        default: string;
+    };
+    theme: {
+        type: () => DialTheme;
+        default: string;
+    };
+    productionEnabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    mode: DialMode;
+    defaultOpen: boolean;
+    position: DialPosition;
+    theme: DialTheme;
+    productionEnabled: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+interface DialKitDirectiveOptions {
+    position?: DialPosition;
+    defaultOpen?: boolean;
+    mode?: DialMode;
+}
+type DialKitDirectiveValue = DialMode | DialKitDirectiveOptions | undefined;
+declare const vDialKit: ObjectDirective<HTMLElement, DialKitDirectiveValue>;
+
+interface ShortcutState {
+    activePanelId: Ref<string | null>;
+    activePath: Ref<string | null>;
+}
+declare const ShortcutKey: InjectionKey<ShortcutState>;
+declare function useShortcutContext(): ShortcutState;
+declare const ShortcutListener: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>[] | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const ShortcutsMenu: vue.DefineComponent<vue.ExtractPropTypes<{
+    panelId: {
+        type: PropType<string>;
+        required: true;
+    };
+}>, () => (vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}> | null)[] | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    panelId: {
+        type: PropType<string>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const Slider: vue.DefineComponent<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: NumberConstructor;
+        required: true;
+    };
+    min: {
+        type: NumberConstructor;
+        required: false;
+    };
+    max: {
+        type: NumberConstructor;
+        required: false;
+    };
+    step: {
+        type: NumberConstructor;
+        required: false;
+    };
+    unit: {
+        type: StringConstructor;
+        required: false;
+    };
+    shortcut: {
+        type: PropType<ShortcutConfig>;
+        default: undefined;
+    };
+    shortcutActive: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: NumberConstructor;
+        required: true;
+    };
+    min: {
+        type: NumberConstructor;
+        required: false;
+    };
+    max: {
+        type: NumberConstructor;
+        required: false;
+    };
+    step: {
+        type: NumberConstructor;
+        required: false;
+    };
+    unit: {
+        type: StringConstructor;
+        required: false;
+    };
+    shortcut: {
+        type: PropType<ShortcutConfig>;
+        default: undefined;
+    };
+    shortcutActive: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {
+    shortcut: ShortcutConfig;
+    shortcutActive: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const Toggle: vue.DefineComponent<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    checked: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    shortcut: {
+        type: PropType<ShortcutConfig>;
+        default: undefined;
+    };
+    shortcutActive: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    checked: {
+        type: BooleanConstructor;
+        required: true;
+    };
+    shortcut: {
+        type: PropType<ShortcutConfig>;
+        default: undefined;
+    };
+    shortcutActive: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {
+    shortcut: ShortcutConfig;
+    shortcutActive: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const Folder: vue.DefineComponent<vue.ExtractPropTypes<{
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+    defaultOpen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isRoot: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    toolbar: {
+        type: PropType<(() => ReturnType<typeof h>) | null>;
+        required: false;
+        default: null;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "openChange"[], "openChange", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    title: {
+        type: StringConstructor;
+        required: true;
+    };
+    defaultOpen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    isRoot: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inline: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    toolbar: {
+        type: PropType<(() => ReturnType<typeof h>) | null>;
+        required: false;
+        default: null;
+    };
+}>> & Readonly<{
+    onOpenChange?: ((...args: any[]) => any) | undefined;
+}>, {
+    defaultOpen: boolean;
+    isRoot: boolean;
+    inline: boolean;
+    toolbar: (() => ReturnType<typeof h>) | null;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+type ButtonGroupButton = {
+    label: string;
+    onClick: () => void;
+};
+declare const ButtonGroup: vue.DefineComponent<vue.ExtractPropTypes<{
+    buttons: {
+        type: PropType<ButtonGroupButton[]>;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    buttons: {
+        type: PropType<ButtonGroupButton[]>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const SpringControl: vue.DefineComponent<vue.ExtractPropTypes<{
+    panelId: {
+        type: StringConstructor;
+        required: true;
+    };
+    path: {
+        type: StringConstructor;
+        required: true;
+    };
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    spring: {
+        type: PropType<SpringConfig>;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    panelId: {
+        type: StringConstructor;
+        required: true;
+    };
+    path: {
+        type: StringConstructor;
+        required: true;
+    };
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    spring: {
+        type: PropType<SpringConfig>;
+        required: true;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const SpringVisualization: vue.DefineComponent<vue.ExtractPropTypes<{
+    spring: {
+        type: PropType<SpringConfig>;
+        required: true;
+    };
+    isSimpleMode: {
+        type: BooleanConstructor;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    spring: {
+        type: PropType<SpringConfig>;
+        required: true;
+    };
+    isSimpleMode: {
+        type: BooleanConstructor;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const TransitionControl: vue.DefineComponent<vue.ExtractPropTypes<{
+    panelId: {
+        type: StringConstructor;
+        required: true;
+    };
+    path: {
+        type: StringConstructor;
+        required: true;
+    };
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: PropType<TransitionConfig>;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    panelId: {
+        type: StringConstructor;
+        required: true;
+    };
+    path: {
+        type: StringConstructor;
+        required: true;
+    };
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: PropType<TransitionConfig>;
+        required: true;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const EasingVisualization: vue.DefineComponent<vue.ExtractPropTypes<{
+    easing: {
+        type: PropType<EasingConfig>;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    easing: {
+        type: PropType<EasingConfig>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const TextControl: vue.DefineComponent<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+    placeholder: {
+        type: StringConstructor;
+        required: false;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+    placeholder: {
+        type: StringConstructor;
+        required: false;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+type SelectOption = string | {
+    value: string;
+    label: string;
+};
+declare const SelectControl: vue.DefineComponent<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+    options: {
+        type: PropType<SelectOption[]>;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+    options: {
+        type: PropType<SelectOption[]>;
+        required: true;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const ColorControl: vue.DefineComponent<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, "change"[], "change", vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    value: {
+        type: StringConstructor;
+        required: true;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+declare const PresetManager: vue.DefineComponent<vue.ExtractPropTypes<{
+    panelId: {
+        type: StringConstructor;
+        required: true;
+    };
+    presets: {
+        type: PropType<Preset[]>;
+        required: true;
+    };
+    activePresetId: {
+        type: PropType<string | null>;
+        required: false;
+        default: null;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    panelId: {
+        type: StringConstructor;
+        required: true;
+    };
+    presets: {
+        type: PropType<Preset[]>;
+        required: true;
+    };
+    activePresetId: {
+        type: PropType<string | null>;
+        required: false;
+        default: null;
+    };
+}>> & Readonly<{}>, {
+    activePresetId: string | null;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+export { type ActionConfig, ButtonGroup, type ColorConfig, ColorControl, type ControlMeta, type DialConfig, type DialKitDirectiveOptions, type DialKitDirectiveValue, type DialMode, type DialPosition, DialRoot, DialStore, type DialTheme, type DialValue, type EasingConfig, EasingVisualization, Folder, type PanelConfig, type Preset, PresetManager, type ResolvedValues, type SelectConfig, SelectControl, type ShortcutConfig, ShortcutKey, ShortcutListener, type ShortcutState, ShortcutsMenu, Slider, type SpringConfig, SpringControl, SpringVisualization, type TextConfig, TextControl, Toggle, type TransitionConfig, TransitionControl, type UseDialOptions, useDialKit, useShortcutContext, vDialKit };