@ui-sdk/vue 0.0.0-stage → 0.1.0-beta.1

package/dist/listbox.d.ts

@@ -0,0 +1,273 @@
+import { type ListData, type ListboxOptions, type ListboxState } from "@ui-sdk/core/listbox";
+import { type PropType } from "vue";
+import { type RenderableWith, type RootInstanceOf, type RootPropsOf } from "./create-parts.js";
+type ListboxProps<T, Multiple extends boolean | undefined> = ListboxOptions<T, Multiple> & {
+    multiple?: Multiple;
+};
+type ListboxComponent = {
+    new <T = string>(props: RootPropsOf<ListboxProps<T, false>, "div">): RootInstanceOf<ListboxProps<T, false>, ListboxState, "div">;
+    new <T = string>(props: RootPropsOf<ListboxProps<T, true>, "div">): RootInstanceOf<ListboxProps<T, true>, ListboxState, "div">;
+    new <T = string, Multiple extends boolean | undefined = boolean>(props: RootPropsOf<ListboxProps<T, Multiple> & {
+        multiple: Multiple;
+    }, "div">): RootInstanceOf<ListboxProps<T, Multiple>, ListboxState, "div">;
+} & RenderableWith<ListboxProps<any, boolean | undefined>, ListboxState, "div">;
+/**
+ * An always-visible list to choose one option from, or several with `multiple`.
+ * @stable
+ */
+declare const Listbox: ListboxComponent;
+/**
+ * An option. Pressing it selects it, or toggles it with `multiple`.
+ * @stable
+ */
+declare const ListboxItem: new <A extends unknown = string>(props: import("@ui-sdk/core/listbox").ListboxItemProps<A> & {} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & {
+    [x: `data${Capitalize<string>}`]: unknown;
+    contextmenu?: string | undefined | undefined;
+    style?: import("vue").StyleValue;
+    title?: string | undefined | undefined;
+    dir?: string | undefined | undefined;
+    'aria-labelledby'?: string | undefined | undefined;
+    'aria-label'?: string | undefined | undefined;
+    'aria-disabled'?: (boolean | "true" | "false") | undefined;
+    radiogroup?: string | undefined | undefined;
+    'aria-activedescendant'?: string | undefined | undefined;
+    'aria-autocomplete'?: "none" | "inline" | "list" | "both" | undefined | undefined;
+    'aria-checked'?: "mixed" | (boolean | "true" | "false") | undefined;
+    'aria-colcount'?: (string | number) | undefined;
+    'aria-colindex'?: (string | number) | undefined;
+    'aria-colspan'?: (string | number) | undefined;
+    'aria-expanded'?: (boolean | "true" | "false") | undefined;
+    'aria-level'?: (string | number) | undefined;
+    'aria-modal'?: (boolean | "true" | "false") | undefined;
+    'aria-multiline'?: (boolean | "true" | "false") | undefined;
+    'aria-multiselectable'?: (boolean | "true" | "false") | undefined;
+    'aria-orientation'?: "horizontal" | "vertical" | undefined | undefined;
+    'aria-placeholder'?: string | undefined | undefined;
+    'aria-posinset'?: (string | number) | undefined;
+    'aria-pressed'?: "mixed" | (boolean | "true" | "false") | undefined;
+    'aria-readonly'?: (boolean | "true" | "false") | undefined;
+    'aria-required'?: (boolean | "true" | "false") | undefined;
+    'aria-rowcount'?: (string | number) | undefined;
+    'aria-rowindex'?: (string | number) | undefined;
+    'aria-rowspan'?: (string | number) | undefined;
+    'aria-selected'?: (boolean | "true" | "false") | undefined;
+    'aria-setsize'?: (string | number) | undefined;
+    'aria-sort'?: "none" | "ascending" | "descending" | "other" | undefined | undefined;
+    'aria-valuemax'?: (string | number) | undefined;
+    'aria-valuemin'?: (string | number) | undefined;
+    'aria-valuenow'?: (string | number) | undefined;
+    'aria-valuetext'?: string | undefined | undefined;
+    id?: string | undefined | undefined;
+    role?: string | undefined | undefined;
+    tabindex?: (string | number) | undefined;
+    property?: string | undefined | undefined;
+    autocapitalize?: string | undefined | undefined;
+    autocorrect?: string | undefined | undefined;
+    spellcheck?: (boolean | "true" | "false") | undefined;
+    inputmode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined | undefined;
+    enterkeyhint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined | undefined;
+    'aria-controls'?: string | undefined | undefined;
+    'aria-describedby'?: string | undefined | undefined;
+    'aria-details'?: string | undefined | undefined;
+    'aria-errormessage'?: string | undefined | undefined;
+    'aria-flowto'?: string | undefined | undefined;
+    'aria-owns'?: string | undefined | undefined;
+    part?: string | undefined;
+    hidden?: "" | "hidden" | "until-found" | (boolean | "true" | "false") | undefined;
+    'aria-live'?: "off" | "assertive" | "polite" | undefined | undefined;
+    'aria-atomic'?: (boolean | "true" | "false") | undefined;
+    color?: string | undefined | undefined;
+    'aria-hidden'?: (boolean | "true" | "false") | undefined;
+    onChange?: ((payload: Event) => void) | undefined;
+    lang?: string | undefined | undefined;
+    innerHTML?: string | undefined | undefined;
+    onScroll?: ((payload: Event) => void) | undefined;
+    contenteditable?: "inherit" | (boolean | "true" | "false") | "plaintext-only" | undefined;
+    inert?: (boolean | "true" | "false") | undefined;
+    translate?: "yes" | "no" | undefined | undefined;
+    results?: (string | number) | undefined;
+    'aria-busy'?: (boolean | "true" | "false") | undefined;
+    onSubmit?: ((payload: SubmitEvent) => void) | undefined;
+    onBlur?: ((payload: FocusEvent) => void) | undefined;
+    onSelect?: ((payload: Event) => void) | undefined;
+    'aria-keyshortcuts'?: string | undefined | undefined;
+    'aria-haspopup'?: "dialog" | "menu" | "grid" | "listbox" | "tree" | (boolean | "true" | "false") | undefined;
+    draggable?: (boolean | "true" | "false") | undefined;
+    prefix?: string | undefined | undefined;
+    enterKeyHint?: "search" | "done" | "enter" | "go" | "next" | "previous" | "send" | undefined;
+    'aria-current'?: "time" | "date" | "location" | "step" | "page" | (boolean | "true" | "false") | undefined;
+    class?: import("vue").ClassValue;
+    placeholder?: string | undefined | undefined;
+    'aria-invalid'?: (boolean | "true" | "false") | "grammar" | "spelling" | undefined;
+    onError?: ((payload: Event) => void) | undefined;
+    onInput?: ((payload: InputEvent) => void) | undefined;
+    onReset?: ((payload: Event) => void) | undefined;
+    onFullscreenchange?: ((payload: Event) => void) | undefined;
+    onFullscreenerror?: ((payload: Event) => void) | undefined;
+    onAbort?: ((payload: UIEvent) => void) | undefined;
+    onAnimationcancel?: ((payload: AnimationEvent) => void) | undefined;
+    onAnimationend?: ((payload: AnimationEvent) => void) | undefined;
+    onAnimationiteration?: ((payload: AnimationEvent) => void) | undefined;
+    onAnimationstart?: ((payload: AnimationEvent) => void) | undefined;
+    onAuxclick?: ((payload: PointerEvent) => void) | undefined;
+    onBeforeinput?: ((payload: InputEvent) => void) | undefined;
+    onBeforetoggle?: ((payload: ToggleEvent) => void) | undefined;
+    onCanplay?: ((payload: Event) => void) | undefined;
+    onCanplaythrough?: ((payload: Event) => void) | undefined;
+    onClick?: ((payload: PointerEvent) => void) | undefined;
+    onCompositionend?: ((payload: CompositionEvent) => void) | undefined;
+    onCompositionstart?: ((payload: CompositionEvent) => void) | undefined;
+    onCompositionupdate?: ((payload: CompositionEvent) => void) | undefined;
+    onContextmenu?: ((payload: PointerEvent) => void) | undefined;
+    onCopy?: ((payload: ClipboardEvent) => void) | undefined;
+    onCut?: ((payload: ClipboardEvent) => void) | undefined;
+    onDblclick?: ((payload: MouseEvent) => void) | undefined;
+    onDrag?: ((payload: DragEvent) => void) | undefined;
+    onDragend?: ((payload: DragEvent) => void) | undefined;
+    onDragenter?: ((payload: DragEvent) => void) | undefined;
+    onDragleave?: ((payload: DragEvent) => void) | undefined;
+    onDragover?: ((payload: DragEvent) => void) | undefined;
+    onDragstart?: ((payload: DragEvent) => void) | undefined;
+    onDrop?: ((payload: DragEvent) => void) | undefined;
+    onDurationchange?: ((payload: Event) => void) | undefined;
+    onEmptied?: ((payload: Event) => void) | undefined;
+    onEnded?: ((payload: Event) => void) | undefined;
+    onFocus?: ((payload: FocusEvent) => void) | undefined;
+    onFocusin?: ((payload: FocusEvent) => void) | undefined;
+    onFocusout?: ((payload: FocusEvent) => void) | undefined;
+    onFormdata?: ((payload: FormDataEvent) => void) | undefined;
+    onGotpointercapture?: ((payload: PointerEvent) => void) | undefined;
+    onInvalid?: ((payload: Event) => void) | undefined;
+    onKeydown?: ((payload: KeyboardEvent) => void) | undefined;
+    onKeypress?: ((payload: KeyboardEvent) => void) | undefined;
+    onKeyup?: ((payload: KeyboardEvent) => void) | undefined;
+    onLoad?: ((payload: Event) => void) | undefined;
+    onLoadeddata?: ((payload: Event) => void) | undefined;
+    onLoadedmetadata?: ((payload: Event) => void) | undefined;
+    onLoadstart?: ((payload: Event) => void) | undefined;
+    onLostpointercapture?: ((payload: PointerEvent) => void) | undefined;
+    onMousedown?: ((payload: MouseEvent) => void) | undefined;
+    onMouseenter?: ((payload: MouseEvent) => void) | undefined;
+    onMouseleave?: ((payload: MouseEvent) => void) | undefined;
+    onMousemove?: ((payload: MouseEvent) => void) | undefined;
+    onMouseout?: ((payload: MouseEvent) => void) | undefined;
+    onMouseover?: ((payload: MouseEvent) => void) | undefined;
+    onMouseup?: ((payload: MouseEvent) => void) | undefined;
+    onPaste?: ((payload: ClipboardEvent) => void) | undefined;
+    onPause?: ((payload: Event) => void) | undefined;
+    onPlay?: ((payload: Event) => void) | undefined;
+    onPlaying?: ((payload: Event) => void) | undefined;
+    onPointercancel?: ((payload: PointerEvent) => void) | undefined;
+    onPointerdown?: ((payload: PointerEvent) => void) | undefined;
+    onPointerenter?: ((payload: PointerEvent) => void) | undefined;
+    onPointerleave?: ((payload: PointerEvent) => void) | undefined;
+    onPointermove?: ((payload: PointerEvent) => void) | undefined;
+    onPointerout?: ((payload: PointerEvent) => void) | undefined;
+    onPointerover?: ((payload: PointerEvent) => void) | undefined;
+    onPointerup?: ((payload: PointerEvent) => void) | undefined;
+    onProgress?: ((payload: ProgressEvent<EventTarget>) => void) | undefined;
+    onRatechange?: ((payload: Event) => void) | undefined;
+    onScrollend?: ((payload: Event) => void) | undefined;
+    onSecuritypolicyviolation?: ((payload: SecurityPolicyViolationEvent) => void) | undefined;
+    onSeeked?: ((payload: Event) => void) | undefined;
+    onSeeking?: ((payload: Event) => void) | undefined;
+    onStalled?: ((payload: Event) => void) | undefined;
+    onSuspend?: ((payload: Event) => void) | undefined;
+    onTimeupdate?: ((payload: Event) => void) | undefined;
+    onToggle?: ((payload: ToggleEvent) => void) | undefined;
+    onTouchcancel?: ((payload: TouchEvent) => void) | undefined;
+    onTouchend?: ((payload: TouchEvent) => void) | undefined;
+    onTouchmove?: ((payload: TouchEvent) => void) | undefined;
+    onTouchstart?: ((payload: TouchEvent) => void) | undefined;
+    onTransitioncancel?: ((payload: TransitionEvent) => void) | undefined;
+    onTransitionend?: ((payload: TransitionEvent) => void) | undefined;
+    onTransitionrun?: ((payload: TransitionEvent) => void) | undefined;
+    onTransitionstart?: ((payload: TransitionEvent) => void) | undefined;
+    onVolumechange?: ((payload: Event) => void) | undefined;
+    onWaiting?: ((payload: Event) => void) | undefined;
+    onWheel?: ((payload: WheelEvent) => void) | undefined;
+    onDragexit?: ((payload: DragEvent) => void) | undefined;
+    onEncrypted?: ((payload: MediaEncryptedEvent) => void) | undefined;
+    accesskey?: string | undefined | undefined;
+    about?: string | undefined | undefined;
+    datatype?: string | undefined | undefined;
+    inlist?: any;
+    resource?: string | undefined | undefined;
+    typeof?: string | undefined | undefined;
+    vocab?: string | undefined | undefined;
+    autosave?: string | undefined | undefined;
+    itemprop?: string | undefined | undefined;
+    itemscope?: (boolean | "true" | "false") | undefined;
+    itemtype?: string | undefined | undefined;
+    itemid?: string | undefined | undefined;
+    itemref?: string | undefined | undefined;
+    security?: string | undefined | undefined;
+    unselectable?: "on" | "off" | undefined | undefined;
+    is?: string | undefined | undefined;
+    exportparts?: string | undefined;
+    'aria-dropeffect'?: "none" | "copy" | "execute" | "link" | "move" | "popup" | undefined | undefined;
+    'aria-grabbed'?: (boolean | "true" | "false") | undefined;
+    'aria-relevant'?: "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals" | undefined | undefined;
+    'aria-roledescription'?: string | undefined | undefined;
+}) => import("./create-parts.js").ElementInstance<import("vue").DefineSetupFnComponent<Omit<import("@ui-sdk/core/listbox").ListboxItemProps<A>, never>, {} & {}, import("./use-primitive.js").StateSlots<NoInfer<import("@ui-sdk/core/listbox").ListboxItemState>>>, "div">;
+/**
+ * The check inside a selected item. Rendered while it's selected, or always with `keepMounted`.
+ * @stable
+ */
+declare const ListboxItemIndicator: Pick<import("vue").DefineSetupFnComponent<Omit<NoInfer<import("@ui-sdk/core/listbox").ListboxItemIndicatorProps & {
+    item?: string;
+}> & import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<NoInfer<import("@ui-sdk/core/listbox").ListboxItemIndicatorState>>>, never> & import("./create-parts.js").ElementConstructor<import("vue").DefineSetupFnComponent<Omit<NoInfer<import("@ui-sdk/core/listbox").ListboxItemIndicatorProps & {
+    item?: string;
+}> & import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<NoInfer<import("@ui-sdk/core/listbox").ListboxItemIndicatorState>>>, "span">;
+/**
+ * An icon inside an item. Screen readers and typeahead skip it, and `mirror` flips it in right-to-left text.
+ * @stable
+ */
+declare const ListboxItemIcon: Pick<import("vue").DefineSetupFnComponent<Omit<NoInfer<import("@ui-sdk/core/renderer").ItemIconProps & {
+    item?: string;
+}> & import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<NoInfer<{
+    mirror: boolean;
+}>>>, never> & import("./create-parts.js").ElementConstructor<import("vue").DefineSetupFnComponent<Omit<NoInfer<import("@ui-sdk/core/renderer").ItemIconProps & {
+    item?: string;
+}> & import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<NoInfer<{
+    mirror: boolean;
+}>>>, "span">;
+/**
+ * A group of items, named by its `ListboxGroupLabel`.
+ * @stable
+ */
+declare const ListboxGroup: Pick<import("vue").DefineSetupFnComponent<Omit<import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<{}>>, never> & import("./create-parts.js").ElementConstructor<import("vue").DefineSetupFnComponent<Omit<import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<{}>>, "div">;
+/**
+ * The group's heading, which names the group.
+ * @stable
+ */
+declare const ListboxGroupLabel: Pick<import("vue").DefineSetupFnComponent<Omit<NoInfer<{
+    group?: string;
+}> & import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<{}>>, never> & import("./create-parts.js").ElementConstructor<import("vue").DefineSetupFnComponent<Omit<NoInfer<{
+    group?: string;
+}> & import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<{}>>, "div">;
+/**
+ * A line between items or groups, hidden from screen readers.
+ * @stable
+ */
+declare const ListboxSeparator: Pick<import("vue").DefineSetupFnComponent<Omit<import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<{}>>, never> & import("./create-parts.js").ElementConstructor<import("vue").DefineSetupFnComponent<Omit<import("@ui-sdk/core/renderer").BaseSlotProps, never>, {} & {}, import("./use-primitive.js").StateSlots<{}>>, "div">;
+/**
+ * Renders data items. Used by data listboxes, and available for custom layouts.
+ * @stable
+ */
+declare const ListboxItems: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    items: {
+        type: PropType<ListData<unknown>>;
+        required: true;
+    };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    items: {
+        type: PropType<ListData<unknown>>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export { createListboxController } from "@ui-sdk/core/listbox";
+export type { ListData, ListGroup, ListHighlightDetails, ListItem, ListSeparator, ListboxApi, ListboxChangeOptions, ListboxController, ListboxItemIconProps, ListboxItemIconState, ListboxItemIndicatorProps, ListboxItemIndicatorState, ListboxItemProps, ListboxItemState, ListboxOptions, ListboxPrimitive, ListboxState, ListboxValue, ListboxValueChangeReason, } from "@ui-sdk/core/listbox";
+export { Listbox, ListboxGroup, ListboxGroupLabel, ListboxItem, ListboxItemIcon, ListboxItemIndicator, ListboxItems, ListboxSeparator, };

package/dist/listbox.js

@@ -0,0 +1,126 @@
+// src/listbox.ts
+import {
+  listbox as listboxPrimitive
+} from "@ui-sdk/core/listbox";
+import { defineComponent, h } from "vue";
+import { slotContent } from "./children.js";
+import { useFieldControl } from "./field-context.js";
+import { ListItems } from "./list-items.js";
+import {
+  createParts
+} from "./create-parts.js";
+import {
+  optionalBoolean,
+  orModel,
+  useHandle,
+  usePart,
+  usePrimitive
+} from "./use-primitive.js";
+import { FormInputs } from "./form-inputs.js";
+import { readOnlyOf } from "./text-control.js";
+import { createListboxController } from "@ui-sdk/core/listbox";
+var useListbox = () => useHandle(listboxPrimitive);
+var parts = createParts(listboxPrimitive, {
+  item: "div",
+  "item-indicator": "span",
+  "item-icon": "span",
+  group: "div",
+  "group-label": "div",
+  separator: "div"
+});
+var anyValue = { type: null };
+var Listbox = defineComponent({
+  name: "Listbox",
+  inheritAttrs: false,
+  props: {
+    value: anyValue,
+    modelValue: anyValue,
+    defaultValue: anyValue,
+    multiple: optionalBoolean,
+    activation: String,
+    deselectable: optionalBoolean,
+    orientation: String,
+    loop: optionalBoolean,
+    keepInView: optionalBoolean,
+    items: Array,
+    itemToValue: Function,
+    isItemEqualToValue: Function,
+    disabled: optionalBoolean,
+    readOnly: optionalBoolean,
+    required: optionalBoolean,
+    name: String,
+    form: String,
+    controller: Object,
+    debug: optionalBoolean
+  },
+  emits: {
+    "update:value": (_value) => true,
+    "update:modelValue": (_value) => true,
+    valueChange: (_value, _details) => true,
+    highlight: (_value, _details) => true
+  },
+  slots: Object,
+  setup(props, { slots, emit, attrs }) {
+    const field = useFieldControl(attrs);
+    const listbox = usePrimitive(listboxPrimitive, () => ({
+      ...props,
+      value: orModel(props.value, props.modelValue),
+      name: props.name ?? field?.name(),
+      disabled: props.disabled || field?.disabled(),
+      readOnly: readOnlyOf(props, attrs),
+      onValueChange: (value, details) => {
+        emit("valueChange", value, details);
+        if (details.canceled) {
+          return;
+        }
+        emit("update:value", value);
+        emit("update:modelValue", value);
+      },
+      onHighlight: (value, details) => emit("highlight", value, details)
+    }));
+    const root = usePart(listbox, "root", void 0, void 0, {
+      tag: "div",
+      // Without content, a data listbox renders its items.
+      children: (state) => slotContent(slots.default, { state }) ?? (props.items && h(ListboxItems, { items: state.items })),
+      extend: field?.props
+    });
+    return () => [root(), h(FormInputs, { handle: listbox })];
+  }
+});
+var ListboxItem = parts.Item;
+var ListboxItemIndicator = parts.ItemIndicator;
+var ListboxItemIcon = parts.ItemIcon;
+var ListboxGroup = parts.Group;
+var ListboxGroupLabel = parts.GroupLabel;
+var ListboxSeparator = parts.Separator;
+var ListboxItems = defineComponent({
+  name: "ListboxItems",
+  props: {
+    items: { type: Array, required: true }
+  },
+  setup(props) {
+    const listbox = useListbox();
+    return () => h(ListItems, {
+      items: props.items,
+      parts: listParts,
+      keyOf: listbox.api.internal.keyOf
+    });
+  }
+});
+var listParts = {
+  Item: ListboxItem,
+  Group: ListboxGroup,
+  GroupLabel: ListboxGroupLabel,
+  Separator: ListboxSeparator
+};
+export {
+  Listbox,
+  ListboxGroup,
+  ListboxGroupLabel,
+  ListboxItem,
+  ListboxItemIcon,
+  ListboxItemIndicator,
+  ListboxItems,
+  ListboxSeparator,
+  createListboxController
+};