@speckle/ui-components 2.12.666

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

@@ -0,0 +1,256 @@
+import { ConcreteComponent, PropType } from 'vue';
+import { Nullable, Optional } from '@speckle/shared';
+type FormButtonSize = 'xs' | 'sm' | 'base' | 'lg' | 'xl';
+type FormButtonColor = 'default' | 'invert' | 'danger' | 'warning' | 'success' | 'card' | 'secondary';
+declare const _sfc_main: import("vue").DefineComponent<{
+    /**
+     * URL to which to navigate - can be a relative (app) path or an absolute link for an external URL
+     */
+    to: {
+        type: PropType<Optional<string>>;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * Choose from one of many button sizes
+     */
+    size: {
+        type: PropType<FormButtonSize>;
+        default: string;
+    };
+    /**
+     * If set, will make the button take up all available space horizontally
+     */
+    fullWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will outline the button.
+     */
+    outlined: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will apply a rounded class.
+     */
+    rounded: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Similar to "link", but without an underline and possibly in different colors
+     */
+    text: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will remove paddings and background. Use for links.
+     */
+    link: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Colors:
+     * default: the default primary blue.
+     * invert: for when you want to use this button on a primary background.
+     * danger: for dangerous actions (e.g. deletions).
+     * warning: for less dangerous actions (e.g. archival).
+     */
+    color: {
+        type: PropType<FormButtonColor>;
+        default: string;
+    };
+    /**
+     * Whether the target location should be forcefully treated as an external URL
+     * (for relative paths this will likely cause a redirect)
+     */
+    external: {
+        type: PropType<Optional<boolean>>;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * Whether to disable the button so that it can't be pressed
+     */
+    disabled: {
+        type: PropType<Optional<boolean>>;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * If set, will have type set to "submit" to enable it to submit any parent forms
+     */
+    submit: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Add icon to the left from the text
+     */
+    iconLeft: {
+        type: PropType<Nullable<ConcreteComponent>>;
+        default: null;
+    };
+    /**
+     * Add icon to the right from the text
+     */
+    iconRight: {
+        type: PropType<Nullable<ConcreteComponent>>;
+        default: null;
+    };
+    /**
+     * Hide default slot (when you want to show icons only)
+     */
+    hideText: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Customize component to be used when rendering links.
+     *
+     * The component will try to dynamically resolve NuxtLink and RouterLink and use those, if this is set to null.
+     */
+    linkComponent: {
+        type: PropType<Nullable<ConcreteComponent>>;
+        default: null;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * URL to which to navigate - can be a relative (app) path or an absolute link for an external URL
+     */
+    to: {
+        type: PropType<Optional<string>>;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * Choose from one of many button sizes
+     */
+    size: {
+        type: PropType<FormButtonSize>;
+        default: string;
+    };
+    /**
+     * If set, will make the button take up all available space horizontally
+     */
+    fullWidth: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will outline the button.
+     */
+    outlined: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will apply a rounded class.
+     */
+    rounded: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Similar to "link", but without an underline and possibly in different colors
+     */
+    text: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Will remove paddings and background. Use for links.
+     */
+    link: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Colors:
+     * default: the default primary blue.
+     * invert: for when you want to use this button on a primary background.
+     * danger: for dangerous actions (e.g. deletions).
+     * warning: for less dangerous actions (e.g. archival).
+     */
+    color: {
+        type: PropType<FormButtonColor>;
+        default: string;
+    };
+    /**
+     * Whether the target location should be forcefully treated as an external URL
+     * (for relative paths this will likely cause a redirect)
+     */
+    external: {
+        type: PropType<Optional<boolean>>;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * Whether to disable the button so that it can't be pressed
+     */
+    disabled: {
+        type: PropType<Optional<boolean>>;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * If set, will have type set to "submit" to enable it to submit any parent forms
+     */
+    submit: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Add icon to the left from the text
+     */
+    iconLeft: {
+        type: PropType<Nullable<ConcreteComponent>>;
+        default: null;
+    };
+    /**
+     * Add icon to the right from the text
+     */
+    iconRight: {
+        type: PropType<Nullable<ConcreteComponent>>;
+        default: null;
+    };
+    /**
+     * Hide default slot (when you want to show icons only)
+     */
+    hideText: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Customize component to be used when rendering links.
+     *
+     * The component will try to dynamically resolve NuxtLink and RouterLink and use those, if this is set to null.
+     */
+    linkComponent: {
+        type: PropType<Nullable<ConcreteComponent>>;
+        default: null;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+}, {
+    to: Optional<string>;
+    size: FormButtonSize;
+    fullWidth: boolean;
+    outlined: boolean;
+    rounded: boolean;
+    text: boolean;
+    link: boolean;
+    color: FormButtonColor;
+    external: Optional<boolean>;
+    disabled: Optional<boolean>;
+    submit: boolean;
+    iconLeft: Nullable<ConcreteComponent>;
+    iconRight: Nullable<ConcreteComponent>;
+    hideText: boolean;
+    linkComponent: Nullable<ConcreteComponent>;
+}>;
+export default _sfc_main;

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

@@ -0,0 +1,24 @@
+import type { PropType as __PropType } from 'vue';
+declare const _sfc_main: import("vue").DefineComponent<{
+    disabled: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    modelValue: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "update:modelValue")[], "click" | "update:modelValue", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    disabled: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    modelValue: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {}>;
+export default _sfc_main;

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

@@ -0,0 +1,194 @@
+import { RuleExpression } from 'vee-validate';
+import { PropType } from 'vue';
+import { Optional } from '@speckle/shared';
+/**
+ * Troubleshooting:
+ * - If clicking on the checkbox doesn't do anything, check if any of its ancestor elements
+ * have a @click.prevent on them anywhere.
+ * - If you're not using the checkbox in a group, it's suggested that you set :value="true",
+ * so that a v-model attached to the checkbox will be either 'true' or 'undefined' depending on the
+ * checked state
+ */
+type ValueType = Optional<string | true> | string[];
+declare const _sfc_main: import("vue").DefineComponent<{
+    /**
+     * Input name/id. In a checkbox group, all checkboxes must have the same name and different values.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether the input is disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set label text
+     */
+    label: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Help text
+     */
+    description: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Whether to inline the help description
+     */
+    inlineDescription: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * vee-validate validation rules
+     */
+    rules: {
+        type: PropType<RuleExpression<ValueType>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to show the red "required" asterisk
+     */
+    showRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Checkbox group's value
+     */
+    modelValue: {
+        type: PropType<false | ValueType>;
+        default: undefined;
+    };
+    /**
+     * Checkbox's own value. If it is checked, modelValue will include this value (amongst any other checked values from the same group).
+     * If not set will default to 'name' value.
+     */
+    value: {
+        type: PropType<Optional<string | true>>;
+        default: boolean;
+    };
+    /**
+     * HTML ID to use, must be globally unique. If not specified, a random ID will be generated. One is necessary to properly associate the label and checkbox.
+     */
+    id: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    hideLabel: {
+        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<{
+    /**
+     * Input name/id. In a checkbox group, all checkboxes must have the same name and different values.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Whether the input is disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Set label text
+     */
+    label: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Help text
+     */
+    description: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    /**
+     * Whether to inline the help description
+     */
+    inlineDescription: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * vee-validate validation rules
+     */
+    rules: {
+        type: PropType<RuleExpression<ValueType>>;
+        default: undefined;
+    };
+    /**
+     * vee-validate validation() on component mount
+     */
+    validateOnMount: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Whether to show the red "required" asterisk
+     */
+    showRequired: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Checkbox group's value
+     */
+    modelValue: {
+        type: PropType<false | ValueType>;
+        default: undefined;
+    };
+    /**
+     * Checkbox's own value. If it is checked, modelValue will include this value (amongst any other checked values from the same group).
+     * If not set will default to 'name' value.
+     */
+    value: {
+        type: PropType<Optional<string | true>>;
+        default: boolean;
+    };
+    /**
+     * HTML ID to use, must be globally unique. If not specified, a random ID will be generated. One is necessary to properly associate the label and checkbox.
+     */
+    id: {
+        type: PropType<Optional<string>>;
+        default: undefined;
+    };
+    hideLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    disabled: boolean;
+    modelValue: false | ValueType;
+    label: Optional<string>;
+    description: Optional<string>;
+    inlineDescription: boolean;
+    rules: RuleExpression<ValueType>;
+    validateOnMount: boolean;
+    showRequired: boolean;
+    value: Optional<string | true>;
+    id: Optional<string>;
+    hideLabel: boolean;
+}>;
+export default _sfc_main;

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

@@ -0,0 +1,152 @@
+import type { PropType as __PropType } from 'vue';
+import { RuleExpression } from 'vee-validate';
+import { InputColor } from '../../composables/form/textInput';
+declare const _sfc_main: import("vue").DefineComponent<{
+    name: {
+        type: __PropType<string>;
+        required: true;
+    };
+    showLabel: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    help: {
+        type: __PropType<string | undefined>;
+        required: false;
+    };
+    placeholder: {
+        type: __PropType<string | undefined>;
+        required: false;
+    };
+    label: {
+        type: __PropType<string | undefined>;
+        required: false;
+    };
+    disabled: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    rules: {
+        type: __PropType<RuleExpression<string>>;
+        required: false;
+    };
+    validateOnMount: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    validateOnValueUpdate: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    useLabelInErrors: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+        default: boolean;
+    };
+    autoFocus: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    modelValue: {
+        type: __PropType<string | undefined>;
+        required: false;
+        default: string;
+    };
+    showClear: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    fullWidth: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    showRequired: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    color: {
+        type: __PropType<InputColor | undefined>;
+        required: false;
+        default: string;
+    };
+}, {
+    focus: () => void;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "change" | "input" | "clear")[], "update:modelValue" | "change" | "input" | "clear", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    name: {
+        type: __PropType<string>;
+        required: true;
+    };
+    showLabel: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    help: {
+        type: __PropType<string | undefined>;
+        required: false;
+    };
+    placeholder: {
+        type: __PropType<string | undefined>;
+        required: false;
+    };
+    label: {
+        type: __PropType<string | undefined>;
+        required: false;
+    };
+    disabled: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    rules: {
+        type: __PropType<RuleExpression<string>>;
+        required: false;
+    };
+    validateOnMount: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    validateOnValueUpdate: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    useLabelInErrors: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+        default: boolean;
+    };
+    autoFocus: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    modelValue: {
+        type: __PropType<string | undefined>;
+        required: false;
+        default: string;
+    };
+    showClear: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    fullWidth: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    showRequired: {
+        type: __PropType<boolean | undefined>;
+        required: false;
+    };
+    color: {
+        type: __PropType<InputColor | undefined>;
+        required: false;
+        default: string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
+    onInput?: ((...args: any[]) => any) | undefined;
+    onClear?: ((...args: any[]) => any) | undefined;
+}, {
+    color: InputColor | undefined;
+    modelValue: string | undefined;
+    useLabelInErrors: boolean | undefined;
+}>;
+export default _sfc_main;