@ac-design/design-system 2.2.1 → 2.4.0

package/dist/lib/components/AcSelect.vue.d.ts

@@ -22,6 +22,8 @@ export interface Props<T> {
     loading?: boolean;
     /** Shows a refresh button that emits `refresh`. */
     refreshable?: boolean;
+    /** With `refreshable`, spins the refresh icon while options reload. Unlike `loading`, the field stays usable. */
+    refreshing?: boolean;
     /** Disables the field. */
     disabled?: boolean;
     /** Marks the field required and adds a red asterisk. */
@@ -30,18 +32,44 @@ export interface Props<T> {
     errorMsg?: string;
     /** Help text between the label and the field. */
     hint?: string;
-    /** `compact` 32px (toolbars and filters), `small` 36px or `normal` 42px tall. */
-    size?: "compact" | "small" | "normal";
+    /** Field height: `xs` 26px, `compact` 32px (toolbars and filters), `xsmall` 34px, `small` 36px, `medium` 38px, `normal` 42px or `large` 50px. Old cloud-ui `size` `xs`, `sm`, `md`, `lg`, `xl` are `xs`, `xsmall`, `medium`, `normal`, `large`. */
+    size?: "xs" | "compact" | "xsmall" | "small" | "medium" | "normal" | "large";
+    /** Field style: `outline` (bordered), `soft` (accent fill, no border) or `ghost` (no fill, no border), e.g. inside a table row. */
+    variant?: "outline" | "soft" | "ghost";
+    /** Draws a primary halo around the field to point the viewer at it. */
+    highlight?: boolean;
+    /** Shows the value but blocks changes: a muted fill, and "(read only)" after the label. Old cloud-ui `is-read-only`. */
+    readonly?: boolean;
+    /** With `required`, shows "This field is required. Please select an option." (with `multiple`, "…at least one option.") when the list closes or the value changes while nothing is selected. It shows instead of `errorMsg`. */
+    validateRequired?: boolean;
+    /** Treats values that aren't in `options` as no selection, so the field shows the placeholder instead of the raw value. */
+    hideUnknownValues?: boolean;
+    /** What a single select writes to `v-model` when the viewer clears it, e.g. `""` for a string field. */
+    emptyValue?: T | null;
+    /** With `multiple`, writes `[]` on mount when `v-model` starts empty (`null`, `undefined` or `""`), so the app always reads an array. */
+    initEmptyArray?: boolean;
+    /** Text shown when the list is empty or nothing matches the search, in place of "No options" and "No results for “text”", e.g. "No options found". */
+    emptyText?: string;
+    /** With `refreshable`, hides the refresh button while the field is disabled instead of showing it greyed out. */
+    hideRefreshWhenDisabled?: boolean;
+    /** With `multiple`, pads the chips like a line of text, so a field with chips is 4–8px taller than the bare field. */
+    looseChips?: boolean;
     /** Text shown when no option matches the search. */
     noResultText?: string;
+    /** Side of the field the list opens on: `bottom` or `top`. It flips to the other side when there isn't room. */
+    placement?: "bottom" | "top";
 }
-declare const __VLS_export: <V>(__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<{
+declare const __VLS_export: <V, M = V | V[] | null>(__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<{
     props: import("vue").PublicProps & __VLS_PrettifyLocal<(Props<V> & {
-        modelValue?: V | V[] | null;
+        modelValue?: M;
+        /** Whether the list is open. Bind `v-model:open` to react when it opens or closes, e.g. to check a required field. */
+        open?: boolean;
     }) & {
         onSearch?: ((query: string) => any) | undefined;
         onSelect?: ((option: SelectOption<V>) => any) | undefined;
-        "onUpdate:modelValue"?: ((value: V | V[] | null) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: M) => any) | undefined;
+        "onUpdate:open"?: ((value: boolean) => any) | undefined;
+        onChange?: ((value: M) => any) | undefined;
         onCreate?: ((text: string) => any) | undefined;
         onRemove?: ((option: SelectOption<V>) => any) | undefined;
         onRefresh?: (() => any) | undefined;
@@ -60,12 +88,24 @@ declare const __VLS_export: <V>(__VLS_props: NonNullable<Awaited<typeof __VLS_se
             selected: boolean;
             active: boolean;
         }) => unknown;
+        /** Content of the closed field for the chosen option in single select, e.g. an icon and a second line. Receives the option; defaults to its label. */
+        selected?: (props: {
+            option: SelectOption<V>;
+        }) => unknown;
         /** Content shown when the list is empty or nothing matches. */
         empty?: (props: {
             query: string;
         }) => unknown;
+        /** One template for an option in the list and in the closed field (single select). `option` and `selected` win over it. Old cloud-ui `custom-options`. */
+        content?: (props: {
+            option: SelectOption<V>;
+        }) => unknown;
+        /** Content before the label text, e.g. an icon. */
+        "label-icon"?: () => unknown;
+        /** Content after the label text, e.g. "(Optional)". */
+        "label-extra"?: () => unknown;
     };
-    emit: (((evt: "search", query: string) => void) & ((evt: "select", option: SelectOption<V>) => void) & ((evt: "create", text: string) => void) & ((evt: "remove", option: SelectOption<V>) => void) & ((evt: "refresh") => void)) & ((event: "update:modelValue", value: V | V[] | null) => void);
+    emit: (((evt: "search", query: string) => void) & ((evt: "select", option: SelectOption<V>) => void) & ((evt: "change", value: M) => void) & ((evt: "create", text: string) => void) & ((evt: "remove", option: SelectOption<V>) => void) & ((evt: "refresh") => void)) & (((event: "update:modelValue", value: M) => void) & ((event: "update:open", value: boolean) => void));
 }>) => import("vue").VNode & {
     __ctx?: NonNullable<Awaited<typeof __VLS_setup>>;
 };