@speckle/ui-components 2.12.666

package/dist/components/form/TextInput.vue.d.ts

@@ -0,0 +1,301 @@
+import { RuleExpression } from 'vee-validate';
+import { ConcreteComponent, PropType } from 'vue';
+import { Optional } from '@speckle/shared';
+type InputType = 'text' | 'email' | 'password' | 'url' | 'search';
+type InputSize = 'sm' | 'base' | 'lg' | 'xl';
+type InputColor = 'page' | 'foundation';
+declare const _sfc_main: import("vue").DefineComponent<{
+    /**
+     * Input "type" value (changes behaviour & look)
+     */
+    type: {
+        type: PropType<InputType>;
+        default: string;
+    };
+    /**
+     * Unique ID for the input (must be unique page-wide)
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether to show label (label will always be shown to screen readers)
+     */
+    showLabel: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    /**
+     * Optional help text
+     */
+    help: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Placeholder text
+     */
+    placeholder: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Set label text explicitly
+     */
+    label: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Whether to show the red "required" asterisk
+     */
+    showRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to disable the component, blocking it from user input
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * vee-validate validation rules
+     */
+    rules: {
+        type: PropType<RuleExpression<string>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to trigger validation whenever the value changes
+     */
+    validateOnValueUpdate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will replace the generic "Value" text with the name of the input in error messages
+     */
+    useLabelInErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set a custom icon to use inside the input
+     */
+    customIcon: {
+        type: PropType<Optional<ConcreteComponent>>;
+        default: undefined;
+    };
+    /**
+     * Whether to focus on the input when component is mounted
+     */
+    autoFocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    size: {
+        type: PropType<InputSize>;
+        default: string;
+    };
+    showClear: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fullWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inputClasses: {
+        type: StringConstructor;
+        default: null;
+    };
+    hideErrorMessage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    wrapperClasses: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    color: {
+        type: PropType<InputColor>;
+        default: string;
+    };
+}, {
+    focus: () => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "change" | "input" | "clear" | "focusin" | "focusout")[], "update:modelValue" | "change" | "input" | "clear" | "focusin" | "focusout", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Input "type" value (changes behaviour & look)
+     */
+    type: {
+        type: PropType<InputType>;
+        default: string;
+    };
+    /**
+     * Unique ID for the input (must be unique page-wide)
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether to show label (label will always be shown to screen readers)
+     */
+    showLabel: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    /**
+     * Optional help text
+     */
+    help: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Placeholder text
+     */
+    placeholder: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Set label text explicitly
+     */
+    label: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Whether to show the red "required" asterisk
+     */
+    showRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to disable the component, blocking it from user input
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * vee-validate validation rules
+     */
+    rules: {
+        type: PropType<RuleExpression<string>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to trigger validation whenever the value changes
+     */
+    validateOnValueUpdate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will replace the generic "Value" text with the name of the input in error messages
+     */
+    useLabelInErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set a custom icon to use inside the input
+     */
+    customIcon: {
+        type: PropType<Optional<ConcreteComponent>>;
+        default: undefined;
+    };
+    /**
+     * Whether to focus on the input when component is mounted
+     */
+    autoFocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    size: {
+        type: PropType<InputSize>;
+        default: string;
+    };
+    showClear: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fullWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    inputClasses: {
+        type: StringConstructor;
+        default: null;
+    };
+    hideErrorMessage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    wrapperClasses: {
+        type: StringConstructor;
+        default: () => string;
+    };
+    color: {
+        type: PropType<InputColor>;
+        default: string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
+    onInput?: ((...args: any[]) => any) | undefined;
+    onClear?: ((...args: any[]) => any) | undefined;
+    onFocusin?: ((...args: any[]) => any) | undefined;
+    onFocusout?: ((...args: any[]) => any) | undefined;
+}, {
+    type: InputType;
+    size: InputSize;
+    fullWidth: boolean;
+    color: InputColor;
+    disabled: boolean;
+    modelValue: string;
+    label: Optional<string>;
+    rules: RuleExpression<string>;
+    validateOnMount: boolean;
+    showRequired: boolean;
+    showLabel: boolean;
+    help: Optional<string>;
+    placeholder: Optional<string>;
+    validateOnValueUpdate: boolean;
+    useLabelInErrors: boolean;
+    autoFocus: boolean;
+    showClear: boolean;
+    hideErrorMessage: boolean;
+    customIcon: Optional<ConcreteComponent>;
+    inputClasses: string;
+    wrapperClasses: string;
+}>;
+export default _sfc_main;

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

@@ -0,0 +1,283 @@
+import { PropType } from 'vue';
+import { MaybeAsync, Optional } from '@speckle/shared';
+import { RuleExpression } from 'vee-validate';
+type ButtonStyle = 'base' | 'simple';
+type SingleItem = any;
+declare const _sfc_main: import("vue").DefineComponent<{
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    items: {
+        type: PropType<any[]>;
+        default: () => never[];
+    };
+    modelValue: {
+        type: PropType<any>;
+        default: undefined;
+    };
+    /**
+     * Whether to enable the search bar. You must also set one of the following:
+     * * filterPredicate - to allow filtering passed in `items` based on search bar
+     * * getSearchResults - to allow asynchronously loading items from server (props.items no longer required in this case,
+     *  but can be used to prefill initial values)
+     */
+    search: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If search=true and this is set, you can use this to filter passed in items based on whatever
+     * the user enters in the search bar
+     */
+    filterPredicate: {
+        type: PropType<Optional<(item: SingleItem, searchString: string) => boolean>>;
+        default: undefined;
+    };
+    /**
+     * If search=true and this is set, you can use this to load data asynchronously depending
+     * on the search query
+     */
+    getSearchResults: {
+        type: PropType<Optional<(searchString: string) => MaybeAsync<SingleItem[]>>>;
+        default: undefined;
+    };
+    searchPlaceholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Label is required at the very least for screen-readers
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether to show the label visually
+     */
+    showLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Objects will be compared by the values in the specified prop
+     */
+    by: {
+        type: StringConstructor;
+        required: false;
+    };
+    disabled: {
+        type: PropType<Optional<boolean>>;
+        default: boolean;
+    };
+    buttonStyle: {
+        type: PropType<Optional<ButtonStyle>>;
+        default: string;
+    };
+    hideCheckmarks: {
+        type: PropType<Optional<boolean>>;
+        default: boolean;
+    };
+    allowUnset: {
+        type: PropType<Optional<boolean>>;
+        default: boolean;
+    };
+    clearable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Validation stuff
+     */
+    rules: {
+        type: PropType<RuleExpression<string>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to trigger validation whenever the value changes
+     */
+    validateOnValueUpdate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will replace the generic "Value" text with the name of the input in error messages
+     */
+    useLabelInErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Optional help text
+     */
+    help: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    fixedHeight: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    items: {
+        type: PropType<any[]>;
+        default: () => never[];
+    };
+    modelValue: {
+        type: PropType<any>;
+        default: undefined;
+    };
+    /**
+     * Whether to enable the search bar. You must also set one of the following:
+     * * filterPredicate - to allow filtering passed in `items` based on search bar
+     * * getSearchResults - to allow asynchronously loading items from server (props.items no longer required in this case,
+     *  but can be used to prefill initial values)
+     */
+    search: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * If search=true and this is set, you can use this to filter passed in items based on whatever
+     * the user enters in the search bar
+     */
+    filterPredicate: {
+        type: PropType<Optional<(item: SingleItem, searchString: string) => boolean>>;
+        default: undefined;
+    };
+    /**
+     * If search=true and this is set, you can use this to load data asynchronously depending
+     * on the search query
+     */
+    getSearchResults: {
+        type: PropType<Optional<(searchString: string) => MaybeAsync<SingleItem[]>>>;
+        default: undefined;
+    };
+    searchPlaceholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Label is required at the very least for screen-readers
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether to show the label visually
+     */
+    showLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Objects will be compared by the values in the specified prop
+     */
+    by: {
+        type: StringConstructor;
+        required: false;
+    };
+    disabled: {
+        type: PropType<Optional<boolean>>;
+        default: boolean;
+    };
+    buttonStyle: {
+        type: PropType<Optional<ButtonStyle>>;
+        default: string;
+    };
+    hideCheckmarks: {
+        type: PropType<Optional<boolean>>;
+        default: boolean;
+    };
+    allowUnset: {
+        type: PropType<Optional<boolean>>;
+        default: boolean;
+    };
+    clearable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Validation stuff
+     */
+    rules: {
+        type: PropType<RuleExpression<string>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to trigger validation whenever the value changes
+     */
+    validateOnValueUpdate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will replace the generic "Value" text with the name of the input in error messages
+     */
+    useLabelInErrors: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Optional help text
+     */
+    help: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    fixedHeight: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    disabled: Optional<boolean>;
+    modelValue: any;
+    rules: RuleExpression<string>;
+    validateOnMount: boolean;
+    showLabel: boolean;
+    help: Optional<string>;
+    validateOnValueUpdate: boolean;
+    useLabelInErrors: boolean;
+    search: boolean;
+    multiple: boolean;
+    items: any[];
+    filterPredicate: Optional<(item: SingleItem, searchString: string) => boolean>;
+    getSearchResults: Optional<(searchString: string) => MaybeAsync<SingleItem[]>>;
+    searchPlaceholder: string;
+    buttonStyle: Optional<ButtonStyle>;
+    hideCheckmarks: Optional<boolean>;
+    allowUnset: Optional<boolean>;
+    clearable: boolean;
+    fixedHeight: boolean;
+}>;
+export default _sfc_main;

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

@@ -0,0 +1,126 @@
+import { Optional, SourceAppDefinition } from '@speckle/shared';
+import { PropType } from 'vue';
+type ValueType = SourceAppDefinition | SourceAppDefinition[] | undefined;
+declare const _sfc_main: import("vue").DefineComponent<{
+    /**
+     * Whether to allow selecting multiple source apps
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modelValue: {
+        type: PropType<ValueType>;
+        default: undefined;
+    };
+    /**
+     * Whether to allow filtering source apps through a search box
+     */
+    search: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Search placeholder text
+     */
+    searchPlaceholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    selectorPlaceholder: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Label is required at the very least for screen-readers
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether to show the label visually
+     */
+    showLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Control source apps to show. If left undefined, will show all available options.
+     */
+    items: {
+        type: PropType<Optional<SourceAppDefinition[]>>;
+        default: undefined;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Whether to allow selecting multiple source apps
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modelValue: {
+        type: PropType<ValueType>;
+        default: undefined;
+    };
+    /**
+     * Whether to allow filtering source apps through a search box
+     */
+    search: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Search placeholder text
+     */
+    searchPlaceholder: {
+        type: StringConstructor;
+        default: string;
+    };
+    selectorPlaceholder: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Label is required at the very least for screen-readers
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether to show the label visually
+     */
+    showLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    name: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Control source apps to show. If left undefined, will show all available options.
+     */
+    items: {
+        type: PropType<Optional<SourceAppDefinition[]>>;
+        default: undefined;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    modelValue: ValueType;
+    name: Optional<string>;
+    showLabel: boolean;
+    search: boolean;
+    multiple: boolean;
+    items: Optional<SourceAppDefinition[]>;
+    searchPlaceholder: string;
+    selectorPlaceholder: Optional<string>;
+}>;
+export default _sfc_main;