nuance-ui 0.2.7 → 0.2.8

package/dist/runtime/components/tree/_ui/tree-item.vue.d.ts

@@ -1,5 +1,6 @@
 import type { TreeItem } from '../types.js';
 export interface TreeItemProps extends TreeItem {
+    /** Nesting depth, starting at 1 for root items */
     level: number;
 }
 declare const __VLS_export: import("vue").DefineComponent<TreeItemProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<TreeItemProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;

package/dist/runtime/components/tree/_ui/tree-root.d.vue.ts

@@ -2,13 +2,21 @@ import type { ButtonProps } from '@nui/components';
 import type { RovingFocusProps } from '../../roving-focus/roving-focus.vue.js';
 import type { TreeFilter, TreeIconResolver, TreeLoader, TreeModels } from '../types.js';
 export type TreeRootProps = RovingFocusProps & {
+    /** Resolves the icon for a given tree item */
     iconResolver?: TreeIconResolver;
+    /** If set, selected items can be deleted with the Delete key */
     removable?: boolean;
+    /** If set, multiple items can be selected */
     selectable?: boolean;
+    /** Async loader for branch data */
     loadBranch: TreeLoader;
+    /** Filters which items are rendered */
     filter?: TreeFilter;
+    /** Visual variant */
     variant?: ButtonProps['variant'];
+    /** Color from theme */
     color?: ButtonProps['color'];
+    /** Component size */
     size?: ButtonProps['size'];
 };
 type __VLS_Props = TreeRootProps;

package/dist/runtime/components/tree/_ui/tree-root.vue.d.ts

@@ -2,13 +2,21 @@ import type { ButtonProps } from '@nui/components';
 import type { RovingFocusProps } from '../../roving-focus/roving-focus.vue.js';
 import type { TreeFilter, TreeIconResolver, TreeLoader, TreeModels } from '../types.js';
 export type TreeRootProps = RovingFocusProps & {
+    /** Resolves the icon for a given tree item */
     iconResolver?: TreeIconResolver;
+    /** If set, selected items can be deleted with the Delete key */
     removable?: boolean;
+    /** If set, multiple items can be selected */
     selectable?: boolean;
+    /** Async loader for branch data */
     loadBranch: TreeLoader;
+    /** Filters which items are rendered */
     filter?: TreeFilter;
+    /** Visual variant */
     variant?: ButtonProps['variant'];
+    /** Color from theme */
     color?: ButtonProps['color'];
+    /** Component size */
     size?: ButtonProps['size'];
 };
 type __VLS_Props = TreeRootProps;

package/dist/runtime/components/tree/lib/context.d.ts

@@ -4,22 +4,37 @@ import type { TreeFilter, TreeIconResolver, TreeLoader } from '../types.js';
 type EventType = 'select' | 'expand';
 type SelectMode = 'single' | 'multiple' | 'range';
 export interface TreeContext {
+    /** Ref to the root `<ul>` element */
     root: ShallowRef<HTMLUListElement | null>;
+    /** Path of the active (focused) item */
     active: ModelRef<string | null>;
+    /** Paths of selected items */
     selected: ModelRef<string[]>;
+    /** Paths of expanded directory items */
     expanded: ModelRef<string[]>;
+    /** Resolves the icon for a given tree item */
     iconResolver: TreeIconResolver;
+    /** Async loader for branch data */
     loadBranch: TreeLoader;
+    /** Filters which items are rendered */
     filter?: TreeFilter;
+    /** Whether multiple items can be selected */
     selectable: boolean;
+    /** Visual variant */
     variant: ButtonProps['variant'];
+    /** Color from theme */
     color: ButtonProps['color'];
+    /** Component size */
     size: ButtonProps['size'];
 }
 export interface TreeState extends Omit<TreeContext, 'root'> {
+    /** Toggles selection or expansion state of an item */
     toggle: (type: EventType, path: string, mode?: SelectMode) => void;
+    /** Activates selection or expansion for an item */
     on: ((type: 'expand', path: string) => void) & ((type: 'select', path: string, mode?: SelectMode) => void);
+    /** Deactivates selection or expansion for an item */
     off: (type: EventType, path: string) => void;
+    /** Sets the active (focused) item path */
     setActive: (path: string | null) => void;
 }
 export declare const useProvideTreeState: (args_0: TreeContext) => TreeState;

package/dist/runtime/components/tree/types.d.ts

@@ -1,17 +1,25 @@
 import type { NuanceColor } from '@nui/types';
 import type { Ref } from 'vue';
 export interface TreeModels {
+    /** Path of the active (focused) item */
     active: string | null;
+    /** Flat tree data */
     tree: TreeItem[];
+    /** Paths of selected items */
     selected: string[];
+    /** Paths of expanded directory items */
     expanded: string[];
 }
 export interface TreeEmits {
+    /** Fired when selected items are deleted */
     delete: [path: string[]];
 }
 export interface TreeLoaderResult {
+    /** Loaded branch data */
     data: Ref<TreeItem[] | undefined>;
+    /** Whether the branch is loading */
     pending: Ref<boolean>;
+    /** Triggers data fetching */
     execute: () => Promise<unknown>;
 }
 /**
@@ -49,6 +57,7 @@ export interface TreeItem {
      *  @default `file`
      */
     type?: TreeItemType;
+    /** Nested child items */
     children?: TreeItem[];
 }
 export type TreeIconResolver = (type: TreeItemType, name?: string, path?: string, disabled?: boolean) => {

package/dist/runtime/components/visually-hidden/visually-hidden-input.d.vue.ts

@@ -2,7 +2,9 @@ import type { VisuallyHiddenProps } from './visually-hidden.vue.js';
 export interface VisuallyHiddenInputProps extends VisuallyHiddenProps {
     /** Input name */
     name?: string;
+    /** Marks the input as required */
     required?: boolean;
+    /** Disables the input */
     disabled?: boolean;
 }
 declare const __VLS_export: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{

package/dist/runtime/components/visually-hidden/visually-hidden-input.vue

@@ -12,5 +12,5 @@ const value = defineModel({ type: null });
 </script>
 
 <template>
-	<VisuallyHidden v-bind='{ ...props, ...$attrs }' is='input' v-model='value' />
+	<VisuallyHidden v-bind='{ ...props, ...$attrs }' is='input' v-model='value' />
 </template>

package/dist/runtime/components/visually-hidden/visually-hidden-input.vue.d.ts

@@ -2,7 +2,9 @@ import type { VisuallyHiddenProps } from './visually-hidden.vue.js';
 export interface VisuallyHiddenInputProps extends VisuallyHiddenProps {
     /** Input name */
     name?: string;
+    /** Marks the input as required */
     required?: boolean;
+    /** Disables the input */
     disabled?: boolean;
 }
 declare const __VLS_export: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{

package/dist/runtime/components/visually-hidden/visually-hidden.d.vue.ts

@@ -1,5 +1,6 @@
 import type { BoxProps } from '../box.vue.js';
 export interface VisuallyHiddenProps extends BoxProps {
+    /** Controls accessibility behaviour: `'focusable'` adds `aria-hidden`, `'fully-hidden'` removes from tab order */
     feature?: 'focusable' | 'fully-hidden';
 }
 declare var __VLS_8: {};

package/dist/runtime/components/visually-hidden/visually-hidden.vue.d.ts

@@ -1,5 +1,6 @@
 import type { BoxProps } from '../box.vue.js';
 export interface VisuallyHiddenProps extends BoxProps {
+    /** Controls accessibility behaviour: `'focusable'` adds `aria-hidden`, `'fully-hidden'` removes from tab order */
     feature?: 'focusable' | 'fully-hidden';
 }
 declare var __VLS_8: {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nuance-ui",
-	"version": "0.2.7",
+	"version": "0.2.8",
 	"description": "A modern Vue UI library inspired by the best of the React ecosystem.",
 	"repository": {
 		"type": "git",