@opencloud-eu/web-pkg 0.1.1 → 1.0.0

package/dist/package/src/components/FilesList/ContextActions.vue.d.ts

@@ -0,0 +1,148 @@
+import { PropType } from 'vue';
+import { FileActionOptions } from '../../composables';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    actionOptions: {
+        type: PropType<FileActionOptions>;
+        required: true;
+    };
+}>, {
+    menuSections: import('vue').ComputedRef<any[]>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    actionOptions: {
+        type: PropType<FileActionOptions>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {
+    ContextActionMenu: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        menuSections: {
+            type: PropType<import('../ContextActions/ContextActionMenu.vue').MenuSection[]>;
+            required: true;
+        };
+        appearance: {
+            type: StringConstructor;
+            default: string;
+        };
+        variation: {
+            type: StringConstructor;
+            default: string;
+        };
+        actionOptions: {
+            type: PropType<import('../..').ActionOptions>;
+            required: true;
+        };
+    }>, {}, {}, {}, {
+        getSectionClasses(index: number): string[];
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        menuSections: {
+            type: PropType<import('../ContextActions/ContextActionMenu.vue').MenuSection[]>;
+            required: true;
+        };
+        appearance: {
+            type: StringConstructor;
+            default: string;
+        };
+        variation: {
+            type: StringConstructor;
+            default: string;
+        };
+        actionOptions: {
+            type: PropType<import('../..').ActionOptions>;
+            required: true;
+        };
+    }>> & Readonly<{}>, {
+        appearance: string;
+        variation: string;
+    }, {}, {
+        ActionMenuItem: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+            action: {
+                type: PropType<import('../..').Action>;
+                required: true;
+            };
+            actionOptions: {
+                type: PropType<import('../..').ActionOptions>;
+                required: true;
+            };
+            size: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            appearance: {
+                type: StringConstructor;
+                default: string;
+            };
+            variation: {
+                type: StringConstructor;
+                default: string;
+            };
+            shortcutHint: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+            showTooltip: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+        }>, {
+            componentType: import('vue').ComputedRef<string>;
+            componentProps: import('vue').ComputedRef<{
+                target: string;
+                href: string;
+                to: import('vue-router').RouteLocationRaw;
+                id: string;
+                disabled: boolean;
+                appearance: string;
+                variation: string;
+            }>;
+            openInNewTabHint: import('vue').ComputedRef<string>;
+        }, {}, {
+            hasExternalImageIcon(): boolean;
+            componentListeners(): {
+                click?: undefined;
+            } | {
+                click: (event: Event) => void;
+            };
+        }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+            action: {
+                type: PropType<import('../..').Action>;
+                required: true;
+            };
+            actionOptions: {
+                type: PropType<import('../..').ActionOptions>;
+                required: true;
+            };
+            size: {
+                type: StringConstructor;
+                required: false;
+                default: string;
+            };
+            appearance: {
+                type: StringConstructor;
+                default: string;
+            };
+            variation: {
+                type: StringConstructor;
+                default: string;
+            };
+            shortcutHint: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+            showTooltip: {
+                type: BooleanConstructor;
+                default: boolean;
+                required: false;
+            };
+        }>> & Readonly<{}>, {
+            size: string;
+            appearance: string;
+            variation: string;
+            shortcutHint: boolean;
+            showTooltip: boolean;
+        }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    }, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/package/src/components/FilesList/ResourceGhostElement.vue.d.ts

@@ -0,0 +1,49 @@
+import { PropType } from 'vue';
+import { Resource } from '@opencloud-eu/web-client';
+/**
+ * Please head to the OpenCloud web ResourceTable component (https://github.com/opencloud-eu/web/blob/main/packages/web-app-files/src/components/FilesList/ResourceTable.vue) for a demo of the Ghost Element.
+ */
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    previewItems: {
+        type: PropType<Resource[]>;
+        required: true;
+    };
+}>, {}, {}, {
+    layerCount(): number;
+    showSecondLayer(): boolean;
+    showThirdLayer(): boolean;
+    itemCount(): number;
+}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    previewItems: {
+        type: PropType<Resource[]>;
+        required: true;
+    };
+}>> & Readonly<{}>, {}, {}, {
+    ResourceIcon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        resource: {
+            type: PropType<Resource>;
+            required: true;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: string) => boolean;
+        };
+    }>, {
+        icon: import('vue').ComputedRef<import('../..').IconType>;
+        iconTypeClass: import('vue').ComputedRef<"oc-resource-icon-space" | "oc-resource-icon-folder" | "oc-resource-icon-file">;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        resource: {
+            type: PropType<Resource>;
+            required: true;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: string) => boolean;
+        };
+    }>> & Readonly<{}>, {
+        size: string;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/package/src/components/FilesList/ResourceIcon.vue.d.ts

@@ -0,0 +1,44 @@
+import { PropType } from 'vue';
+import { Resource } from '@opencloud-eu/web-client';
+import { IconType } from '../../helpers/resource/icon';
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * The resource to be displayed
+     */
+    resource: {
+        type: PropType<Resource>;
+        required: true;
+    };
+    /**
+     * The size of the icon. Defaults to small.
+     * `xsmall, small, medium, large, xlarge, xxlarge`
+     */
+    size: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+}>, {
+    icon: import('vue').ComputedRef<IconType>;
+    iconTypeClass: import('vue').ComputedRef<"oc-resource-icon-space" | "oc-resource-icon-folder" | "oc-resource-icon-file">;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The resource to be displayed
+     */
+    resource: {
+        type: PropType<Resource>;
+        required: true;
+    };
+    /**
+     * The size of the icon. Defaults to small.
+     * `xsmall, small, medium, large, xlarge, xxlarge`
+     */
+    size: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+}>> & Readonly<{}>, {
+    size: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/package/src/components/FilesList/ResourceLink.vue.d.ts

@@ -0,0 +1,78 @@
+import { PropType } from 'vue';
+import { RouteLocationRaw } from 'vue-router';
+/**
+ * Wraps content in a resource link
+ */
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * The resource folder link
+     */
+    link: {
+        type: PropType<RouteLocationRaw>;
+        required: false;
+        default: any;
+    };
+    /**
+     * The resource to be displayed
+     */
+    resource: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Asserts whether clicking on the resource name triggers any action
+     */
+    isResourceClickable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>, {
+    linkTarget: import('vue').ComputedRef<"_blank" | "_self">;
+}, {}, {
+    isNavigatable(): boolean;
+    componentType(): "router-link" | "oc-button";
+    componentProps(): {
+        appearance: string;
+        gapSize: string;
+        justifyContent: string;
+        to?: undefined;
+    } | {
+        to: RouteLocationRaw;
+        appearance?: undefined;
+        gapSize?: undefined;
+        justifyContent?: undefined;
+    };
+}, {
+    emitClick(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "click"[], "click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The resource folder link
+     */
+    link: {
+        type: PropType<RouteLocationRaw>;
+        required: false;
+        default: any;
+    };
+    /**
+     * The resource to be displayed
+     */
+    resource: {
+        type: ObjectConstructor;
+        required: true;
+    };
+    /**
+     * Asserts whether clicking on the resource name triggers any action
+     */
+    isResourceClickable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onClick?: (...args: any[]) => any;
+}>, {
+    link: RouteLocationRaw;
+    isResourceClickable: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/package/src/components/FilesList/ResourceListItem.vue.d.ts

@@ -0,0 +1,384 @@
+import { PropType } from 'vue';
+import { Resource } from '@opencloud-eu/web-client';
+import { RouteLocationRaw } from 'vue-router';
+/**
+ * Displays a resource together with the resource type icon or thumbnail
+ */
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * The resource to be displayed
+     */
+    resource: {
+        type: PropType<Resource>;
+        required: true;
+    };
+    /**
+     * The prefix that will be shown in the path
+     */
+    pathPrefix: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * The resource link
+     */
+    link: {
+        type: PropType<RouteLocationRaw>;
+        required: false;
+        default: any;
+    };
+    /**
+     * Asserts whether the resource path should be displayed
+     */
+    isPathDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * The resource parent folder link path
+     */
+    parentFolderLink: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+     * The resource parent folder name to be displayed
+     */
+    parentFolderName: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * The resource parent folder link path icon additional attributes
+     */
+    parentFolderLinkIconAdditionalAttributes: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => {};
+    };
+    /**
+     * Asserts whether the resource extension should be displayed
+     */
+    isExtensionDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * Asserts whether the resource thumbnail should be displayed
+     */
+    isThumbnailDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * Asserts whether the resource thumbnail should be displayed
+     */
+    isIconDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * Asserts whether clicking on the resource name triggers any action
+     */
+    isResourceClickable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>, {}, {}, {
+    parentFolderComponentType(): "router-link" | "span";
+    parentFolderStyle(): {
+        cursor: string;
+    };
+    parentFolderLinkIconAttrs(): {
+        'fill-type': string;
+        name: string;
+        size: string;
+    };
+    hasThumbnail(): any;
+    thumbnail(): string;
+    tooltipLabelIcon(): string;
+}, {
+    emitClick(): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "click"[], "click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The resource to be displayed
+     */
+    resource: {
+        type: PropType<Resource>;
+        required: true;
+    };
+    /**
+     * The prefix that will be shown in the path
+     */
+    pathPrefix: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * The resource link
+     */
+    link: {
+        type: PropType<RouteLocationRaw>;
+        required: false;
+        default: any;
+    };
+    /**
+     * Asserts whether the resource path should be displayed
+     */
+    isPathDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * The resource parent folder link path
+     */
+    parentFolderLink: {
+        type: ObjectConstructor;
+        required: false;
+        default: any;
+    };
+    /**
+     * The resource parent folder name to be displayed
+     */
+    parentFolderName: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * The resource parent folder link path icon additional attributes
+     */
+    parentFolderLinkIconAdditionalAttributes: {
+        type: ObjectConstructor;
+        required: false;
+        default: () => {};
+    };
+    /**
+     * Asserts whether the resource extension should be displayed
+     */
+    isExtensionDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * Asserts whether the resource thumbnail should be displayed
+     */
+    isThumbnailDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * Asserts whether the resource thumbnail should be displayed
+     */
+    isIconDisplayed: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    /**
+     * Asserts whether clicking on the resource name triggers any action
+     */
+    isResourceClickable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onClick?: (...args: any[]) => any;
+}>, {
+    link: RouteLocationRaw;
+    isResourceClickable: boolean;
+    pathPrefix: string;
+    isPathDisplayed: boolean;
+    isExtensionDisplayed: boolean;
+    parentFolderLink: Record<string, any>;
+    parentFolderName: string;
+    parentFolderLinkIconAdditionalAttributes: Record<string, any>;
+    isThumbnailDisplayed: boolean;
+    isIconDisplayed: boolean;
+}, {}, {
+    ResourceIcon: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        resource: {
+            type: PropType<Resource>;
+            required: true;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: string) => boolean;
+        };
+    }>, {
+        icon: import('vue').ComputedRef<import('../..').IconType>;
+        iconTypeClass: import('vue').ComputedRef<"oc-resource-icon-space" | "oc-resource-icon-folder" | "oc-resource-icon-file">;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        resource: {
+            type: PropType<Resource>;
+            required: true;
+        };
+        size: {
+            type: StringConstructor;
+            default: string;
+            validator: (value: string) => boolean;
+        };
+    }>> & Readonly<{}>, {
+        size: string;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    ResourceLink: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        link: {
+            type: PropType<RouteLocationRaw>;
+            required: false;
+            default: any;
+        };
+        resource: {
+            type: ObjectConstructor;
+            required: true;
+        };
+        isResourceClickable: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>, {
+        linkTarget: import('vue').ComputedRef<"_blank" | "_self">;
+    }, {}, {
+        isNavigatable(): boolean;
+        componentType(): "router-link" | "oc-button";
+        componentProps(): {
+            appearance: string;
+            gapSize: string;
+            justifyContent: string;
+            to?: undefined;
+        } | {
+            to: RouteLocationRaw;
+            appearance?: undefined;
+            gapSize?: undefined;
+            justifyContent?: undefined;
+        };
+    }, {
+        emitClick(): void;
+    }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "click"[], "click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        link: {
+            type: PropType<RouteLocationRaw>;
+            required: false;
+            default: any;
+        };
+        resource: {
+            type: ObjectConstructor;
+            required: true;
+        };
+        isResourceClickable: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>> & Readonly<{
+        onClick?: (...args: any[]) => any;
+    }>, {
+        link: RouteLocationRaw;
+        isResourceClickable: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    ResourceName: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        name: {
+            type: StringConstructor;
+            required: true;
+        };
+        pathPrefix: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        extension: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        type: {
+            type: StringConstructor;
+            required: true;
+        };
+        fullPath: {
+            type: StringConstructor;
+            required: true;
+        };
+        isPathDisplayed: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        isExtensionDisplayed: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        truncateName: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>, {}, {}, {
+        tooltip(): string;
+        fullName(): string;
+        displayName(): string;
+        displayExtension(): string;
+        displayPath(): string;
+        pathTooltip(): string;
+        htmlTitle(): string;
+    }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        name: {
+            type: StringConstructor;
+            required: true;
+        };
+        pathPrefix: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        extension: {
+            type: StringConstructor;
+            required: false;
+            default: string;
+        };
+        type: {
+            type: StringConstructor;
+            required: true;
+        };
+        fullPath: {
+            type: StringConstructor;
+            required: true;
+        };
+        isPathDisplayed: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        isExtensionDisplayed: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+        truncateName: {
+            type: BooleanConstructor;
+            required: false;
+            default: boolean;
+        };
+    }>> & Readonly<{}>, {
+        extension: string;
+        pathPrefix: string;
+        isPathDisplayed: boolean;
+        isExtensionDisplayed: boolean;
+        truncateName: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;