@rockshin/tao-ui 0.0.10 → 0.0.11

package/dist/docs/components/button.doc.js

@@ -0,0 +1,62 @@
+const buttonDoc = {
+    name: 'button',
+    displayName: 'Button',
+    category: 'General',
+    description: 'Triggers an immediate action such as submitting, saving, or opening a surface.',
+    exports: [
+        'Button'
+    ],
+    source: 'src/components/button/button.tsx',
+    story: 'stories/button.stories.tsx',
+    tests: [
+        'tests/button/button.test.tsx'
+    ],
+    semanticParts: [
+        'root'
+    ],
+    keywords: [
+        'button',
+        'action',
+        'submit',
+        'loading'
+    ],
+    related: [
+        'FormActions',
+        'Modal'
+    ],
+    usage: {
+        description: 'Use Button for explicit actions. It inherits size, disabled, and variant defaults from TaoProvider.',
+        bestPractices: [
+            'Prefer one primary action per view or decision area.',
+            'Use loading when an action is pending.',
+            'Pass a native type when using a button inside a form.'
+        ],
+        avoid: [
+            'Do not use Button for simple navigation when a link is more accurate.'
+        ]
+    },
+    props: [
+        {
+            name: 'variant',
+            type: "'primary' | 'secondary' | 'ghost' | 'destructive'",
+            description: 'Visual emphasis.',
+            defaultValue: "'primary'"
+        },
+        {
+            name: 'size',
+            type: 'TaoSize',
+            description: 'Control size, falling back to TaoProvider.'
+        },
+        {
+            name: 'loading',
+            type: 'boolean',
+            description: 'Disables the button and sets aria-busy.'
+        },
+        {
+            name: 'classNames',
+            type: "SemanticClassNames<'root'>",
+            description: 'Semantic class override.'
+        }
+    ]
+};
+export { buttonDoc };

package/dist/docs/components/checkbox.doc.d.ts

@@ -0,0 +1,23 @@
+export declare const checkboxDoc: {
+    name: string;
+    displayName: string;
+    category: "Data Entry";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+        avoid: string[];
+    };
+    props: {
+        name: string;
+        type: string;
+        description: string;
+    }[];
+};

package/dist/docs/components/checkbox.doc.js

@@ -0,0 +1,60 @@
+const checkboxDoc = {
+    name: 'checkbox',
+    displayName: 'Checkbox',
+    category: 'Data Entry',
+    description: 'Selects one or more independent boolean options.',
+    exports: [
+        'Checkbox',
+        'CheckboxGroup'
+    ],
+    source: 'src/components/checkbox/checkbox.tsx',
+    story: 'stories/checkbox.stories.tsx',
+    tests: [
+        'tests/checkbox/checkbox.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'input',
+        'box',
+        'label',
+        'group',
+        'option'
+    ],
+    keywords: [
+        'checkbox',
+        'boolean',
+        'multi select'
+    ],
+    related: [
+        'Radio',
+        'Switch'
+    ],
+    usage: {
+        description: 'Use Checkbox for independent choices, or CheckboxGroup when users can select multiple options from a set.',
+        bestPractices: [
+            'Use clear labels that describe the checked state.',
+            'Group related options with CheckboxGroup.'
+        ],
+        avoid: [
+            'Do not use CheckboxGroup when only one option may be selected; use RadioGroup instead.'
+        ]
+    },
+    props: [
+        {
+            name: 'checked',
+            type: 'boolean',
+            description: 'Controlled checked state.'
+        },
+        {
+            name: 'options',
+            type: 'CheckboxOptionType[]',
+            description: 'Options for CheckboxGroup.'
+        },
+        {
+            name: 'classNames',
+            type: 'SemanticClassNames<CheckboxSemanticPart>',
+            description: 'Semantic class overrides.'
+        }
+    ]
+};
+export { checkboxDoc };

package/dist/docs/components/collapsible.doc.d.ts

@@ -0,0 +1,18 @@
+export declare const collapsibleDoc: {
+    name: string;
+    displayName: string;
+    category: "Data Display";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+        avoid: string[];
+    };
+};

package/dist/docs/components/collapsible.doc.js

@@ -0,0 +1,39 @@
+const collapsibleDoc = {
+    name: 'collapsible',
+    displayName: 'Collapsible',
+    category: 'Data Display',
+    description: 'Shows and hides a region of content while keeping disclosure state accessible.',
+    exports: [
+        'Collapsible'
+    ],
+    source: 'src/components/collapsible/collapsible.tsx',
+    story: 'stories/collapsible.stories.tsx',
+    tests: [
+        'tests/collapsible/collapsible.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'trigger',
+        'content'
+    ],
+    keywords: [
+        'accordion',
+        'disclosure',
+        'expand'
+    ],
+    related: [
+        'Drawer',
+        'Tabs'
+    ],
+    usage: {
+        description: 'Use Collapsible to hide secondary details while preserving a lightweight page layout.',
+        bestPractices: [
+            'Make the trigger label describe the hidden content.',
+            'Use controlled open state when it must coordinate with other UI.'
+        ],
+        avoid: [
+            'Do not hide required form inputs in a collapsed region without a clear cue.'
+        ]
+    }
+};
+export { collapsibleDoc };

package/dist/docs/components/context-menu.doc.d.ts

@@ -0,0 +1,18 @@
+export declare const contextMenuDoc: {
+    name: string;
+    displayName: string;
+    category: "Navigation";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+        avoid: string[];
+    };
+};

package/dist/docs/components/context-menu.doc.js

@@ -0,0 +1,40 @@
+const contextMenuDoc = {
+    name: 'context-menu',
+    displayName: 'ContextMenu',
+    category: 'Navigation',
+    description: 'Displays contextual actions from a right click or long press interaction.',
+    exports: [
+        'ContextMenu'
+    ],
+    source: 'src/components/context-menu/context-menu.tsx',
+    story: 'stories/context-menu.stories.tsx',
+    tests: [
+        'tests/context-menu/context-menu.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'trigger',
+        'content',
+        'item',
+        'separator'
+    ],
+    keywords: [
+        'menu',
+        'right click',
+        'actions'
+    ],
+    related: [
+        'Dropdown'
+    ],
+    usage: {
+        description: 'Use ContextMenu for secondary actions attached to an object or region.',
+        bestPractices: [
+            'Keep items short and action-oriented.',
+            'Provide another reachable path for critical actions.'
+        ],
+        avoid: [
+            'Do not put primary workflows only inside a context menu.'
+        ]
+    }
+};
+export { contextMenuDoc };

package/dist/docs/components/date-picker.doc.d.ts

@@ -0,0 +1,18 @@
+export declare const datePickerDoc: {
+    name: string;
+    displayName: string;
+    category: "Data Entry";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+        avoid: string[];
+    };
+};

package/dist/docs/components/date-picker.doc.js

@@ -0,0 +1,43 @@
+const datePickerDoc = {
+    name: 'date-picker',
+    displayName: 'DatePicker',
+    category: 'Data Entry',
+    description: 'Lets users enter or choose a single date, with optional time selection.',
+    exports: [
+        'DatePicker'
+    ],
+    source: 'src/components/date-picker/date-picker.tsx',
+    story: 'stories/date-picker.stories.tsx',
+    tests: [
+        'tests/date-picker/date-picker.test.tsx',
+        'tests/date-picker/use-calendar.test.ts'
+    ],
+    semanticParts: [
+        'root',
+        'input',
+        'popup',
+        'calendar',
+        'cell',
+        'footer'
+    ],
+    keywords: [
+        'date',
+        'calendar',
+        'time'
+    ],
+    related: [
+        'RangePicker',
+        'Input'
+    ],
+    usage: {
+        description: 'Use DatePicker when free text date input would be error-prone or when users benefit from calendar context.',
+        bestPractices: [
+            'Support keyboard entry for known dates.',
+            'Use presets for common relative choices when helpful.'
+        ],
+        avoid: [
+            'Do not force calendar navigation for dates far in the past without typed input.'
+        ]
+    }
+};
+export { datePickerDoc };

package/dist/docs/components/drawer.doc.d.ts

@@ -0,0 +1,18 @@
+export declare const drawerDoc: {
+    name: string;
+    displayName: string;
+    category: "Feedback";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+        avoid: string[];
+    };
+};

package/dist/docs/components/drawer.doc.js

@@ -0,0 +1,42 @@
+const drawerDoc = {
+    name: 'drawer',
+    displayName: 'Drawer',
+    category: 'Feedback',
+    description: 'Opens a side panel for related tasks without leaving the current page.',
+    exports: [
+        'Drawer'
+    ],
+    source: 'src/components/drawer/drawer.tsx',
+    story: 'stories/drawer.stories.tsx',
+    tests: [
+        'tests/drawer/drawer.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'overlay',
+        'content',
+        'header',
+        'body',
+        'footer',
+        'close'
+    ],
+    keywords: [
+        'panel',
+        'overlay',
+        'side sheet'
+    ],
+    related: [
+        'Modal'
+    ],
+    usage: {
+        description: 'Use Drawer for inspection, editing, or supporting workflows that should stay connected to the current page.',
+        bestPractices: [
+            'Use a clear title and predictable close affordance.',
+            'Keep destructive confirmations in a dedicated confirmation step.'
+        ],
+        avoid: [
+            'Do not stack multiple drawers for a single workflow.'
+        ]
+    }
+};
+export { drawerDoc };

package/dist/docs/components/dropdown.doc.d.ts

@@ -0,0 +1,18 @@
+export declare const dropdownDoc: {
+    name: string;
+    displayName: string;
+    category: "Navigation";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+        avoid: string[];
+    };
+};

package/dist/docs/components/dropdown.doc.js

@@ -0,0 +1,42 @@
+const dropdownDoc = {
+    name: 'dropdown',
+    displayName: 'Dropdown',
+    category: 'Navigation',
+    description: 'Opens a menu of actions or navigation choices from a trigger.',
+    exports: [
+        'Dropdown'
+    ],
+    source: 'src/components/dropdown/dropdown.tsx',
+    story: 'stories/dropdown.stories.tsx',
+    tests: [
+        'tests/dropdown/dropdown.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'trigger',
+        'content',
+        'item',
+        'group',
+        'divider'
+    ],
+    keywords: [
+        'menu',
+        'actions',
+        'more'
+    ],
+    related: [
+        'ContextMenu',
+        'Select'
+    ],
+    usage: {
+        description: 'Use Dropdown for compact action sets that do not need to stay visible.',
+        bestPractices: [
+            'Order frequent actions first.',
+            'Use destructive styling only for destructive items.'
+        ],
+        avoid: [
+            'Do not use Dropdown as a replacement for visible primary navigation.'
+        ]
+    }
+};
+export { dropdownDoc };

package/dist/docs/components/form-actions.doc.d.ts

@@ -0,0 +1,17 @@
+export declare const formActionsDoc: {
+    name: string;
+    displayName: string;
+    category: "Data Entry";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+    };
+};

package/dist/docs/components/form-actions.doc.js

@@ -0,0 +1,35 @@
+const formActionsDoc = {
+    name: 'form-actions',
+    displayName: 'FormActions',
+    category: 'Data Entry',
+    description: 'Lays out submit, cancel, and secondary actions for forms.',
+    exports: [
+        'FormActions'
+    ],
+    source: 'src/components/form-actions/form-actions.tsx',
+    story: 'stories/form.stories.tsx',
+    tests: [
+        'tests/form-actions/form-actions.test.tsx'
+    ],
+    semanticParts: [
+        'root'
+    ],
+    keywords: [
+        'form',
+        'actions',
+        'submit'
+    ],
+    related: [
+        'Button',
+        'FormField',
+        'FormSection'
+    ],
+    usage: {
+        description: 'Use FormActions at the end of a form or section to align the final actions consistently.',
+        bestPractices: [
+            'Keep action order consistent across forms.',
+            'Use a single submit action unless the workflow truly branches.'
+        ]
+    }
+};
+export { formActionsDoc };

package/dist/docs/components/form-field.doc.d.ts

@@ -0,0 +1,17 @@
+export declare const formFieldDoc: {
+    name: string;
+    displayName: string;
+    category: "Data Entry";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+    };
+};

package/dist/docs/components/form-field.doc.js

@@ -0,0 +1,39 @@
+const formFieldDoc = {
+    name: 'form-field',
+    displayName: 'FormField',
+    category: 'Data Entry',
+    description: 'Associates labels, help text, validation state, and controls.',
+    exports: [
+        'FormField'
+    ],
+    source: 'src/components/form-field/form-field.tsx',
+    story: 'stories/form.stories.tsx',
+    tests: [
+        'tests/form-field/form-field.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'label',
+        'control',
+        "description",
+        'error'
+    ],
+    keywords: [
+        'form',
+        'label',
+        'validation'
+    ],
+    related: [
+        'Input',
+        'Select',
+        'FormSection'
+    ],
+    usage: {
+        description: 'Use FormField to provide accessible labeling and status text around a single control.',
+        bestPractices: [
+            'Connect every input with a visible label.',
+            'Keep validation copy specific and actionable.'
+        ]
+    }
+};
+export { formFieldDoc };

package/dist/docs/components/form-layout.doc.d.ts

@@ -0,0 +1,16 @@
+export declare const formLayoutDoc: {
+    name: string;
+    displayName: string;
+    category: "Layout";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+    };
+};

package/dist/docs/components/form-layout.doc.js

@@ -0,0 +1,31 @@
+const formLayoutDoc = {
+    name: 'form-layout',
+    displayName: 'FormLayout',
+    category: 'Layout',
+    description: 'Arranges form content with consistent label and control alignment.',
+    exports: [
+        'FormLayout'
+    ],
+    source: 'src/layouts/form-layout/form-layout.tsx',
+    story: 'stories/form-layout.stories.tsx',
+    tests: [
+        'tests/layouts/form-layout/form-layout.test.tsx'
+    ],
+    keywords: [
+        'form',
+        'layout',
+        'labels'
+    ],
+    related: [
+        'FormField',
+        'FormSection'
+    ],
+    usage: {
+        description: 'Use FormLayout to keep dense forms aligned and predictable.',
+        bestPractices: [
+            'Use one layout strategy per form.',
+            'Prefer vertical layout on narrow screens.'
+        ]
+    }
+};
+export { formLayoutDoc };

package/dist/docs/components/form-section.doc.d.ts

@@ -0,0 +1,17 @@
+export declare const formSectionDoc: {
+    name: string;
+    displayName: string;
+    category: "Data Entry";
+    description: string;
+    exports: string[];
+    source: string;
+    story: string;
+    tests: string[];
+    semanticParts: string[];
+    keywords: string[];
+    related: string[];
+    usage: {
+        description: string;
+        bestPractices: string[];
+    };
+};

package/dist/docs/components/form-section.doc.js

@@ -0,0 +1,38 @@
+const formSectionDoc = {
+    name: 'form-section',
+    displayName: 'FormSection',
+    category: 'Data Entry',
+    description: "Groups related form fields with a title and optional description.",
+    exports: [
+        'FormSection'
+    ],
+    source: 'src/components/form-section/form-section.tsx',
+    story: 'stories/form.stories.tsx',
+    tests: [
+        'tests/form-section/form-section.test.tsx'
+    ],
+    semanticParts: [
+        'root',
+        'header',
+        'title',
+        "description",
+        'content'
+    ],
+    keywords: [
+        'form',
+        'section',
+        'group'
+    ],
+    related: [
+        'FormField',
+        'FormLayout'
+    ],
+    usage: {
+        description: 'Use FormSection to break long forms into scannable groups.',
+        bestPractices: [
+            'Use headings that describe the group, not the control type.',
+            'Keep each section focused on one user decision area.'
+        ]
+    }
+};
+export { formSectionDoc };