@nextcloud/vue 9.0.0-alpha.4 → 9.0.0-alpha.6

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

@@ -1,2 +1,509 @@
-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<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;
+    };
+    /**
+     * Make the dialog wrapper a HTML form element.
+     * The buttons will be wrapped within the form so they can be used as submit / reset buttons.
+     * Please note that when using the property the `navigation` should not be used.
+     */
+    isForm: {
+        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: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        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: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        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: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        required: false;
+        default: string;
+    };
+}>, {
+    dialogElement: import('vue').Ref<any, any>;
+    dialogListeners: import('vue').ComputedRef<{
+        /**
+         * @param {SubmitEvent} event Form submit event
+         */
+        submit(event: any): void;
+    } | {
+        /**
+         * @param {SubmitEvent} event Form submit event
+         */
+        submit?: undefined;
+    }>;
+    dialogTagName: import('vue').ComputedRef<"div" | "form">;
+    handleButtonClose: (event: any, result: any) => void;
+    handleClosing: (result: any) => 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: "large" | "small" | "normal" | "full";
+        show: boolean;
+        outTransition: boolean;
+        closeOnClickOutside: boolean;
+        additionalTrapElements: (string | HTMLElement)[];
+    }>;
+    wrapper: import('vue').Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("submit" | "update:open" | "closing")[], "submit" | "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;
+    };
+    /**
+     * Make the dialog wrapper a HTML form element.
+     * The buttons will be wrapped within the form so they can be used as submit / reset buttons.
+     * Please note that when using the property the `navigation` should not be used.
+     */
+    isForm: {
+        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: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        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: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        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: (StringConstructor | ObjectConstructor | ArrayConstructor)[];
+        required: false;
+        default: string;
+    };
+}>> & Readonly<{
+    onSubmit?: ((...args: any[]) => any) | undefined;
+    "onUpdate:open"?: ((...args: any[]) => any) | undefined;
+    onClosing?: ((...args: any[]) => any) | undefined;
+}>, {
+    size: "large" | "small" | "normal" | "full";
+    container: string;
+    open: boolean;
+    message: string;
+    outTransition: boolean;
+    canClose: boolean;
+    closeOnClickOutside: boolean;
+    additionalTrapElements: (string | HTMLElement)[];
+    buttons: Omit<Partial<{
+        type: import('../NcButton/types.ts').ButtonType;
+        icon: string;
+        disabled: boolean;
+        nativeType: import('../NcButton/types.ts').ButtonNativeType;
+        callback: Function;
+    }> & Omit<{
+        readonly type: import('../NcButton/types.ts').ButtonType;
+        readonly label: string;
+        readonly disabled: boolean;
+        readonly nativeType: import('../NcButton/types.ts').ButtonNativeType;
+        readonly callback: Function;
+        readonly icon?: string | undefined;
+        readonly onClick?: ((event: MouseEvent, payload: unknown) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, "type" | "icon" | "disabled" | "nativeType" | "callback">, `on${string}` | "style" | "class" | "key" | "ref" | "ref_for" | "ref_key">[];
+    isForm: boolean;
+    navigationClasses: string | Record<string, any> | unknown[];
+    navigationAriaLabel: string;
+    navigationAriaLabelledby: string;
+    contentClasses: string | Record<string, any> | unknown[];
+    dialogClasses: string | Record<string, any> | unknown[];
+}, {}, {
+    NcDialogButton: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+            callback: {
+                type: FunctionConstructor;
+                required: false;
+                default: () => void;
+            };
+            label: {
+                type: StringConstructor;
+                required: true;
+            };
+            icon: {
+                type: StringConstructor;
+                required: false;
+                default: undefined;
+            };
+            type: {
+                type: PropType<import('../NcButton/types.ts').ButtonType>;
+                default: import('../NcButton/types.ts').ButtonType;
+                required: false;
+                validator(value: string): boolean;
+            };
+            nativeType: {
+                type: PropType<import('../NcButton/types.ts').ButtonNativeType>;
+                required: false;
+                default: string;
+                validator(value: unknown): boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+        }>> & Readonly<{
+            onClick?: ((event: MouseEvent, payload: unknown) => any) | undefined;
+        }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+            click: (event: MouseEvent, payload: unknown) => void;
+        }, import('vue').PublicProps, {
+            type: import('../NcButton/types.ts').ButtonType;
+            icon: string;
+            disabled: boolean;
+            nativeType: import('../NcButton/types.ts').ButtonNativeType;
+            callback: Function;
+        }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('vue').ExtractPropTypes<{
+            callback: {
+                type: FunctionConstructor;
+                required: false;
+                default: () => void;
+            };
+            label: {
+                type: StringConstructor;
+                required: true;
+            };
+            icon: {
+                type: StringConstructor;
+                required: false;
+                default: undefined;
+            };
+            type: {
+                type: PropType<import('../NcButton/types.ts').ButtonType>;
+                default: import('../NcButton/types.ts').ButtonType;
+                required: false;
+                validator(value: string): boolean;
+            };
+            nativeType: {
+                type: PropType<import('../NcButton/types.ts').ButtonNativeType>;
+                required: false;
+                default: string;
+                validator(value: unknown): boolean;
+            };
+            disabled: {
+                type: BooleanConstructor;
+                default: boolean;
+            };
+        }>> & Readonly<{
+            onClick?: ((event: MouseEvent, payload: unknown) => any) | undefined;
+        }>, {}, {}, {}, {}, {
+            type: import('../NcButton/types.ts').ButtonType;
+            icon: string;
+            disabled: boolean;
+            nativeType: import('../NcButton/types.ts').ButtonNativeType;
+            callback: Function;
+        }>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+        callback: {
+            type: FunctionConstructor;
+            required: false;
+            default: () => void;
+        };
+        label: {
+            type: StringConstructor;
+            required: true;
+        };
+        icon: {
+            type: StringConstructor;
+            required: false;
+            default: undefined;
+        };
+        type: {
+            type: PropType<import('../NcButton/types.ts').ButtonType>;
+            default: import('../NcButton/types.ts').ButtonType;
+            required: false;
+            validator(value: string): boolean;
+        };
+        nativeType: {
+            type: PropType<import('../NcButton/types.ts').ButtonNativeType>;
+            required: false;
+            default: string;
+            validator(value: unknown): boolean;
+        };
+        disabled: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+    }>> & Readonly<{
+        onClick?: ((event: MouseEvent, payload: unknown) => any) | undefined;
+    }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        click: (event: MouseEvent, payload: unknown) => void;
+    }, string, {
+        type: import('../NcButton/types.ts').ButtonType;
+        icon: string;
+        disabled: boolean;
+        nativeType: import('../NcButton/types.ts').ButtonNativeType;
+        callback: Function;
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+        $slots: {
+            icon?(_: {}): any;
+        };
+    });
+    NcModal: import('vue').DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, import('vue').PublicProps>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
 export default _default;

package/dist/components/NcDialog/index.mjs

@@ -0,0 +1,4 @@
+import { N } from "../../chunks/NcDialog-bRHxABY1.mjs";
+export {
+  N as default
+};

package/dist/components/NcDialog/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

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

@@ -1,2 +1,135 @@
-declare const _default: import('vue').DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, import('vue').PublicProps>;
+import { PropType } from 'vue';
+import { ButtonNativeType, ButtonType } from '../NcButton/index';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        icon?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * The function that will be called when the button is pressed.
+     * If the function returns `false` the click is ignored and the dialog will not be closed.
+     * @type {() => unknown|false|Promise<unknown|false>}
+     */
+    callback: {
+        type: FunctionConstructor;
+        required: false;
+        default: () => void;
+    };
+    /**
+     * 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;
+    };
+    /**
+     * The native type of the button, see `NcButton`
+     * @type {'button'|'submit'|'reset'}
+     */
+    nativeType: {
+        type: PropType<ButtonNativeType>;
+        required: false;
+        default: string;
+        validator(value: unknown): boolean;
+    };
+    /**
+     * If the button should be shown as disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    click: (event: MouseEvent, payload: unknown) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * The function that will be called when the button is pressed.
+     * If the function returns `false` the click is ignored and the dialog will not be closed.
+     * @type {() => unknown|false|Promise<unknown|false>}
+     */
+    callback: {
+        type: FunctionConstructor;
+        required: false;
+        default: () => void;
+    };
+    /**
+     * 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;
+    };
+    /**
+     * The native type of the button, see `NcButton`
+     * @type {'button'|'submit'|'reset'}
+     */
+    nativeType: {
+        type: PropType<ButtonNativeType>;
+        required: false;
+        default: string;
+        validator(value: unknown): boolean;
+    };
+    /**
+     * If the button should be shown as disabled
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onClick?: ((event: MouseEvent, payload: unknown) => any) | undefined;
+}>, {
+    type: ButtonType;
+    icon: string;
+    disabled: boolean;
+    nativeType: ButtonNativeType;
+    callback: Function;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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/NcDialogButton/index.mjs

@@ -0,0 +1,4 @@
+import { _ } from "../../chunks/NcDialogButton.vue_vue_type_script_setup_true_lang-CBKNl2vE.mjs";
+export {
+  _ as default
+};

package/dist/components/NcDialogButton/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";"}