x-next 1.13.0 → 1.15.0

package/AI_USAGE/components/menu-api.md

@@ -0,0 +1,516 @@
+<!-- Generated by pnpm generate:ai-usage. Edit script/ai-usage/content.md and script/ai-usage/. -->
+# Menu 完整公开 API
+
+适用版本：x-next@1.15.0；来源指纹：`47ea153587c8d0b3bf318977b10bde9f8dd4acff90c5818541ba6513252ad362`。
+
+从同版本构建的公开声明、运行时 props/emits 和显式 expose 生成。运行时导入始终使用 `x-next`，声明路径仅作定位。插槽类型未细化时，具体槽名与作用域见本地用法示例。
+
+## Menu API
+
+公开声明：`dist/components/menu/index.d.ts`。 类型中的 undefined 表示可省略；原始 prop 默认值不等于继承配置或服务默认值。
+
+### Props
+
+| 名称 | 用途 | 公开类型 | 必填 | 声明默认值 |
+| --- | --- | --- | --- | --- |
+| theme | 菜单主题 | undefined &#124; "dark" &#124; "light" | 否 | 未声明 |
+| mode | 菜单模式 | undefined &#124; "horizontal" &#124; "vertical" &#124; "pop" &#124; "popButton" | 否 | "vertical" |
+| popupMaxHeight | 弹出框最大高度 | undefined &#124; number &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| triggerProps | 弹出模式下传给 Trigger 的配置 | undefined &#124; TriggerProps | 否 | 透传内层组件；默认值见对应组件 |
+| collapsed | 是否折叠，可配合 v-model:collapsed 使用 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| defaultCollapsed | 默认是否折叠 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| collapsedWidth | 折叠菜单宽度 | undefined &#124; number | 否 | 透传内层组件；默认值见对应组件 |
+| breakpoint | 响应式折叠断点 | undefined &#124; "xs" &#124; "sm" &#124; "md" &#124; "lg" &#124; "xl" &#124; "xxl" | 否 | 透传内层组件；默认值见对应组件 |
+| autoScrollIntoView | 是否自动滚动选中项到可见区域 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| autoOpen | 是否默认展开所有多级菜单 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| accordion | 是否开启手风琴效果 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| showCollapseButton | 是否显示内置折叠按钮 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| defaultSelectedKeys | 默认选中的菜单项 key | undefined &#124; string[] | 否 | 透传内层组件；默认值见对应组件 |
+| defaultOpenKeys | 默认展开的子菜单 key | undefined &#124; string[] | 否 | 透传内层组件；默认值见对应组件 |
+| autoOpenSelected | 初始化时展开选中项所在子菜单 | undefined &#124; false &#124; true | 否 | 透传内层组件；默认值见对应组件 |
+| levelIndent | 层级缩进 | undefined &#124; number | 否 | 透传内层组件；默认值见对应组件 |
+| scrollConfig | 滚动到可见区域配置 | undefined &#124; { [key: string]: any; } | 否 | 透传内层组件；默认值见对应组件 |
+| tooltipProps | 折叠 Tooltip 配置 | undefined &#124; { [x: string]: any; } | 否 | 透传内层组件；默认值见对应组件 |
+| selectedKeys | 选中的菜单项 key | undefined &#124; string[] | 否 | 透传内层组件；默认值见对应组件 |
+| openKeys | 展开的子菜单 key | undefined &#124; string[] | 否 | 透传内层组件；默认值见对应组件 |
+
+### Events
+
+| 事件 | 用途 | 监听器签名（即事件参数） |
+| --- | --- | --- |
+| collapse | 折叠状态变化时触发 | undefined &#124; (...args: any[]) => any |
+| update:collapsed | 折叠状态变化时触发 | undefined &#124; (...args: any[]) => any |
+| update:selectedKeys | 选中项变化时触发 | undefined &#124; (...args: any[]) => any |
+| update:openKeys | 展开项变化时触发 | undefined &#124; (...args: any[]) => any |
+| menu-item-click | 见场景用法与类型 | undefined &#124; (...args: any[]) => any |
+| sub-menu-click | 见场景用法与类型 | undefined &#124; (...args: any[]) => any |
+
+### Slots
+
+| 名称 | 用途 | 公开类型 |
+| --- | --- | --- |
+| 组件 | 插槽名 | 文档列出的实际插槽；公开类型未细化，作用域见场景用法 |
+| Menu | default | 文档列出的实际插槽；公开类型未细化，作用域见场景用法 |
+| MenuItem | default | 文档列出的实际插槽；公开类型未细化，作用域见场景用法 |
+| MenuSubMenu | default | 文档列出的实际插槽；公开类型未细化，作用域见场景用法 |
+| MenuItemGroup | title | 文档列出的实际插槽；公开类型未细化，作用域见场景用法 |
+
+### 实例方法
+
+没有检索到显式 expose 或 Options API methods 的公开方法；不把 setup 内部函数当成稳定实例 API。
+
+### 关联类型定义
+
+以下摘自本组件族声明，供查阅嵌套配置；运行时和值类型均以根入口可导出项为准。
+
+```typescript-reference
+type MenuTheme = 'light' | 'dark';
+
+type MenuMode = 'vertical' | 'horizontal' | 'pop' | 'popButton';
+
+interface SubMenuChildDataType {
+    key: string;
+    children?: SubMenuChildDataType[];
+}
+
+type PopupMenuMaxHeightType = boolean | number;
+
+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;
+}
+
+interface InternalMenuProps extends MenuProps {
+    prefixCls: string | undefined;
+    inTrigger: boolean;
+    siderCollapsed: boolean;
+    isRoot: boolean;
+}
+
+interface MenuSubMenuProps {
+    key: string | undefined;
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    popup: boolean | ((level: number) => boolean);
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuItemGroupProps {
+    title: string | undefined;
+}
+
+interface MenuItemProps {
+    key: string | undefined;
+    disabled?: boolean;
+}
+
+interface SubMenuInlineProps {
+    title: string | undefined;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    _internalSkipCollect?: boolean;
+}
+
+interface SubMenuPopProps {
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuDataItem {
+    key: string;
+    children?: MenuData;
+}
+
+type MenuData = MenuDataItem[];
+
+type MenuSubMenuPublicProps = ExtractPublicPropTypes<typeof menuSubMenuProps>;
+```
+
+
+## MenuItem API
+
+公开声明：`dist/components/menu/index.d.ts`。 类型中的 undefined 表示可省略；原始 prop 默认值不等于继承配置或服务默认值。
+
+### Props
+
+| 名称 | 用途 | 公开类型 | 必填 | 声明默认值 |
+| --- | --- | --- | --- | --- |
+| disabled | 是否禁用 | undefined &#124; false &#124; true | 否 | false |
+| _internalSkipCollect | 见场景用法与类型 | undefined &#124; false &#124; true | 否 | false（Vue Boolean 转换） |
+
+### Events
+
+| 事件 | 用途 | 监听器签名（即事件参数） |
+| --- | --- | --- |
+| click | 见场景用法与类型 | undefined &#124; (...args: any[]) => any |
+
+### Slots
+
+公开类型未逐项声明插槽；本页场景说明列出实际使用的插槽，不将任意插槽视为已支持。
+
+### 实例方法
+
+没有检索到显式 expose 或 Options API methods 的公开方法；不把 setup 内部函数当成稳定实例 API。
+
+### 关联类型定义
+
+以下摘自本组件族声明，供查阅嵌套配置；运行时和值类型均以根入口可导出项为准。
+
+```typescript-reference
+type MenuTheme = 'light' | 'dark';
+
+type MenuMode = 'vertical' | 'horizontal' | 'pop' | 'popButton';
+
+interface SubMenuChildDataType {
+    key: string;
+    children?: SubMenuChildDataType[];
+}
+
+type PopupMenuMaxHeightType = boolean | number;
+
+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;
+}
+
+interface InternalMenuProps extends MenuProps {
+    prefixCls: string | undefined;
+    inTrigger: boolean;
+    siderCollapsed: boolean;
+    isRoot: boolean;
+}
+
+interface MenuSubMenuProps {
+    key: string | undefined;
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    popup: boolean | ((level: number) => boolean);
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuItemGroupProps {
+    title: string | undefined;
+}
+
+interface MenuItemProps {
+    key: string | undefined;
+    disabled?: boolean;
+}
+
+interface SubMenuInlineProps {
+    title: string | undefined;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    _internalSkipCollect?: boolean;
+}
+
+interface SubMenuPopProps {
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuDataItem {
+    key: string;
+    children?: MenuData;
+}
+
+type MenuData = MenuDataItem[];
+
+type MenuSubMenuPublicProps = ExtractPublicPropTypes<typeof menuSubMenuProps>;
+```
+
+
+## MenuItemGroup API
+
+公开声明：`dist/components/menu/index.d.ts`。 类型中的 undefined 表示可省略；原始 prop 默认值不等于继承配置或服务默认值。
+
+### Props
+
+| 名称 | 用途 | 公开类型 | 必填 | 声明默认值 |
+| --- | --- | --- | --- | --- |
+| title | 分组标题 | undefined &#124; string | 否 | 未声明 |
+
+### Events
+
+未声明组件 emits；原生事件与包装透传按本页用法核实。
+
+### Slots
+
+公开类型未逐项声明插槽；本页场景说明列出实际使用的插槽，不将任意插槽视为已支持。
+
+### 实例方法
+
+没有检索到显式 expose 或 Options API methods 的公开方法；不把 setup 内部函数当成稳定实例 API。
+
+### 关联类型定义
+
+以下摘自本组件族声明，供查阅嵌套配置；运行时和值类型均以根入口可导出项为准。
+
+```typescript-reference
+type MenuTheme = 'light' | 'dark';
+
+type MenuMode = 'vertical' | 'horizontal' | 'pop' | 'popButton';
+
+interface SubMenuChildDataType {
+    key: string;
+    children?: SubMenuChildDataType[];
+}
+
+type PopupMenuMaxHeightType = boolean | number;
+
+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;
+}
+
+interface InternalMenuProps extends MenuProps {
+    prefixCls: string | undefined;
+    inTrigger: boolean;
+    siderCollapsed: boolean;
+    isRoot: boolean;
+}
+
+interface MenuSubMenuProps {
+    key: string | undefined;
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    popup: boolean | ((level: number) => boolean);
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuItemGroupProps {
+    title: string | undefined;
+}
+
+interface MenuItemProps {
+    key: string | undefined;
+    disabled?: boolean;
+}
+
+interface SubMenuInlineProps {
+    title: string | undefined;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    _internalSkipCollect?: boolean;
+}
+
+interface SubMenuPopProps {
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuDataItem {
+    key: string;
+    children?: MenuData;
+}
+
+type MenuData = MenuDataItem[];
+
+type MenuSubMenuPublicProps = ExtractPublicPropTypes<typeof menuSubMenuProps>;
+```
+
+
+## MenuSubMenu API
+
+公开声明：`dist/components/menu/index.d.ts`。 类型中的 undefined 表示可省略；原始 prop 默认值不等于继承配置或服务默认值。
+
+### Props
+
+| 名称 | 用途 | 公开类型 | 必填 | 声明默认值 |
+| --- | --- | --- | --- | --- |
+| title | 子菜单标题 | undefined &#124; string | 否 | 未声明 |
+| selectable | 弹出模式下标题是否可选中 | undefined &#124; false &#124; true | 否 | false（Vue Boolean 转换） |
+| disabled | 是否禁用 | undefined &#124; false &#124; true | 否 | false |
+| popup | 是否强制使用弹出模式 | undefined &#124; false &#124; true &#124; (level: number) => boolean | 否 | false |
+| popupMaxHeight | 弹出框最大高度 | undefined &#124; number &#124; false &#124; true | 否 | undefined |
+| _internalSkipCollect | 见场景用法与类型 | undefined &#124; false &#124; true | 否 | false（Vue Boolean 转换） |
+
+### Events
+
+未声明组件 emits；原生事件与包装透传按本页用法核实。
+
+### Slots
+
+公开类型未逐项声明插槽；本页场景说明列出实际使用的插槽，不将任意插槽视为已支持。
+
+### 实例方法
+
+没有检索到显式 expose 或 Options API methods 的公开方法；不把 setup 内部函数当成稳定实例 API。
+
+### 关联类型定义
+
+以下摘自本组件族声明，供查阅嵌套配置；运行时和值类型均以根入口可导出项为准。
+
+```typescript-reference
+type MenuTheme = 'light' | 'dark';
+
+type MenuMode = 'vertical' | 'horizontal' | 'pop' | 'popButton';
+
+interface SubMenuChildDataType {
+    key: string;
+    children?: SubMenuChildDataType[];
+}
+
+type PopupMenuMaxHeightType = boolean | number;
+
+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;
+}
+
+interface InternalMenuProps extends MenuProps {
+    prefixCls: string | undefined;
+    inTrigger: boolean;
+    siderCollapsed: boolean;
+    isRoot: boolean;
+}
+
+interface MenuSubMenuProps {
+    key: string | undefined;
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    popup: boolean | ((level: number) => boolean);
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuItemGroupProps {
+    title: string | undefined;
+}
+
+interface MenuItemProps {
+    key: string | undefined;
+    disabled?: boolean;
+}
+
+interface SubMenuInlineProps {
+    title: string | undefined;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    _internalSkipCollect?: boolean;
+}
+
+interface SubMenuPopProps {
+    title: string | undefined;
+    selectable: boolean;
+    disabled?: boolean;
+    isChildrenSelected: boolean;
+    popupMaxHeight: PopupMenuMaxHeightType | undefined;
+    _internalSkipCollect?: boolean;
+}
+
+interface MenuDataItem {
+    key: string;
+    children?: MenuData;
+}
+
+type MenuData = MenuDataItem[];
+
+type MenuSubMenuPublicProps = ExtractPublicPropTypes<typeof menuSubMenuProps>;
+```
+
+
+返回 [Menu 用法](./menu.md)。