@speckle/ui-components 2.23.5 → 2.23.6

package/README.md

@@ -6,7 +6,7 @@ Speckle UI component library built with Vue 3 and relying on the Speckle Tailwin
 
 1. Make sure you have `@speckle/tailwind-theme` installed and set up with Tailwind
 1. Install `@speckle/ui-components`
-1. In your tailwind config import `tailwindContentEntry` from `@speckle/ui-components/tailwind-configure` and invoke it in the `contents` field to ensure PurgeCSS is configured correctly. It requires the CJS `require` object as its only parameter. If it isn't available (in an ESM environment), you can use node's `createRequire()`.
+1. In your tailwind config import `tailwindContentEntries` from `@speckle/ui-components/tailwind-configure` and invoke it in the `contents` field to ensure PurgeCSS is configured correctly. It requires the CJS `require` object as its only parameter. If it isn't available (in an ESM environment), you can use node's `createRequire()`.
 1. Import `@speckle/ui-components/style.css` in your app. If `exports` map isn't supported you can also import from `@speckle/ui-components/dist/style.css`
 
 ### Usage in Nuxt v3

package/dist/components/form/select/Multi.vue.d.ts

@@ -0,0 +1,191 @@
+import type { PropType } from 'vue';
+import type { MaybeAsync, Optional } from '@speckle/shared';
+import type { RuleExpression } from 'vee-validate';
+import type { LabelPosition } from '../../../composables/form/input';
+declare const _default: <SingleItem extends string | number | Record<string, unknown>>(__VLS_props: {
+    size?: Optional<"sm" | "base" | "lg" | "xl">;
+    readonly label: string;
+    modelValue?: ([{
+        type: PropType<SingleItem | SingleItem[] | undefined>;
+        default: undefined;
+    }] extends [import("vue").Prop<infer V, infer D>] ? unknown extends V ? import("@vue/shared").IfAny<V, V, D> : V : {
+        type: PropType<SingleItem | SingleItem[] | undefined>;
+        default: undefined;
+    }) | undefined;
+    "onUpdate:modelValue"?: ((v: SingleItem | SingleItem[] | undefined) => any) | undefined;
+    readonly name: string;
+    disabled?: Optional<boolean>;
+    rules?: RuleExpression<SingleItem | SingleItem[] | undefined>;
+    validateOnMount?: boolean | undefined;
+    showRequired?: boolean | undefined;
+    labelPosition?: LabelPosition | undefined;
+    validateOnValueUpdate?: boolean | undefined;
+    search?: boolean | undefined;
+    help?: Optional<string>;
+    showLabel?: boolean | undefined;
+    useLabelInErrors?: boolean | undefined;
+    readonly placeholder?: string | undefined;
+    showOptional?: boolean | undefined;
+    tooltipText?: string | undefined;
+    items?: SingleItem[] | undefined;
+    filterPredicate?: Optional<(item: SingleItem, searchString: string) => boolean>;
+    disabledItemPredicate?: Optional<(item: SingleItem) => boolean>;
+    getSearchResults?: Optional<(searchString: string) => MaybeAsync<SingleItem[]>>;
+    searchPlaceholder?: string | undefined;
+    readonly by?: string | undefined;
+    buttonStyle?: Optional<"base" | "simple" | "tinted">;
+    hideCheckmarks?: Optional<boolean>;
+    allowUnset?: Optional<boolean>;
+    clearable?: boolean | undefined;
+    fixedHeight?: boolean | undefined;
+    fullyControlValue?: boolean | undefined;
+    mountMenuOnBody?: boolean | undefined;
+    labelId?: string | undefined;
+    buttonId?: string | undefined;
+    readonly disabledItemTooltip?: string | undefined;
+} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
+    attrs: any;
+    slots: {
+        "nothing-selected"?(_: {}): any;
+        "something-selected"?(_: {
+            value: SingleItem[];
+        }): any;
+        "nothing-found"?(_: {}): any;
+        option?(_: {
+            class: string;
+            item: SingleItem;
+            selected: boolean;
+            disabled: boolean;
+        }): any;
+    };
+    emit: (e: 'update:modelValue', v: SingleItem | SingleItem[] | undefined) => void;
+} | undefined, __VLS_expose?: ((exposed: import("vue").ShallowUnwrapRef<{
+    triggerSearch: () => Promise<void>;
+}>) => void) | undefined, __VLS_setup?: Promise<{
+    props: {
+        size?: Optional<"sm" | "base" | "lg" | "xl">;
+        readonly label: string;
+        modelValue?: ([{
+            type: PropType<SingleItem | SingleItem[] | undefined>;
+            default: undefined;
+        }] extends [import("vue").Prop<infer V, infer D>] ? unknown extends V ? import("@vue/shared").IfAny<V, V, D> : V : {
+            type: PropType<SingleItem | SingleItem[] | undefined>;
+            default: undefined;
+        }) | undefined;
+        "onUpdate:modelValue"?: ((v: SingleItem | SingleItem[] | undefined) => any) | undefined;
+        readonly name: string;
+        disabled?: Optional<boolean>;
+        rules?: RuleExpression<SingleItem | SingleItem[] | undefined>;
+        validateOnMount?: boolean | undefined;
+        showRequired?: boolean | undefined;
+        labelPosition?: LabelPosition | undefined;
+        validateOnValueUpdate?: boolean | undefined;
+        search?: boolean | undefined;
+        help?: Optional<string>;
+        showLabel?: boolean | undefined;
+        useLabelInErrors?: boolean | undefined;
+        readonly placeholder?: string | undefined;
+        showOptional?: boolean | undefined;
+        tooltipText?: string | undefined;
+        items?: SingleItem[] | undefined;
+        filterPredicate?: Optional<(item: SingleItem, searchString: string) => boolean>;
+        disabledItemPredicate?: Optional<(item: SingleItem) => boolean>;
+        getSearchResults?: Optional<(searchString: string) => MaybeAsync<SingleItem[]>>;
+        searchPlaceholder?: string | undefined;
+        readonly by?: string | undefined;
+        buttonStyle?: Optional<"base" | "simple" | "tinted">;
+        hideCheckmarks?: Optional<boolean>;
+        allowUnset?: Optional<boolean>;
+        clearable?: boolean | undefined;
+        fixedHeight?: boolean | undefined;
+        fullyControlValue?: boolean | undefined;
+        mountMenuOnBody?: boolean | undefined;
+        labelId?: string | undefined;
+        buttonId?: string | undefined;
+        readonly disabledItemTooltip?: string | undefined;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
+    expose(exposed: import("vue").ShallowUnwrapRef<{
+        triggerSearch: () => Promise<void>;
+    }>): void;
+    attrs: any;
+    slots: {
+        "nothing-selected"?(_: {}): any;
+        "something-selected"?(_: {
+            value: SingleItem[];
+        }): any;
+        "nothing-found"?(_: {}): any;
+        option?(_: {
+            class: string;
+            item: SingleItem;
+            selected: boolean;
+            disabled: boolean;
+        }): any;
+    };
+    emit: (e: 'update:modelValue', v: SingleItem | SingleItem[] | undefined) => void;
+}>) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}> & {
+    __ctx?: {
+        props: {
+            size?: Optional<"sm" | "base" | "lg" | "xl">;
+            readonly label: string;
+            modelValue?: ([{
+                type: PropType<SingleItem | SingleItem[] | undefined>;
+                default: undefined;
+            }] extends [import("vue").Prop<infer V, infer D>] ? unknown extends V ? import("@vue/shared").IfAny<V, V, D> : V : {
+                type: PropType<SingleItem | SingleItem[] | undefined>;
+                default: undefined;
+            }) | undefined;
+            "onUpdate:modelValue"?: ((v: SingleItem | SingleItem[] | undefined) => any) | undefined;
+            readonly name: string;
+            disabled?: Optional<boolean>;
+            rules?: RuleExpression<SingleItem | SingleItem[] | undefined>;
+            validateOnMount?: boolean | undefined;
+            showRequired?: boolean | undefined;
+            labelPosition?: LabelPosition | undefined;
+            validateOnValueUpdate?: boolean | undefined;
+            search?: boolean | undefined;
+            help?: Optional<string>;
+            showLabel?: boolean | undefined;
+            useLabelInErrors?: boolean | undefined;
+            readonly placeholder?: string | undefined;
+            showOptional?: boolean | undefined;
+            tooltipText?: string | undefined;
+            items?: SingleItem[] | undefined;
+            filterPredicate?: Optional<(item: SingleItem, searchString: string) => boolean>;
+            disabledItemPredicate?: Optional<(item: SingleItem) => boolean>;
+            getSearchResults?: Optional<(searchString: string) => MaybeAsync<SingleItem[]>>;
+            searchPlaceholder?: string | undefined;
+            readonly by?: string | undefined;
+            buttonStyle?: Optional<"base" | "simple" | "tinted">;
+            hideCheckmarks?: Optional<boolean>;
+            allowUnset?: Optional<boolean>;
+            clearable?: boolean | undefined;
+            fixedHeight?: boolean | undefined;
+            fullyControlValue?: boolean | undefined;
+            mountMenuOnBody?: boolean | undefined;
+            labelId?: string | undefined;
+            buttonId?: string | undefined;
+            readonly disabledItemTooltip?: string | undefined;
+        } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
+        expose(exposed: import("vue").ShallowUnwrapRef<{
+            triggerSearch: () => Promise<void>;
+        }>): void;
+        attrs: any;
+        slots: {
+            "nothing-selected"?(_: {}): any;
+            "something-selected"?(_: {
+                value: SingleItem[];
+            }): any;
+            "nothing-found"?(_: {}): any;
+            option?(_: {
+                class: string;
+                item: SingleItem;
+                selected: boolean;
+                disabled: boolean;
+            }): any;
+        };
+        emit: (e: 'update:modelValue', v: SingleItem | SingleItem[] | undefined) => void;
+    } | undefined;
+};
+export default _default;

package/dist/helpers/common/validation.d.ts

@@ -27,3 +27,4 @@ export declare const stringContains: (params: {
 }) => GenericValidateFunction<string>;
 export declare const isUrl: GenericValidateFunction<string>;
 export declare const isItemSelected: GenericValidateFunction<unknown[]>;
+export declare const isMultiItemSelected: <T>(val: unknown) => true | string;