@nextcloud/vue 8.6.0 → 9.0.0-alpha.1

package/dist/src/components/NcActionRadio/NcActionRadio.vue.d.ts

@@ -0,0 +1,115 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * id attribute of the radio element
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+        validator: (id: unknown) => boolean;
+    };
+    /**
+     * checked state of the the radio element
+     */
+    modelValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Define if this radio is part of a set.
+     * Checking the radio will disable all the
+     * others with the same name.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * value of the radio input
+     */
+    value: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+     * disabled state of the radio element
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {
+    /**
+     * determines if the action is focusable
+     *
+     * @return {boolean} is the action focusable ?
+     */
+    isFocusable(): boolean;
+    /**
+     * aria-checked attribute for role="menuitemcheckbox"
+     *
+     * @return {'true'|'false'|undefined} aria-checked value if needed
+     */
+    ariaChecked(): 'true' | 'false' | undefined;
+}, {
+    toggleInput(): void;
+    onChange(event: any): void;
+}, {
+    beforeUpdate(): void;
+    data(): {
+        text: any;
+    };
+    computed: {
+        isLongText(): any;
+    };
+    methods: {
+        getText(): any;
+    };
+}, import("vue").ComponentOptionsMixin, ("update:modelValue" | "change")[], "update:modelValue" | "change", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * id attribute of the radio element
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+        validator: (id: unknown) => boolean;
+    };
+    /**
+     * checked state of the the radio element
+     */
+    modelValue: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Define if this radio is part of a set.
+     * Checking the radio will disable all the
+     * others with the same name.
+     */
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * value of the radio input
+     */
+    value: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: string;
+    };
+    /**
+     * disabled state of the radio element
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
+}, {
+    disabled: boolean;
+    modelValue: boolean;
+    value: string | number;
+    id: string;
+}, {}>;
+export default _default;

package/dist/src/components/NcActionRouter/NcActionRouter.vue.d.ts

@@ -0,0 +1,68 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * router-link to prop [https://router.vuejs.org/api/#to](https://router.vuejs.org/api/#to)
+     */
+    to: {
+        type: (StringConstructor | ObjectConstructor)[];
+        default: string;
+        required: true;
+    };
+}, any, any, {}, {}, {
+    mixins: {
+        beforeUpdate(): void;
+        data(): {
+            text: any;
+        };
+        computed: {
+            isLongText(): any;
+        };
+        methods: {
+            getText(): any;
+        };
+    }[];
+    props: {
+        icon: {
+            type: StringConstructor;
+            default: string;
+        };
+        name: {
+            type: StringConstructor;
+            default: string;
+        };
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+        closeAfterClick: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: null;
+        };
+        ariaHidden: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    };
+    emits: string[];
+    computed: {
+        isIconUrl(): boolean;
+    };
+    methods: {
+        onClick(event: any): void;
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * router-link to prop [https://router.vuejs.org/api/#to](https://router.vuejs.org/api/#to)
+     */
+    to: {
+        type: (StringConstructor | ObjectConstructor)[];
+        default: string;
+        required: true;
+    };
+}>>, {
+    to: string | Record<string, any>;
+}, {}>;
+export default _default;

package/dist/src/components/NcActionSeparator/NcActionSeparator.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/src/components/NcActionText/NcActionText.vue.d.ts

@@ -0,0 +1,48 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, {
+    mixins: {
+        beforeUpdate(): void;
+        data(): {
+            text: any;
+        };
+        computed: {
+            isLongText(): any;
+        };
+        methods: {
+            getText(): any;
+        };
+    }[];
+    props: {
+        icon: {
+            type: StringConstructor;
+            default: string;
+        };
+        name: {
+            type: StringConstructor;
+            default: string;
+        };
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+        closeAfterClick: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: null;
+        };
+        ariaHidden: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    };
+    emits: string[];
+    computed: {
+        isIconUrl(): boolean;
+    };
+    methods: {
+        onClick(event: any): void;
+    };
+}, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/src/components/NcActionTextEditable/NcActionTextEditable.vue.d.ts

@@ -0,0 +1,113 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * id attribute of the checkbox element
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+        validator: (id: unknown) => boolean;
+    };
+    /**
+     * disabled state of the text area
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * value attribute of the input field
+     */
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    /**
+     * determines if the action is focusable
+     *
+     * @return {boolean} is the action focusable ?
+     */
+    isFocusable(): boolean;
+    computedId(): string;
+}, {
+    onInput(event: any): void;
+    onSubmit(event: any): false | undefined;
+}, {
+    mixins: {
+        beforeUpdate(): void;
+        data(): {
+            text: any;
+        };
+        computed: {
+            isLongText(): any;
+        };
+        methods: {
+            getText(): any;
+        };
+    }[];
+    props: {
+        icon: {
+            type: StringConstructor;
+            default: string;
+        };
+        name: {
+            type: StringConstructor;
+            default: string;
+        };
+        title: {
+            type: StringConstructor;
+            default: string;
+        };
+        closeAfterClick: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        ariaLabel: {
+            type: StringConstructor;
+            default: null;
+        };
+        ariaHidden: {
+            type: BooleanConstructor;
+            default: null;
+        };
+    };
+    emits: string[];
+    computed: {
+        isIconUrl(): boolean;
+    };
+    methods: {
+        onClick(event: any): void;
+    };
+}, import("vue").ComponentOptionsMixin, ("update:modelValue" | "submit" | "input")[], "update:modelValue" | "submit" | "input", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * id attribute of the checkbox element
+     */
+    id: {
+        type: StringConstructor;
+        default: () => string;
+        validator: (id: unknown) => boolean;
+    };
+    /**
+     * disabled state of the text area
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * value attribute of the input field
+     */
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onInput?: ((...args: any[]) => any) | undefined;
+    onSubmit?: ((...args: any[]) => any) | undefined;
+}, {
+    disabled: boolean;
+    modelValue: string;
+    id: string;
+}, {}>;
+export default _default;

package/dist/src/components/NcActions/NcActions.vue.d.ts

@@ -0,0 +1,343 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Specify the open state of the popover menu
+     */
+    open: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * This disables the internal open management,
+     * so the actions menu only respects the `open` prop.
+     * This is e.g. necessary for the NcAvatar component
+     * to only open the actions menu after loading it's entries has finished.
+     */
+    manualOpen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the actions to display in a three dot menu
+     */
+    forceMenu: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the name to show for single actions
+     */
+    forceName: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify the menu name
+     */
+    menuName: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Apply primary styling for this menu
+     */
+    primary: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specifies the button type used for trigger and single actions buttons
+     * Accepted values: primary, secondary, tertiary, tertiary-no-background, tertiary-on-primary, error, warning, success. If left empty,
+     * the default button style will be applied.
+     */
+    type: {
+        type: StringConstructor;
+        validator(value: unknown): boolean;
+        default: null;
+    };
+    /**
+     * Icon to show for the toggle menu button
+     * when more than one action is inside the actions component.
+     * Only replace the default three-dot icon if really necessary.
+     */
+    defaultIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Aria label for the actions menu.
+     *
+     * If `menuName` is defined this will not be used to prevent
+     * any accessible name conflicts. This ensures that the
+     * element can be activated via voice input.
+     */
+    ariaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @deprecated To be removed in @nextcloud/vue 9. Migration guide: remove ariaHidden prop from NcAction* components.
+     * @todo Add a check in @nextcloud/vue 9 that this prop is not provided,
+     * otherwise root element will inherit incorrect aria-hidden.
+     */
+    ariaHidden: {
+        type: BooleanConstructor;
+        default: null;
+    };
+    /**
+     * Wanted direction of the menu
+     */
+    placement: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * DOM element for the actions' popover boundaries
+     */
+    boundariesElement: {
+        type: {
+            new (): Element;
+            prototype: Element;
+        };
+        default: () => HTMLBodyElement | null;
+    };
+    /**
+     * Selector for the actions' popover container
+     */
+    container: {
+        type: (StringConstructor | BooleanConstructor | ObjectConstructor | {
+            new (): Element;
+            prototype: Element;
+        })[];
+        default: string;
+    };
+    /**
+     * Disabled state of the main button (single action or menu toggle)
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Display x items inline out of the dropdown menu
+     * Will be ignored if `forceMenu` is set
+     */
+    inline: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, any, {
+    opened: boolean;
+    focusIndex: number;
+    randomId: string;
+    /**
+     * @type {'menu'|'navigation'|'dialog'|'tooltip'|''}
+     */
+    actionsMenuSemanticType: 'menu' | 'navigation' | 'dialog' | 'tooltip' | '';
+    externalFocusTrapStack: never[];
+}, {
+    triggerBtnType(): any;
+    withFocusTrap(): boolean;
+}, {
+    /**
+     * Get the name of the action component
+     *
+     * @param {import('vue').VNode} action - a vnode with a NcAction* component instance
+     * @return {string} the name of the action component
+     */
+    getActionName(action: import('vue').VNode): string;
+    /**
+     * When the component has its own focus trap, then it is managed by global trap stack by focus-trap.
+     *
+     * However if the component has no focus trap and is used inside another focus trap - there is an issue.
+     * By default popover content is rendered in body or other container, which is likely outside the current focus trap containers.
+     * It results in broken behavior from focus-trap.
+     *
+     * We need to pause all the focus traps for opening popover and then unpause them back after closing.
+     */
+    intersectIntoCurrentFocusTrapStack(): void;
+    /**
+     * Do we have exactly one Action and
+     * is it allowed as a standalone element?
+     *
+     * @param {import('vue').VNode} action The action to check
+     * @return {boolean}
+     */
+    isValidSingleAction(action: import('vue').VNode): boolean;
+    isAction(action: any): boolean;
+    /**
+     * Check whether a icon prop value is an URL or not
+     * @param {string} url The icon prop value
+     */
+    isIconUrl(url: string): boolean;
+    openMenu(): void;
+    closeMenu(returnFocus?: boolean): void;
+    onOpen(event: any): void;
+    onMouseFocusAction(event: any): void;
+    /**
+     * Dispatches the keydown listener to different handlers
+     *
+     * @param {object} event The keydown event
+     */
+    onKeydown(event: object): void;
+    removeCurrentActive(): void;
+    focusAction(): void;
+    focusPreviousAction(event: any): void;
+    focusNextAction(event: any): void;
+    focusFirstAction(event: any): void;
+    focusLastAction(event: any): void;
+    preventIfEvent(event: any): void;
+    onFocus(event: any): void;
+    onBlur(event: any): void;
+    onClick(event: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "blur" | "close" | "focus" | "open" | "update:open")[], "click" | "blur" | "close" | "focus" | "open" | "update:open", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Specify the open state of the popover menu
+     */
+    open: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * This disables the internal open management,
+     * so the actions menu only respects the `open` prop.
+     * This is e.g. necessary for the NcAvatar component
+     * to only open the actions menu after loading it's entries has finished.
+     */
+    manualOpen: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the actions to display in a three dot menu
+     */
+    forceMenu: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Force the name to show for single actions
+     */
+    forceName: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specify the menu name
+     */
+    menuName: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Apply primary styling for this menu
+     */
+    primary: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specifies the button type used for trigger and single actions buttons
+     * Accepted values: primary, secondary, tertiary, tertiary-no-background, tertiary-on-primary, error, warning, success. If left empty,
+     * the default button style will be applied.
+     */
+    type: {
+        type: StringConstructor;
+        validator(value: unknown): boolean;
+        default: null;
+    };
+    /**
+     * Icon to show for the toggle menu button
+     * when more than one action is inside the actions component.
+     * Only replace the default three-dot icon if really necessary.
+     */
+    defaultIcon: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Aria label for the actions menu.
+     *
+     * If `menuName` is defined this will not be used to prevent
+     * any accessible name conflicts. This ensures that the
+     * element can be activated via voice input.
+     */
+    ariaLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * @deprecated To be removed in @nextcloud/vue 9. Migration guide: remove ariaHidden prop from NcAction* components.
+     * @todo Add a check in @nextcloud/vue 9 that this prop is not provided,
+     * otherwise root element will inherit incorrect aria-hidden.
+     */
+    ariaHidden: {
+        type: BooleanConstructor;
+        default: null;
+    };
+    /**
+     * Wanted direction of the menu
+     */
+    placement: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * DOM element for the actions' popover boundaries
+     */
+    boundariesElement: {
+        type: {
+            new (): Element;
+            prototype: Element;
+        };
+        default: () => HTMLBodyElement | null;
+    };
+    /**
+     * Selector for the actions' popover container
+     */
+    container: {
+        type: (StringConstructor | BooleanConstructor | ObjectConstructor | {
+            new (): Element;
+            prototype: Element;
+        })[];
+        default: string;
+    };
+    /**
+     * Disabled state of the main button (single action or menu toggle)
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Display x items inline out of the dropdown menu
+     * Will be ignored if `forceMenu` is set
+     */
+    inline: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+    onFocus?: ((...args: any[]) => any) | undefined;
+    onBlur?: ((...args: any[]) => any) | undefined;
+    onClose?: ((...args: any[]) => any) | undefined;
+    onOpen?: ((...args: any[]) => any) | undefined;
+    "onUpdate:open"?: ((...args: any[]) => any) | undefined;
+}, {
+    ariaHidden: boolean;
+    disabled: boolean;
+    type: string;
+    primary: boolean;
+    ariaLabel: string;
+    placement: string;
+    container: string | boolean | Element | Record<string, any>;
+    open: boolean;
+    manualOpen: boolean;
+    forceMenu: boolean;
+    forceName: boolean;
+    menuName: string;
+    defaultIcon: string;
+    boundariesElement: Element;
+    inline: number;
+}, {}>;
+export default _default;