@nextcloud/vue 9.0.0-alpha.3 → 9.0.0-alpha.5

package/dist/components/NcDialog/NcDialog.vue.d.ts

@@ -1,2 +1,360 @@
-declare const _default: import('vue').DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, import('vue').PublicProps>;
+import { PropType } from 'vue';
+import { ComponentProps } from '../../utils/VueTypes.ts';
+import { default as NcDialogButton } from '../NcDialogButton/index.js';
+
+type NcDialogButtonProps = ComponentProps<typeof NcDialogButton>;
+declare const _default: import('vue').DefineComponent<{
+    /** Name of the dialog (the heading) */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Text of the dialog */
+    message: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Additional elements to add to the focus trap */
+    additionalTrapElements: {
+        type: PropType<(string | HTMLElement)[]>;
+        validator: (arr: unknown) => arr is (string | HTMLElement)[];
+        default: () => never[];
+    };
+    /**
+     * The element where to mount the dialog, if `null` is passed the dialog is mounted in place
+     * @default 'body'
+     */
+    container: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * Whether the dialog should be shown
+     * @default true
+     */
+    open: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Size of the underlying NcModal
+     * @default 'small'
+     * @type {'small'|'normal'|'large'|'full'}
+     */
+    size: {
+        type: PropType<"small" | "normal" | "large" | "full">;
+        required: false;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * Buttons to display
+     * @default []
+     */
+    buttons: {
+        type: PropType<NcDialogButtonProps[]>;
+        required: false;
+        default: () => never[];
+        validator(value: unknown[]): value is (object | null)[];
+    };
+    /**
+     * Set to false to no show a close button on the dialog
+     * @default true
+     */
+    canClose: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Close the dialog if the user clicked outside of the dialog
+     * Only relevant if `canClose` is set to true.
+     */
+    closeOnClickOutside: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Declare if hiding the modal should be animated
+     * @default false
+     */
+    outTransition: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Optionally pass additionaly classes which will be set on the navigation for custom styling
+     * @default ''
+     * @example
+     * ```html
+     * <DialogBase :navigation-classes="['mydialog-navigation']"><!-- --></DialogBase>
+     * <!-- ... -->
+     * <style lang="scss">
+     * :deep(.mydialog-navigation) {
+     *     flex-direction: row-reverse;
+     * }
+     * </style>
+     * ```
+     */
+    navigationClasses: {
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: string;
+    };
+    /**
+     * aria-label for the dialog navigation.
+     * Use it when you want to provide a more meaningful label than the dialog name.
+     *
+     * By default, navigation is labeled by the dialog name.
+     */
+    navigationAriaLabel: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * aria-labelledby for the dialog navigation.
+     * Use it when you have an implicit navigation label (e.g. a heading).
+     *
+     * By default, navigation is labeled by the dialog name.
+     */
+    navigationAriaLabelledby: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * Optionally pass additionaly classes which will be set on the content wrapper for custom styling
+     * @default ''
+     */
+    contentClasses: {
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: string;
+    };
+    /**
+     * Optionally pass additionaly classes which will be set on the dialog itself
+     * (the default `class` attribute will be set on the modal wrapper)
+     * @default ''
+     */
+    dialogClasses: {
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: string;
+    };
+}, {
+    handleButtonClose: () => void;
+    handleClosing: () => void;
+    handleClosed: () => void;
+    hasNavigation: import('vue').ComputedRef<boolean>;
+    navigationId: string;
+    navigationAriaLabelAttr: import('vue').ComputedRef<string | undefined>;
+    navigationAriaLabelledbyAttr: import('vue').ComputedRef<string | undefined>;
+    isNavigationCollapsed: import('vue').ComputedRef<boolean>;
+    modalProps: import('vue').ComputedRef<{
+        canClose: boolean;
+        container: string;
+        labelId: string;
+        size: "normal" | "small" | "large" | "full";
+        show: boolean;
+        outTransition: boolean;
+        closeOnClickOutside: boolean;
+        additionalTrapElements: (string | HTMLElement)[];
+    }>;
+    wrapper: import('vue').Ref<HTMLDivElement | undefined>;
+}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("update:open" | "closing")[], "update:open" | "closing", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /** Name of the dialog (the heading) */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /** Text of the dialog */
+    message: {
+        type: StringConstructor;
+        default: string;
+    };
+    /** Additional elements to add to the focus trap */
+    additionalTrapElements: {
+        type: PropType<(string | HTMLElement)[]>;
+        validator: (arr: unknown) => arr is (string | HTMLElement)[];
+        default: () => never[];
+    };
+    /**
+     * The element where to mount the dialog, if `null` is passed the dialog is mounted in place
+     * @default 'body'
+     */
+    container: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * Whether the dialog should be shown
+     * @default true
+     */
+    open: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Size of the underlying NcModal
+     * @default 'small'
+     * @type {'small'|'normal'|'large'|'full'}
+     */
+    size: {
+        type: PropType<"small" | "normal" | "large" | "full">;
+        required: false;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * Buttons to display
+     * @default []
+     */
+    buttons: {
+        type: PropType<NcDialogButtonProps[]>;
+        required: false;
+        default: () => never[];
+        validator(value: unknown[]): value is (object | null)[];
+    };
+    /**
+     * Set to false to no show a close button on the dialog
+     * @default true
+     */
+    canClose: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Close the dialog if the user clicked outside of the dialog
+     * Only relevant if `canClose` is set to true.
+     */
+    closeOnClickOutside: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Declare if hiding the modal should be animated
+     * @default false
+     */
+    outTransition: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Optionally pass additionaly classes which will be set on the navigation for custom styling
+     * @default ''
+     * @example
+     * ```html
+     * <DialogBase :navigation-classes="['mydialog-navigation']"><!-- --></DialogBase>
+     * <!-- ... -->
+     * <style lang="scss">
+     * :deep(.mydialog-navigation) {
+     *     flex-direction: row-reverse;
+     * }
+     * </style>
+     * ```
+     */
+    navigationClasses: {
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: string;
+    };
+    /**
+     * aria-label for the dialog navigation.
+     * Use it when you want to provide a more meaningful label than the dialog name.
+     *
+     * By default, navigation is labeled by the dialog name.
+     */
+    navigationAriaLabel: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * aria-labelledby for the dialog navigation.
+     * Use it when you have an implicit navigation label (e.g. a heading).
+     *
+     * By default, navigation is labeled by the dialog name.
+     */
+    navigationAriaLabelledby: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    /**
+     * Optionally pass additionaly classes which will be set on the content wrapper for custom styling
+     * @default ''
+     */
+    contentClasses: {
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: string;
+    };
+    /**
+     * Optionally pass additionaly classes which will be set on the dialog itself
+     * (the default `class` attribute will be set on the modal wrapper)
+     * @default ''
+     */
+    dialogClasses: {
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
+        required: false;
+        default: string;
+    };
+}>> & {
+    "onUpdate:open"?: ((...args: any[]) => any) | undefined;
+    onClosing?: ((...args: any[]) => any) | undefined;
+}, {
+    size: "normal" | "small" | "large" | "full";
+    container: string;
+    open: boolean;
+    outTransition: boolean;
+    canClose: boolean;
+    closeOnClickOutside: boolean;
+    additionalTrapElements: (string | HTMLElement)[];
+    message: string;
+    buttons: Omit<Partial<{
+        disabled: boolean;
+        type: import('../NcButton/types.js').ButtonType;
+        icon: string;
+    }> & Omit<{
+        readonly disabled: boolean;
+        readonly type: import('../NcButton/types.js').ButtonType;
+        readonly label: string;
+        readonly callback: Function;
+        readonly icon?: string | undefined;
+        onClick?: ((...args: any[]) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & Readonly<import('vue').ExtractPropTypes<{
+        callback: {
+            type: FunctionConstructor;
+            required: true;
+        };
+        label: {
+            type: StringConstructor;
+            required: true;
+        };
+        icon: {
+            type: StringConstructor;
+            required: false;
+            default: undefined;
+        };
+        type: {
+            type: PropType<import('../NcButton/types.js').ButtonType>;
+            default: import('../NcButton/types.js').ButtonType;
+            required: false;
+            validator(value: string): boolean;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & {
+        onClick?: ((...args: any[]) => any) | undefined;
+    }, "disabled" | "type" | "icon">, `on${string}` | "style" | "class" | "key" | "ref" | "ref_for" | "ref_key">[];
+    navigationClasses: string | unknown[] | Record<string, any>;
+    navigationAriaLabel: string;
+    navigationAriaLabelledby: string;
+    contentClasses: string | unknown[] | Record<string, any>;
+    dialogClasses: string | unknown[] | Record<string, any>;
+}, {}>;
 export default _default;

package/dist/components/NcDialogButton/NcDialogButton.vue.d.ts

@@ -1,2 +1,95 @@
-declare const _default: import('vue').DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, import('vue').PublicProps>;
+import { PropType } from 'vue';
+import { ButtonType } from '../NcButton/index';
+
+declare const _default: import('vue').DefineComponent<{
+    /**
+     * The function that will be called when the button is pressed
+     * @type {() => void}
+     */
+    callback: {
+        type: FunctionConstructor;
+        required: true;
+    };
+    /**
+     * The label of the button
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Optional inline SVG icon for the button
+     */
+    icon: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * The button type, see NcButton
+     * @type {'primary'|'secondary'|'error'|'warning'|'success'}
+     */
+    type: {
+        type: PropType<ButtonType>;
+        default: ButtonType;
+        required: false;
+        validator(value: string): boolean;
+    };
+    /**
+     * If the button should be shown as disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, {
+    handleClick: (e: any) => void;
+}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "click"[], "click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The function that will be called when the button is pressed
+     * @type {() => void}
+     */
+    callback: {
+        type: FunctionConstructor;
+        required: true;
+    };
+    /**
+     * The label of the button
+     */
+    label: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Optional inline SVG icon for the button
+     */
+    icon: {
+        type: StringConstructor;
+        required: false;
+        default: undefined;
+    };
+    /**
+     * The button type, see NcButton
+     * @type {'primary'|'secondary'|'error'|'warning'|'success'}
+     */
+    type: {
+        type: PropType<ButtonType>;
+        default: ButtonType;
+        required: false;
+        validator(value: string): boolean;
+    };
+    /**
+     * If the button should be shown as disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+}, {
+    disabled: boolean;
+    type: ButtonType;
+    icon: string;
+}, {}>;
 export default _default;

package/dist/components/NcDialogButton/index.d.ts

@@ -1 +1,5 @@
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
 export { default } from './NcDialogButton.vue';

package/dist/components/NcEllipsisedOption/NcEllipsisedOption.vue.d.ts

@@ -1,8 +1,14 @@
 declare const _default: import('vue').DefineComponent<{
+    /**
+     * The text to be display in one line. If it is longer than 10 characters, it is be truncated with ellipsis in the end but keeping up to 10 last characters to fit the parent container.
+     */
     name: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The search value to highlight in the text
+     */
     search: {
         type: StringConstructor;
         default: string;
@@ -33,10 +39,16 @@ declare const _default: import('vue').DefineComponent<{
      */
     highlight2(): any[];
 }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The text to be display in one line. If it is longer than 10 characters, it is be truncated with ellipsis in the end but keeping up to 10 last characters to fit the parent container.
+     */
     name: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * The search value to highlight in the text
+     */
     search: {
         type: StringConstructor;
         default: string;

package/dist/components/NcEmojiPicker/NcEmojiPicker.vue.d.ts

@@ -95,7 +95,7 @@ declare const _default: import('vue').DefineComponent<{
 }, {
     native(): boolean;
 }, {
-    t: (original: string, placeholders?: Record<string, string | number> | undefined) => string;
+    t: (original: string, placeholders?: Record<string, string | number>) => string;
     clearSearch(): void;
     /**
      * Update the current skin tone by the result of the color picker
@@ -172,7 +172,7 @@ declare const _default: import('vue').DefineComponent<{
     "onSelect-data"?: ((...args: any[]) => any) | undefined;
     onUnselect?: ((...args: any[]) => any) | undefined;
 }, {
-    container: string | boolean | Element | Record<string, any>;
+    container: string | boolean | Record<string, any> | Element;
     closeOnSelect: boolean;
     activeSet: string;
     showPreview: boolean;

package/dist/components/NcHeaderMenu/NcHeaderMenu.vue.d.ts

@@ -46,9 +46,9 @@ declare const _default: import('vue').DefineComponent<{
     descriptionId: string;
 }, {
     wrapperTag(): "div" | "nav";
-    clickOutsideConfig(): ({
+    clickOutsideConfig(): (((cancelled?: boolean) => void) | {
         ignore: any;
-    } | ((cancelled?: boolean) => void))[];
+    })[];
     listeners(): {
         focusout: (event: FocusEvent) => void;
     } | null;
@@ -82,7 +82,7 @@ declare const _default: import('vue').DefineComponent<{
 }, {
     props: {
         excludeClickOutsideSelectors: {
-            type: (StringConstructor | ArrayConstructor)[];
+            type: (ArrayConstructor | StringConstructor)[];
             default: () => never[];
         };
     };

package/dist/components/NcHighlight/NcHighlight.vue.d.ts

@@ -58,8 +58,8 @@ declare const _default: import('vue').DefineComponent<{
         default: () => never[];
     };
 }>>, {
-    text: string;
     search: string;
+    text: string;
     highlight: unknown[];
 }, {}>;
 export default _default;

package/dist/components/NcIconSvgWrapper/NcIconSvgWrapper.vue.d.ts

@@ -36,7 +36,7 @@ declare const _default: import('vue').DefineComponent<{
     size: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
-        validator: (value: unknown) => boolean;
+        validator: (value: unknown) => value is number | "auto";
     };
 }, any, any, {
     /**
@@ -90,13 +90,13 @@ declare const _default: import('vue').DefineComponent<{
     size: {
         type: (StringConstructor | NumberConstructor)[];
         default: number;
-        validator: (value: unknown) => boolean;
+        validator: (value: unknown) => value is number | "auto";
     };
 }>>, {
-    name: string;
     size: string | number;
-    svg: string;
+    name: string;
     path: string;
     inline: boolean;
+    svg: string;
 }, {}>;
 export default _default;

package/dist/components/NcInputField/NcInputField.vue.d.ts

@@ -105,7 +105,7 @@ declare const _default: import('vue').DefineComponent<{
      * Class to add to the root component.
      */
     class: {
-        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
         default: string;
     };
     /**
@@ -246,7 +246,7 @@ declare const _default: import('vue').DefineComponent<{
      * Class to add to the root component.
      */
     class: {
-        type: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        type: (ArrayConstructor | StringConstructor | ObjectConstructor)[];
         default: string;
     };
     /**
@@ -261,18 +261,18 @@ declare const _default: import('vue').DefineComponent<{
     "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
     "onTrailing-button-click"?: ((...args: any[]) => any) | undefined;
 }, {
+    error: boolean;
+    success: boolean;
     disabled: boolean;
     type: string;
     label: string;
-    class: string | Record<string, any> | unknown[];
-    error: boolean;
-    success: boolean;
+    class: string | unknown[] | Record<string, any>;
+    pill: boolean;
     inputClass: string | Record<string, any>;
     labelOutside: boolean;
     placeholder: string;
     showTrailingButton: boolean;
     trailingButtonLabel: string;
     helperText: string;
-    pill: boolean;
 }, {}>;
 export default _default;

package/dist/components/NcListItem/NcListItem.vue.d.ts

@@ -247,9 +247,9 @@ declare const _default: import('vue').DefineComponent<{
     "onUpdate:menuOpen"?: ((...args: any[]) => any) | undefined;
 }, {
     bold: boolean;
-    details: string;
     href: string;
     to: string | Record<string, any>;
+    details: string;
     target: string;
     active: boolean;
     forceDisplayActions: boolean;

package/dist/components/NcListItemIcon/NcListItemIcon.vue.d.ts

@@ -193,12 +193,12 @@ declare const _default: import('vue').DefineComponent<{
         default: null;
     };
 }>>, {
-    icon: string;
     search: string;
-    id: string;
+    icon: string;
     displayName: string;
-    isNoUser: boolean;
+    id: string;
     iconSvg: string;
+    isNoUser: boolean;
     subname: string;
     iconName: string;
     avatarSize: number;

package/dist/components/NcLoadingIcon/NcLoadingIcon.vue.d.ts

@@ -51,8 +51,8 @@ declare const _default: import('vue').DefineComponent<{
         default: string;
     };
 }>>, {
-    name: string;
     size: number;
+    name: string;
     appearance: string;
 }, {}>;
 export default _default;

package/dist/components/NcNoteCard/NcNoteCard.vue.d.ts

@@ -38,7 +38,7 @@ declare const _default: import('vue').DefineComponent<{
     };
 }>>, {
     type: string;
-    heading: string;
     showAlert: boolean;
+    heading: string;
 }, {}>;
 export default _default;

package/dist/components/NcRelatedResourcesPanel/NcRelatedResourcesPanel.vue.d.ts

@@ -66,7 +66,7 @@ declare const _default: import('vue').DefineComponent<{
     isFiles(): boolean;
     url(): string;
 }, {
-    t: (original: string, placeholders?: Record<string, string | number> | undefined) => string;
+    t: (original: string, placeholders?: Record<string, string | number>) => string;
     fetchRelatedResources(): Promise<void>;
 }, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("has-error" | "has-resources")[], "has-error" | "has-resources", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
     /**
@@ -128,13 +128,13 @@ declare const _default: import('vue').DefineComponent<{
     "onHas-error"?: ((...args: any[]) => any) | undefined;
     "onHas-resources"?: ((...args: any[]) => any) | undefined;
 }, {
-    header: string;
     primary: boolean;
+    header: string;
+    resourceType: string;
     limit: number;
     description: string;
     providerId: string;
     itemId: string | number;
     fileInfo: Record<string, any>;
-    resourceType: string;
 }, {}>;
 export default _default;