@nextcloud/vue 9.0.0-alpha.8 → 9.0.0-rc.0

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

@@ -1,544 +0,0 @@
-import { NC_ACTIONS_IS_SEMANTIC_MENU, NC_ACTIONS_CLOSE_MENU } from './useNcActions.ts';
-declare const _default: import('vue').DefineComponent<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;
-    };
-    /**
-     * 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: () => HTMLElement | 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;
-    };
-    /**
-     * Specifies the button variant 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.
-     *
-     * @since 8.23.0
-     */
-    variant: {
-        type: StringConstructor;
-        validator(value: unknown): boolean;
-        default: null;
-    };
-}>, {
-    triggerButton: import('vue').Ref<any, any>;
-    maxMenuHeight: import('vue').ComputedRef<number>;
-    randomId: string;
-    triggerRandomId: string;
-}, {
-    opened: boolean;
-    focusIndex: number;
-    /**
-     * @type {'menu'|'navigation'|'dialog'|'tooltip'|'unknown'}
-     */
-    actionsMenuSemanticType: "menu" | "navigation" | "dialog" | "tooltip" | "unknown";
-}, {
-    triggerButtonVariant(): string;
-    /**
-     * A11y roles and keyboard navigation configuration depending on the semantic type
-     */
-    config(): {
-        popupRole: string;
-        withArrowNavigation: boolean;
-        withTabNavigation: boolean;
-        withFocusTrap: boolean;
-    } | {
-        popupRole: undefined;
-        withArrowNavigation: boolean;
-        withTabNavigation: boolean;
-        withFocusTrap: boolean;
-    } | {
-        popupRole: string;
-        withArrowNavigation: boolean;
-        withTabNavigation: boolean;
-        withFocusTrap: boolean;
-    } | {
-        popupRole: undefined;
-        withArrowNavigation: boolean;
-        withTabNavigation: boolean;
-        withFocusTrap: boolean;
-    } | {
-        popupRole: undefined;
-        role: undefined;
-        withArrowNavigation: boolean;
-        withTabNavigation: boolean;
-        withFocusTrap: boolean;
-    };
-    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;
-    /**
-     * 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): Promise<void>;
-    /**
-     * Called when popover is shown after the show delay
-     */
-    onOpened(): void;
-    onClosed(): void;
-    /**
-     * Handle resizing the popover to make sure users can discover there is more to scroll
-     */
-    resizePopover(): void;
-    /**
-     * @return {HTMLElement|null}
-     */
-    getCurrentActiveMenuItemElement(): HTMLElement | null;
-    /**
-     * @return {NodeListOf<HTMLElement>}
-     */
-    getFocusableMenuItemElements(): NodeListOf<HTMLElement>;
-    /**
-     * Dispatches the keydown listener to different handlers
-     *
-     * @param {object} event The keydown event
-     */
-    onKeydown(event: object): void;
-    onTriggerKeydown(event: any): void;
-    handleEscapePressed(event: any): 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" | "closed" | "open" | "opened" | "update:open")[], "click" | "blur" | "close" | "focus" | "closed" | "open" | "opened" | "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;
-    };
-    /**
-     * 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: () => HTMLElement | 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;
-    };
-    /**
-     * Specifies the button variant 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.
-     *
-     * @since 8.23.0
-     */
-    variant: {
-        type: StringConstructor;
-        validator(value: unknown): boolean;
-        default: null;
-    };
-}>> & Readonly<{
-    onClick?: ((...args: any[]) => any) | undefined;
-    onBlur?: ((...args: any[]) => any) | undefined;
-    onClose?: ((...args: any[]) => any) | undefined;
-    onFocus?: ((...args: any[]) => any) | undefined;
-    onClosed?: ((...args: any[]) => any) | undefined;
-    onOpen?: ((...args: any[]) => any) | undefined;
-    onOpened?: ((...args: any[]) => any) | undefined;
-    "onUpdate:open"?: ((...args: any[]) => any) | undefined;
-}>, {
-    primary: boolean;
-    disabled: boolean;
-    ariaLabel: string;
-    ariaHidden: boolean;
-    variant: 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;
-}, {}, {
-    NcButton: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
-        alignment: {
-            type: import('vue').PropType<import('../NcButton/types.ts').ButtonAlignment>;
-            default: import('../NcButton/types.ts').ButtonAlignment;
-            validator(value: string): boolean;
-        };
-        disabled: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        size: {
-            type: StringConstructor;
-            default: string;
-            validator(value: string): boolean;
-        };
-        type: {
-            type: import('vue').PropType<import('../NcButton/types.ts').ButtonType | `${import('../NcButton/types.ts').ButtonType}`>;
-            default: import('../NcButton/types.ts').ButtonType;
-            validator(value: string): boolean;
-        };
-        wide: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        ariaLabel: {
-            type: StringConstructor;
-            default: null;
-        };
-        href: {
-            type: StringConstructor;
-            default: null;
-        };
-        target: {
-            type: StringConstructor;
-            default: string;
-        };
-        download: {
-            type: StringConstructor;
-            default: null;
-        };
-        to: {
-            type: (StringConstructor | ObjectConstructor)[];
-            default: null;
-        };
-        ariaHidden: {
-            type: BooleanConstructor;
-            default: null;
-        };
-        pressed: {
-            type: BooleanConstructor;
-            default: null;
-        };
-        variant: {
-            type: import('vue').PropType<ButtonVariant | `${ButtonVariant}`>;
-            validator(value: string): boolean;
-            default: string;
-        };
-    }>, {}, {}, {
-        realVariant(): any;
-        realType(): "submit" | "reset" | "button" | import('../NcButton/types.ts').ButtonType;
-        flexAlignment(): string;
-        isReverseAligned(): boolean;
-        ncPopoverTriggerAttrs(): Record<string, string | undefined>;
-    }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("update:pressed" | "click")[], "update:pressed" | "click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
-        alignment: {
-            type: import('vue').PropType<import('../NcButton/types.ts').ButtonAlignment>;
-            default: import('../NcButton/types.ts').ButtonAlignment;
-            validator(value: string): boolean;
-        };
-        disabled: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        size: {
-            type: StringConstructor;
-            default: string;
-            validator(value: string): boolean;
-        };
-        type: {
-            type: import('vue').PropType<import('../NcButton/types.ts').ButtonType | `${import('../NcButton/types.ts').ButtonType}`>;
-            default: import('../NcButton/types.ts').ButtonType;
-            validator(value: string): boolean;
-        };
-        wide: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        ariaLabel: {
-            type: StringConstructor;
-            default: null;
-        };
-        href: {
-            type: StringConstructor;
-            default: null;
-        };
-        target: {
-            type: StringConstructor;
-            default: string;
-        };
-        download: {
-            type: StringConstructor;
-            default: null;
-        };
-        to: {
-            type: (StringConstructor | ObjectConstructor)[];
-            default: null;
-        };
-        ariaHidden: {
-            type: BooleanConstructor;
-            default: null;
-        };
-        pressed: {
-            type: BooleanConstructor;
-            default: null;
-        };
-        variant: {
-            type: import('vue').PropType<ButtonVariant | `${ButtonVariant}`>;
-            validator(value: string): boolean;
-            default: string;
-        };
-    }>> & Readonly<{
-        "onUpdate:pressed"?: ((...args: any[]) => any) | undefined;
-        onClick?: ((...args: any[]) => any) | undefined;
-    }>, {
-        size: string;
-        type: "submit" | "reset" | "button" | import('../NcButton/types.ts').ButtonType;
-        alignment: import('../NcButton/types.ts').ButtonAlignment;
-        disabled: boolean;
-        wide: boolean;
-        ariaLabel: string;
-        href: string;
-        target: string;
-        download: string;
-        to: string | Record<string, any>;
-        ariaHidden: boolean;
-        pressed: boolean;
-        variant: any;
-    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
-    NcPopover: import('vue').DefineSetupFnComponent<Record<string, any>, {}, {}, Record<string, any> & {}, import('vue').PublicProps>;
-}, {}, string, () => {
-    /**
-     * NcActions can be used as:
-     * - Application menu (has menu role)
-     * - Navigation (has no specific role, should be used an element with navigation role)
-     * - Popover with plain text or text inputs (has no specific role)
-     * Depending on the usage (used items), the menu and its items should have different roles for a11y.
-     * Provide the role for NcAction* components in the NcActions content.
-     * @type {import('vue').ComputedRef<boolean>}
-     */
-    [NC_ACTIONS_IS_SEMANTIC_MENU]: import('vue').ComputedRef<boolean>;
-    [NC_ACTIONS_CLOSE_MENU]: (returnFocus?: boolean) => Promise<void>;
-}, true, {}, any>;
-export default _default;