@speckle/ui-components 2.15.1 → 2.15.2-alpha2

package/dist/components/layout/Disclosure.vue.d.ts

@@ -1,35 +1,37 @@
-import type { PropType as __PropType } from 'vue';
 import { ConcreteComponent } from 'vue';
 type DisclosureColor = 'default' | 'danger';
-declare const _sfc_main: import("vue").DefineComponent<{
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    color: {
+        type: import("vue").PropType<DisclosureColor>;
+        default: string;
+    };
     title: {
-        type: __PropType<string>;
+        type: import("vue").PropType<string>;
         required: true;
     };
     icon: {
-        type: __PropType<ConcreteComponent | undefined>;
-        required: false;
+        type: import("vue").PropType<ConcreteComponent>;
     };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     color: {
-        type: __PropType<DisclosureColor | undefined>;
-        required: false;
+        type: import("vue").PropType<DisclosureColor>;
         default: string;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     title: {
-        type: __PropType<string>;
+        type: import("vue").PropType<string>;
         required: true;
     };
     icon: {
-        type: __PropType<ConcreteComponent | undefined>;
-        required: false;
-    };
-    color: {
-        type: __PropType<DisclosureColor | undefined>;
-        required: false;
-        default: string;
+        type: import("vue").PropType<ConcreteComponent>;
     };
 }>>, {
-    color: DisclosureColor | undefined;
+    color: DisclosureColor;
+}, {}>, {
+    default?(_: {}): any;
 }>;
-export default _sfc_main;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/layout/GridListToggle.vue.d.ts

@@ -1,17 +1,17 @@
-import type { PropType as __PropType } from 'vue';
 import { GridListToggleValue } from '../../helpers/layout/components';
-declare const _sfc_main: import("vue").DefineComponent<{
+declare const _default: import("vue").DefineComponent<{
     modelValue: {
-        type: __PropType<GridListToggleValue | undefined>;
-        required: false;
+        type: import("vue").PropType<GridListToggleValue>;
     };
-}, {}, 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<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: (v: MouseEvent) => void;
+    "update:modelValue": (v: GridListToggleValue) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     modelValue: {
-        type: __PropType<GridListToggleValue | undefined>;
-        required: false;
+        type: import("vue").PropType<GridListToggleValue>;
     };
 }>> & {
-    onClick?: ((...args: any[]) => any) | undefined;
-    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
-}, {}>;
-export default _sfc_main;
+    onClick?: ((v: MouseEvent) => any) | undefined;
+    "onUpdate:modelValue"?: ((v: GridListToggleValue) => any) | undefined;
+}, {}, {}>;
+export default _default;

package/dist/components/layout/Menu.vue.d.ts

@@ -1,25 +1,44 @@
-import type { PropType as __PropType } from 'vue';
 import { LayoutMenuItem } from '../../helpers/layout/components';
-declare const _sfc_main: import("vue").DefineComponent<{
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     open: {
-        type: __PropType<boolean | undefined>;
-        required: false;
+        type: import("vue").PropType<boolean>;
     };
     items: {
-        type: __PropType<LayoutMenuItem[][]>;
+        type: import("vue").PropType<LayoutMenuItem[][]>;
         required: true;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:open" | "chosen")[], "update:open" | "chosen", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:open": (val: boolean) => void;
+    chosen: (val: {
+        event: MouseEvent;
+        item: LayoutMenuItem<any>;
+    }) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     open: {
-        type: __PropType<boolean | undefined>;
-        required: false;
+        type: import("vue").PropType<boolean>;
     };
     items: {
-        type: __PropType<LayoutMenuItem[][]>;
+        type: import("vue").PropType<LayoutMenuItem[][]>;
         required: true;
     };
 }>> & {
-    "onUpdate:open"?: ((...args: any[]) => any) | undefined;
-    onChosen?: ((...args: any[]) => any) | undefined;
-}, {}>;
-export default _sfc_main;
+    "onUpdate:open"?: ((val: boolean) => any) | undefined;
+    onChosen?: ((val: {
+        event: MouseEvent;
+        item: LayoutMenuItem<any>;
+    }) => any) | undefined;
+}, {}, {}>, {
+    default?(_: {
+        toggle: () => void | undefined;
+        open: boolean;
+    }): any;
+    item?(_: {
+        item: LayoutMenuItem;
+    }): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/layout/Panel.vue.d.ts

@@ -1,4 +1,4 @@
-declare const _sfc_main: import("vue").DefineComponent<{
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     /**
      * Use a `<form/>` element as a wrapper that will emit 'submit' events out from the component when they occur
      */
@@ -28,7 +28,9 @@ declare const _sfc_main: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "submit"[], "submit", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    submit: (val: SubmitEvent) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /**
      * Use a `<form/>` element as a wrapper that will emit 'submit' events out from the component when they occur
      */
@@ -59,12 +61,21 @@ declare const _sfc_main: import("vue").DefineComponent<{
         default: boolean;
     };
 }>> & {
-    onSubmit?: ((...args: any[]) => any) | undefined;
+    onSubmit?: ((val: SubmitEvent) => any) | undefined;
 }, {
     form: boolean;
     ring: boolean;
     fancyGlow: boolean;
     customPadding: boolean;
     noShadow: boolean;
+}, {}>, {
+    header?(_: {}): any;
+    default?(_: {}): any;
+    footer?(_: {}): any;
 }>;
-export default _sfc_main;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/layout/Tabs.vue.d.ts

@@ -1,14 +1,22 @@
-import type { PropType as __PropType } from 'vue';
 import { LayoutTabItem } from '../../helpers/layout/components';
-declare const _sfc_main: import("vue").DefineComponent<{
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     items: {
-        type: __PropType<LayoutTabItem<any>[]>;
+        type: import("vue").PropType<LayoutTabItem<any>[]>;
         required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     items: {
-        type: __PropType<LayoutTabItem<any>[]>;
+        type: import("vue").PropType<LayoutTabItem<any>[]>;
         required: true;
     };
-}>>, {}>;
-export default _sfc_main;
+}>>, {}, {}>, {
+    default?(_: {
+        activeItem: LayoutTabItem<any>;
+    }): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/composables/common/async.d.ts

@@ -0,0 +1,28 @@
+import { MaybeAsync } from '@speckle/shared';
+import { AsyncComputedOptions } from '@vueuse/core';
+import { ComputedRef } from 'vue';
+export interface AsyncWritableComputedOptions<T> {
+    get: (...args: any[]) => MaybeAsync<T>;
+    set: (value: T) => MaybeAsync<void>;
+    initialState: T;
+    readOptions?: AsyncComputedOptions;
+    asyncRead?: boolean;
+    debugging?: Partial<{
+        log: {
+            name: string;
+            writesOnly?: boolean;
+            readsOnly?: boolean;
+            logger?: (msg: string, ...args: any[]) => void;
+        };
+    }>;
+}
+export type AsyncWritableComputedRef<T> = ComputedRef<T> & {
+    update: AsyncWritableComputedOptions<T>['set'];
+};
+/**
+ * Allows async read/write from/to computed. Use `res.value` to read and `res.update` to write. If you only need
+ * the computed to be read-only then use vueuse's `computedAsync`. If you only need async writes you can
+ * disable async reads through the `asyncRead` param.
+ * @param params
+ */
+export declare function writableAsyncComputed<T>(params: AsyncWritableComputedOptions<T>): AsyncWritableComputedRef<T>;

package/dist/composables/form/input.d.ts

@@ -1,6 +1,20 @@
 import { onKeyDown } from '@vueuse/core';
 import { ModifierKeys } from '../../helpers/form/input';
+import { Ref } from 'vue';
 /**
  * onKeyDown wrapper that also checks for modifier keys being pressed
  */
 export declare function onKeyboardShortcut(modifiers: ModifierKeys[], ...args: Parameters<typeof onKeyDown>): void;
+/**
+ * To support group checkboxes, the checkbox v-model API is a bit confusing: The value is `true` or `undefined`
+ * not `true` or `false`.
+ *
+ * To simplify working with single checkboxes, you can use the model returned from this composable
+ * as the model and `isChecked` as a helpful wrapper that allows you to deal with boolean values only
+ */
+export declare function useFormCheckboxModel(options?: Partial<{
+    model: Ref<true | undefined>;
+}>): {
+    model: Ref<true | undefined>;
+    isChecked: import("vue").WritableComputedRef<boolean>;
+};

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

@@ -1,3 +1,5 @@
+import { ConcreteComponent } from 'vue';
+export type PropComponentType = ConcreteComponent<any, any, any, any, any>;
 export type HorizontalOrVertical = 'horizontal' | 'vertical';
 export interface StepCoreType {
     name: string;

package/dist/helpers/layout/components.d.ts

@@ -10,4 +10,5 @@ export type LayoutMenuItem<I extends string = string> = {
     title: string;
     id: I;
     disabled?: boolean;
+    disabledTooltip?: string;
 };

package/dist/helpers/testing.d.ts

@@ -0,0 +1 @@
+export declare function rightClick(target: HTMLElement): void;

package/dist/lib-utils.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+/// <reference types="webpack-env" />
+/**
+ * Use this to generate an entry for the Tailwind 'content' config key that will ensure
+ * this library is scanned to prevent unnecessary purging
+ * @param {NodeRequire} req Feed in the 'require' object. It needs to be fed in because it may be
+ * unavailable in certain environments and might need to be created manually with 'createRequire'
+ */
+export declare function tailwindContentEntry(req: NodeRequire): string;