x-next 0.0.0-alpha.67 → 0.0.0-alpha.68

package/dist/components/menu/base-menu.vue.d.ts

@@ -0,0 +1,480 @@
+import { CSSProperties, PropType, StyleValue } from 'vue';
+import { TriggerProps } from '../trigger-v2/interface';
+/**
+ * @displayName Menu
+ */
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    style: {
+        type: PropType<StyleValue>;
+    };
+    /**
+     * @zh 菜单的主题
+     * @en Menu theme
+     */
+    theme: {
+        type: PropType<"light" | "dark">;
+        default: string;
+    };
+    /**
+     * @zh 菜单的模式
+     * @en The mode of menu
+     */
+    mode: {
+        type: PropType<"vertical" | "horizontal" | "pop" | "popButton">;
+        default: string;
+    };
+    /**
+     * @zh 层级之间的缩进量
+     * @en Indentation between levels
+     */
+    levelIndent: {
+        type: NumberConstructor;
+    };
+    /**
+     * @zh 默认展开所有多级菜单
+     * @en Expand all multi-level menus by default
+     */
+    autoOpen: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 是否折叠菜单
+     * @en Whether to collapse the menu
+     * @vModel
+     */
+    collapsed: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /**
+     * @zh 默认是否折叠菜单
+     * @en Whether to collapse the menu by default
+     */
+    defaultCollapsed: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 折叠菜单宽度
+     * @en Collapse menu width
+     */
+    collapsedWidth: {
+        type: NumberConstructor;
+    };
+    /**
+     * @zh 开启手风琴效果
+     * @en Turn on the accordion effect
+     */
+    accordion: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 是否自动滚动选中项目到可见区域
+     * @en Whether to automatically scroll the selected item to the visible area
+     */
+    autoScrollIntoView: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 是否内置折叠按钮
+     * @en Whether built-in folding button
+     */
+    showCollapseButton: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 选中的菜单项 key 数组
+     * @en The selected menu item key array
+     * @vModel
+     */
+    selectedKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * @zh 默认选中的菜单项 key 数组
+     * @en The key array of the menu items selected by default
+     */
+    defaultSelectedKeys: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    /**
+     * @zh 展开的子菜单 key 数组
+     * @en Expanded submenu key array
+     * @vModel
+     */
+    openKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * @zh 默认展开的子菜单 key 数组
+     * @en The default expanded submenu key array
+     */
+    defaultOpenKeys: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    /**
+     * @zh 滚动到可见区域的配置项，接收所有[scroll-into-view-if-needed](https://github.com/stipsan/scroll-into-view-if-needed)的参数
+     * @en Scroll to the configuration items in the visible area and receive all the parameters of [scroll-into-view-if-needed](https://github.com/stipsan/scroll-into-view-if-needed)
+     */
+    scrollConfig: {
+        type: PropType<{
+            [key: string]: any;
+        }>;
+    };
+    /**
+     * @zh 弹出模式下可接受所有 `Trigger` 的 `Props`
+     * @en Accept all `Props` of `Trigger` in pop-up mode
+     */
+    triggerProps: {
+        type: PropType<TriggerProps>;
+    };
+    /**
+     * @zh 弹出模式下可接受所有 `ToolTip` 的 `Props`
+     * @en Accept all `Props` of `ToolTip` in pop-up mode
+     */
+    tooltipProps: {
+        type: ObjectConstructor;
+    };
+    /**
+     * @zh 默认展开选中的菜单
+     * @en Expand the selected menus by default
+     * @version 2.8.0
+     */
+    autoOpenSelected: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 响应式的断点, 详见[响应式栅格](/vue/component/grid)
+     * @en Responsive breakpoints, see [Responsive Grid](/vue/component/grid) for details
+     * @version 2.18.0
+     */
+    breakpoint: {
+        type: PropType<"xxl" | "xl" | "lg" | "md" | "sm" | "xs">;
+    };
+    /**
+     * @zh 弹出框的最大高度
+     * @en The maximum height of popover
+     * @version 2.23.0
+     */
+    popupMaxHeight: {
+        type: PropType<boolean | number>;
+        default: boolean;
+    };
+    prefixCls: {
+        type: StringConstructor;
+    };
+    inTrigger: {
+        type: BooleanConstructor;
+    };
+    siderCollapsed: {
+        type: BooleanConstructor;
+    };
+    isRoot: {
+        type: BooleanConstructor;
+    };
+}>, {
+    computedPrefixCls: import('vue').ComputedRef<string>;
+    classNames: import('vue').ComputedRef<(string | {
+        [x: string]: boolean;
+    })[]>;
+    computedStyle: import('vue').ComputedRef<(string | false | StyleValue[] | Omit<CSSProperties, "width"> | {
+        width: string | number | undefined;
+    } | null | undefined)[]>;
+    computedCollapsed: import('vue').ComputedRef<boolean>;
+    computedHasCollapseButton: import('vue').ComputedRef<boolean>;
+    onCollapseBtnClick: () => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("collapse" | "update:collapsed" | "update:selectedKeys" | "update:openKeys" | "menu-item-click" | "sub-menu-click")[], "collapse" | "update:collapsed" | "update:selectedKeys" | "update:openKeys" | "menu-item-click" | "sub-menu-click", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    style: {
+        type: PropType<StyleValue>;
+    };
+    /**
+     * @zh 菜单的主题
+     * @en Menu theme
+     */
+    theme: {
+        type: PropType<"light" | "dark">;
+        default: string;
+    };
+    /**
+     * @zh 菜单的模式
+     * @en The mode of menu
+     */
+    mode: {
+        type: PropType<"vertical" | "horizontal" | "pop" | "popButton">;
+        default: string;
+    };
+    /**
+     * @zh 层级之间的缩进量
+     * @en Indentation between levels
+     */
+    levelIndent: {
+        type: NumberConstructor;
+    };
+    /**
+     * @zh 默认展开所有多级菜单
+     * @en Expand all multi-level menus by default
+     */
+    autoOpen: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 是否折叠菜单
+     * @en Whether to collapse the menu
+     * @vModel
+     */
+    collapsed: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    /**
+     * @zh 默认是否折叠菜单
+     * @en Whether to collapse the menu by default
+     */
+    defaultCollapsed: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 折叠菜单宽度
+     * @en Collapse menu width
+     */
+    collapsedWidth: {
+        type: NumberConstructor;
+    };
+    /**
+     * @zh 开启手风琴效果
+     * @en Turn on the accordion effect
+     */
+    accordion: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 是否自动滚动选中项目到可见区域
+     * @en Whether to automatically scroll the selected item to the visible area
+     */
+    autoScrollIntoView: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 是否内置折叠按钮
+     * @en Whether built-in folding button
+     */
+    showCollapseButton: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 选中的菜单项 key 数组
+     * @en The selected menu item key array
+     * @vModel
+     */
+    selectedKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * @zh 默认选中的菜单项 key 数组
+     * @en The key array of the menu items selected by default
+     */
+    defaultSelectedKeys: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    /**
+     * @zh 展开的子菜单 key 数组
+     * @en Expanded submenu key array
+     * @vModel
+     */
+    openKeys: {
+        type: PropType<string[]>;
+    };
+    /**
+     * @zh 默认展开的子菜单 key 数组
+     * @en The default expanded submenu key array
+     */
+    defaultOpenKeys: {
+        type: PropType<string[]>;
+        default: () => never[];
+    };
+    /**
+     * @zh 滚动到可见区域的配置项，接收所有[scroll-into-view-if-needed](https://github.com/stipsan/scroll-into-view-if-needed)的参数
+     * @en Scroll to the configuration items in the visible area and receive all the parameters of [scroll-into-view-if-needed](https://github.com/stipsan/scroll-into-view-if-needed)
+     */
+    scrollConfig: {
+        type: PropType<{
+            [key: string]: any;
+        }>;
+    };
+    /**
+     * @zh 弹出模式下可接受所有 `Trigger` 的 `Props`
+     * @en Accept all `Props` of `Trigger` in pop-up mode
+     */
+    triggerProps: {
+        type: PropType<TriggerProps>;
+    };
+    /**
+     * @zh 弹出模式下可接受所有 `ToolTip` 的 `Props`
+     * @en Accept all `Props` of `ToolTip` in pop-up mode
+     */
+    tooltipProps: {
+        type: ObjectConstructor;
+    };
+    /**
+     * @zh 默认展开选中的菜单
+     * @en Expand the selected menus by default
+     * @version 2.8.0
+     */
+    autoOpenSelected: {
+        type: BooleanConstructor;
+    };
+    /**
+     * @zh 响应式的断点, 详见[响应式栅格](/vue/component/grid)
+     * @en Responsive breakpoints, see [Responsive Grid](/vue/component/grid) for details
+     * @version 2.18.0
+     */
+    breakpoint: {
+        type: PropType<"xxl" | "xl" | "lg" | "md" | "sm" | "xs">;
+    };
+    /**
+     * @zh 弹出框的最大高度
+     * @en The maximum height of popover
+     * @version 2.23.0
+     */
+    popupMaxHeight: {
+        type: PropType<boolean | number>;
+        default: boolean;
+    };
+    prefixCls: {
+        type: StringConstructor;
+    };
+    inTrigger: {
+        type: BooleanConstructor;
+    };
+    siderCollapsed: {
+        type: BooleanConstructor;
+    };
+    isRoot: {
+        type: BooleanConstructor;
+    };
+}>> & Readonly<{
+    onCollapse?: ((...args: any[]) => any) | undefined;
+    "onUpdate:collapsed"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:selectedKeys"?: ((...args: any[]) => any) | undefined;
+    "onUpdate:openKeys"?: ((...args: any[]) => any) | undefined;
+    "onMenu-item-click"?: ((...args: any[]) => any) | undefined;
+    "onSub-menu-click"?: ((...args: any[]) => any) | undefined;
+}>, {
+    mode: "horizontal" | "vertical" | "pop" | "popButton";
+    popupMaxHeight: number | boolean;
+    collapsed: boolean;
+    theme: "dark" | "light";
+    defaultCollapsed: boolean;
+    autoScrollIntoView: boolean;
+    inTrigger: boolean;
+    siderCollapsed: boolean;
+    isRoot: boolean;
+    autoOpen: boolean;
+    accordion: boolean;
+    showCollapseButton: boolean;
+    defaultSelectedKeys: string[];
+    defaultOpenKeys: string[];
+    autoOpenSelected: boolean;
+}, {}, {
+    IconMenuFold: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        size: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: undefined;
+        };
+        rotate: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        spin: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        color: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        fillColor: {
+            type: ArrayConstructor;
+            default: undefined;
+        };
+    }>, () => VNode, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        size: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: undefined;
+        };
+        rotate: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        spin: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        color: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        fillColor: {
+            type: ArrayConstructor;
+            default: undefined;
+        };
+    }>> & Readonly<{}>, {
+        size: string | number;
+        rotate: number;
+        spin: boolean;
+        color: string;
+        fillColor: unknown[];
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    IconMenuUnfold: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        size: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: undefined;
+        };
+        rotate: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        spin: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        color: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        fillColor: {
+            type: ArrayConstructor;
+            default: undefined;
+        };
+    }>, () => VNode, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        size: {
+            type: (StringConstructor | NumberConstructor)[];
+            default: undefined;
+        };
+        rotate: {
+            type: NumberConstructor;
+            default: undefined;
+        };
+        spin: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        color: {
+            type: StringConstructor;
+            default: undefined;
+        };
+        fillColor: {
+            type: ArrayConstructor;
+            default: undefined;
+        };
+    }>> & Readonly<{}>, {
+        size: string | number;
+        rotate: number;
+        spin: boolean;
+        color: string;
+        fillColor: unknown[];
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/menu/context.d.ts

@@ -0,0 +1,26 @@
+import { InjectionKey, VNodeTypes } from 'vue';
+import { InternalMenuProps, MenuData } from './interface';
+export declare const MenuInjectionKey: InjectionKey<MenuContext>;
+export type MenuContext = Readonly<Pick<InternalMenuProps, 'mode' | 'theme' | 'levelIndent' | 'autoScrollIntoView' | 'scrollConfig' | 'inTrigger' | 'triggerProps' | 'tooltipProps' | 'popupMaxHeight'> & {
+    selectedKeys: string[];
+    openKeys: string[];
+    prefixCls: string;
+    collapsed: boolean;
+    expandIconDown?: () => VNodeTypes;
+    expandIconRight?: () => VNodeTypes;
+    onSubMenuClick?: (key: string, level: number) => void;
+    onMenuItemClick?: (key: string) => void;
+}>;
+export declare const LevelInjectionKey: InjectionKey<LevelContext>;
+export type LevelContext = Readonly<{
+    level: number;
+}>;
+export type MenuMapType = Map<string, string[]>;
+export declare const DataCollectorInjectionKey: InjectionKey<DataCollectorContext>;
+export type DataCollectorContext = Readonly<{
+    collectSubMenu: (key: string, children: MenuData, isReport?: boolean) => void;
+    removeSubMenu: (key: string) => void;
+    collectMenuItem: (key: string) => void;
+    removeMenuItem: (keys: string) => void;
+    reportMenuData: (data: MenuData) => void;
+}>;

package/dist/components/menu/hooks/use-level.d.ts

@@ -0,0 +1,7 @@
+import { Ref } from 'vue';
+export declare function provideLevel(level: Ref<number> | number): void;
+export default function useLevel(props?: {
+    provideNextLevel?: boolean;
+}): {
+    level: import('vue').ComputedRef<number>;
+};

package/dist/components/menu/hooks/use-menu-context.d.ts

@@ -0,0 +1,2 @@
+import { MenuContext } from '../context';
+export default function useMenuContext(): Partial<MenuContext>;

package/dist/components/menu/hooks/use-menu-data-collector.d.ts

@@ -0,0 +1,22 @@
+import { MenuData } from '../interface';
+export declare function useMenuDataCollectorContext(isRoot?: boolean): Readonly<{
+    collectSubMenu: (key: string, children: MenuData, isReport?: boolean) => void;
+    removeSubMenu: (key: string) => void;
+    collectMenuItem: (key: string) => void;
+    removeMenuItem: (keys: string) => void;
+    reportMenuData: (data: MenuData) => void;
+}> | undefined;
+export default function useMenuDataCollector(props: {
+    key?: string | undefined;
+    type: 'menu' | 'popupMenu' | 'subMenu';
+}): {
+    menuData: import('vue').Ref<{
+        key: string;
+        children?: /*elided*/ any[] | undefined;
+    }[], MenuData | {
+        key: string;
+        children?: /*elided*/ any[] | undefined;
+    }[]>;
+    subMenuKeys: import('vue').ComputedRef<string[]>;
+    menuItemKeys: import('vue').ComputedRef<string[]>;
+};

package/dist/components/menu/hooks/use-menu-open-state.d.ts

@@ -0,0 +1,18 @@
+import { MenuData } from '../interface';
+interface MenuOpenStateProps {
+    modelValue: string[] | undefined;
+    defaultValue: string[] | undefined;
+    autoOpen: boolean;
+    autoOpenSelected: boolean;
+    selectedKeys: string[];
+    subMenuKeys: string[];
+    menuData: MenuData;
+    accordion: boolean;
+}
+export default function useMenuOpenState(props: MenuOpenStateProps): {
+    openKeys: import('vue').ComputedRef<string[]>;
+    localOpenKeys: import('vue').Ref<string[], string[]>;
+    setOpenKeys: (val: string[]) => void;
+    open(key: string, level: number): string[];
+};
+export {};

package/dist/components/menu/hooks/use-menu.d.ts

@@ -0,0 +1,4 @@
+import { ComputedRef } from 'vue';
+export default function useMenu(): {
+    key: ComputedRef<string>;
+};

package/dist/components/menu/interface.d.ts

@@ -0,0 +1,71 @@
+import { StyleValue } from 'vue';
+import { Breakpoint } from '../../_utils/responsive-observe';
+import { Data } from '../../_utils/types';
+import { TriggerProps } from '../trigger-v2/interface';
+export type MenuTheme = 'light' | 'dark';
+export type MenuMode = 'vertical' | 'horizontal' | 'pop' | 'popButton';
+export interface SubMenuChildDataType {
+    key: string;
+    children?: SubMenuChildDataType[];
+}
+export type PopupMenuMaxHeightType = boolean | number;
+export interface MenuProps {
+    style: StyleValue | undefined;
+    theme: MenuTheme | undefined;
+    mode: MenuMode;
+    levelIndent: number | undefined;
+    autoOpen: boolean;
+    collapsed: boolean | undefined;
+    defaultCollapsed: boolean;
+    collapsedWidth: number | undefined;
+    accordion: boolean;
+    autoScrollIntoView: boolean;
+    showCollapseButton: boolean;
+    selectedKeys: string[] | undefined;
+    defaultSelectedKeys: string[];
+    openKeys: string[] | undefined;
+    defaultOpenKeys: string[];
+    scrollConfig: {
+        [key: string]: any;
+    } | undefined;
+    triggerProps: TriggerProps | undefined;
+    tooltipProps: Data | undefined;
+    autoOpenSelected: boolean;
+    breakpoint: Breakpoint | undefined;
+    popupMaxHeight: PopupMenuMaxHeightType;
+}
+export interface InternalMenuProps extends MenuProps {
+    prefixCls: string | undefined;
+    inTrigger: boolean;
+    siderCollapsed: boolean;
+    isRoot: boolean;
+}
+export interface MenuSubMenuProps {
+    key: string | undefined;
+    title: string | undefined;
+    selectable: boolean;
+    popup: boolean | ((level: number) => boolean);
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+}
+export interface MenuItemGroupProps {
+    title: string | undefined;
+}
+export interface MenuItemProps {
+    key: string | undefined;
+    disabled?: boolean;
+}
+export interface SubMenuInlineProps {
+    title: string | undefined;
+    isChildrenSelected: boolean;
+}
+export interface SubMenuPopProps {
+    title: string | undefined;
+    selectable: boolean;
+    isChildrenSelected: boolean;
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+}
+export interface MenuDataItem {
+    key: string;
+    children?: MenuData;
+}
+export type MenuData = MenuDataItem[];

package/dist/components/menu/item-group.vue.d.ts

@@ -0,0 +1,24 @@
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 菜单组的标题
+     * @en The title of the menu group
+     */
+    title: {
+        type: StringConstructor;
+    };
+}>, {
+    prefixCls: import('vue').ComputedRef<string | undefined>;
+    classNames: import('vue').ComputedRef<string[]>;
+    level: import('vue').ComputedRef<number>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * @zh 菜单组的标题
+     * @en The title of the menu group
+     */
+    title: {
+        type: StringConstructor;
+    };
+}>> & Readonly<{}>, {}, {}, {
+    MenuIndent: import('vue').DefineComponent<{}, {}, any>;
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/menu/overflow-wrap.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, () => VNode, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;