@alifd/next/lib/nav/api-schema.json

A configurable component library for web built on React.

{
  "name": "Nav",
  "props": {
    "children": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "导航项和子导航",
      "docblock": "导航项和子导航"
    },
    "onItemClick": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "点击菜单项触发的回调函数",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "点击菜单项触发的回调函数\n@param {String} key 点击的菜单项的 key 值\n@param {Object} item 点击的菜单项对象\n@param {Object} event 点击的事件对象",
      "params": [
        {
          "name": "key",
          "description": "点击的菜单项的 key 值",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "item",
          "description": "点击的菜单项对象",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "event",
          "description": "点击的事件对象",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "openKeys": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "array"
          }
        ]
      },
      "required": false,
      "description": "当前打开的子菜单的 key 值",
      "docblock": "当前打开的子菜单的 key 值"
    },
    "defaultOpenKeys": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "array"
          }
        ]
      },
      "required": false,
      "description": "初始打开的子菜单的 key 值",
      "defaultValue": {
        "value": "[]",
        "computed": false
      },
      "docblock": "初始打开的子菜单的 key 值"
    },
    "defaultOpenAll": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "首次渲染展开所有的子导航，只在 mode 设置为 'inline' 以及 openMode 设置为 'multiple' 下生效",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "首次渲染展开所有的子导航，只在 mode 设置为 'inline' 以及 openMode 设置为 'multiple' 下生效"
    },
    "onOpen": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "打开或关闭子菜单触发的回调函数",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "打开或关闭子菜单触发的回调函数\n@param {Array} key 打开的所有子菜单的 key 值\n@param {Object} extra 额外参数\n@param {String} extra.key 当前操作子菜单的 key 值\n@param {Boolean} extra.open 是否是打开",
      "params": [
        {
          "name": "key",
          "description": "打开的所有子菜单的 key 值",
          "type": {
            "name": "Array"
          }
        },
        {
          "name": "extra",
          "description": "额外参数",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "extra.key",
          "description": "当前操作子菜单的 key 值",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "extra.open",
          "description": "是否是打开",
          "type": {
            "name": "Boolean"
          }
        }
      ],
      "returns": null
    },
    "mode": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'inline'",
            "computed": false
          },
          {
            "value": "'popup'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "子导航打开的模式（水平导航只支持弹出）",
      "defaultValue": {
        "value": "'inline'",
        "computed": false
      },
      "docblock": "子导航打开的模式（水平导航只支持弹出）\n@eumdesc 行内, 弹出"
    },
    "triggerType": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'click'",
            "computed": false
          },
          {
            "value": "'hover'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "子导航打开的触发方式",
      "defaultValue": {
        "value": "'click'",
        "computed": false
      },
      "docblock": "子导航打开的触发方式"
    },
    "openMode": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'single'",
            "computed": false
          },
          {
            "value": "'multiple'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "内联子导航的展开模式，同时可以展开一个同级子导航还是多个同级子导航，该属性仅在 mode 为 inline 时生效",
      "defaultValue": {
        "value": "'multiple'",
        "computed": false
      },
      "docblock": "内联子导航的展开模式，同时可以展开一个同级子导航还是多个同级子导航，该属性仅在 mode 为 inline 时生效\n@eumdesc 一个, 多个"
    },
    "inlineIndent": {
      "type": {
        "name": "number"
      },
      "required": false,
      "description": "内联子导航缩进距离",
      "defaultValue": {
        "value": "20",
        "computed": false
      },
      "docblock": "内联子导航缩进距离"
    },
    "popupAutoWidth": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否自动让弹层的宽度和菜单项保持一致，如果弹层的宽度比菜单项小则和菜单项保持一致，如果宽度大于菜单项则不做处理",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否自动让弹层的宽度和菜单项保持一致，如果弹层的宽度比菜单项小则和菜单项保持一致，如果宽度大于菜单项则不做处理"
    },
    "popupAlign": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'follow'",
            "computed": false
          },
          {
            "value": "'outside'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "弹出子导航的对齐方式（水平导航只支持 follow ）",
      "defaultValue": {
        "value": "'follow'",
        "computed": false
      },
      "docblock": "弹出子导航的对齐方式（水平导航只支持 follow ）\n@eumdesc Item 顶端对齐, Nav 顶端对齐"
    },
    "popupProps": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "object"
          },
          {
            "name": "func"
          }
        ]
      },
      "required": false,
      "description": "弹层自定义 props",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "弹层自定义 props"
    },
    "popupClassName": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "弹出子导航的自定义类名",
      "docblock": "弹出子导航的自定义类名"
    },
    "popupStyle": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "弹出子菜单自定义 style",
      "docblock": "弹出子菜单自定义 style",
      "properties": []
    },
    "selectedKeys": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "array"
          }
        ]
      },
      "required": false,
      "description": "当前选中导航项的 key 值",
      "docblock": "当前选中导航项的 key 值"
    },
    "defaultSelectedKeys": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "array"
          }
        ]
      },
      "required": false,
      "description": "初始选中导航项的 key 值",
      "defaultValue": {
        "value": "[]",
        "computed": false
      },
      "docblock": "初始选中导航项的 key 值"
    },
    "onSelect": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "选中或取消选中导航项触发的回调函数",
      "docblock": "选中或取消选中导航项触发的回调函数\n@param {Array} selectedKeys 选中的所有导航项的 key\n@param {Object} item 选中或取消选中的导航项\n@param {Object} extra 额外参数\n@param {Boolean} extra.select 是否是选中\n@param {Array} extra.key 导航项的 key\n@param {Object} extra.label 导航项的文本\n@param {Array} extra.keyPath 导航项 key 的路径",
      "params": [
        {
          "name": "selectedKeys",
          "description": "选中的所有导航项的 key",
          "type": {
            "name": "Array"
          }
        },
        {
          "name": "item",
          "description": "选中或取消选中的导航项",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "extra",
          "description": "额外参数",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "extra.select",
          "description": "是否是选中",
          "type": {
            "name": "Boolean"
          }
        },
        {
          "name": "extra.key",
          "description": "导航项的 key",
          "type": {
            "name": "Array"
          }
        },
        {
          "name": "extra.label",
          "description": "导航项的文本",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "extra.keyPath",
          "description": "导航项 key 的路径",
          "type": {
            "name": "Array"
          }
        }
      ],
      "returns": null
    },
    "selectMode": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'single'",
            "computed": false
          },
          {
            "value": "'multiple'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "选中模式，单选还是多选，默认无值，不可选",
      "docblock": "选中模式，单选还是多选，默认无值，不可选"
    },
    "shallowSelect": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否只能选择第一层菜单项（不能选择子菜单中的菜单项）",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否只能选择第一层菜单项（不能选择子菜单中的菜单项）"
    },
    "hasSelectedIcon": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示选中图标，如果设置为 false 需配合配置平台设置选中时的背景色以示区分",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "是否显示选中图标，如果设置为 false 需配合配置平台设置选中时的背景色以示区分"
    },
    "isSelectIconRight": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否将选中图标居右，仅当 hasSelectedIcon 为true 时生效。\n注意：SubMenu 上的选中图标一直居左，不受此API控制",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否将选中图标居右，仅当 hasSelectedIcon 为true 时生效。\n注意：SubMenu 上的选中图标一直居左，不受此API控制"
    },
    "direction": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'hoz'",
            "computed": false,
            "description": "水平"
          },
          {
            "value": "'ver'",
            "computed": false,
            "description": "垂直"
          }
        ]
      },
      "required": false,
      "description": "导航布局",
      "defaultValue": {
        "value": "'ver'",
        "computed": false
      },
      "docblock": "导航布局\n@enumdesc 水平, 垂直",
      "value": [
        {
          "value": "'hoz'",
          "computed": false,
          "description": "水平"
        },
        {
          "value": "'ver'",
          "computed": false,
          "description": "垂直"
        }
      ]
    },
    "hozAlign": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'left'",
            "computed": false
          },
          {
            "value": "'right'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "横向导航条 items 和 footer 的对齐方向，在 direction 设置为 'hoz' 并且 header 存在时生效",
      "defaultValue": {
        "value": "'left'",
        "computed": false
      },
      "docblock": "横向导航条 items 和 footer 的对齐方向，在 direction 设置为 'hoz' 并且 header 存在时生效"
    },
    "hozInLine": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "横向菜单模式下，是否维持在一行，即超出一行折叠成 SubMenu 显示， 仅在 direction='hoz' mode='popup' 时生效",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "横向菜单模式下，是否维持在一行，即超出一行折叠成 SubMenu 显示， 仅在 direction='hoz' mode='popup' 时生效"
    },
    "header": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "自定义导航头部",
      "docblock": "自定义导航头部"
    },
    "footer": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "自定义导航尾部",
      "docblock": "自定义导航尾部"
    },
    "autoFocus": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否自动获得焦点",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否自动获得焦点"
    },
    "focusedKey": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "当前获得焦点的子菜单或菜单项 key 值",
      "docblock": "当前获得焦点的子菜单或菜单项 key 值"
    },
    "embeddable": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否开启嵌入式模式，一般用于Layout的布局中，开启后没有默认背景、外层border、box-shadow，可以配合`<Nav style={{lineHeight: '100px'}}>` 自定义高度",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否开启嵌入式模式，一般用于Layout的布局中，开启后没有默认背景、外层border、box-shadow，可以配合`<Nav style={{lineHeight: '100px'}}>` 自定义高度\n@version 1.18",
      "version": {
        "value": "1.18",
        "computed": false
      }
    },
    "icons": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "可配置的icons，包括 select 等",
      "defaultValue": {
        "value": "{}",
        "computed": false
      },
      "docblock": "可配置的icons，包括 select 等",
      "properties": []
    },
    "type": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'normal'",
            "computed": false,
            "description": "普通"
          },
          {
            "value": "'primary'",
            "computed": false,
            "description": "主要"
          },
          {
            "value": "'secondary'",
            "computed": false,
            "description": "次要"
          },
          {
            "value": "'line'",
            "computed": false,
            "description": "线形"
          }
        ]
      },
      "required": false,
      "description": "导航类型",
      "defaultValue": {
        "value": "'normal'",
        "computed": false
      },
      "docblock": "导航类型\n@enumdesc 普通, 主要, 次要, 线形",
      "value": [
        {
          "value": "'normal'",
          "computed": false,
          "description": "普通"
        },
        {
          "value": "'primary'",
          "computed": false,
          "description": "主要"
        },
        {
          "value": "'secondary'",
          "computed": false,
          "description": "次要"
        },
        {
          "value": "'line'",
          "computed": false,
          "description": "线形"
        }
      ]
    },
    "activeDirection": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "null",
            "computed": false,
            "description": "无"
          },
          {
            "value": "'top'",
            "computed": false,
            "description": "上"
          },
          {
            "value": "'bottom'",
            "computed": false,
            "description": "下"
          },
          {
            "value": "'left'",
            "computed": false,
            "description": "左"
          },
          {
            "value": "'right'",
            "computed": false,
            "description": "右"
          }
        ]
      },
      "required": false,
      "description": "设置组件选中状态的 active 边方向",
      "docblock": "设置组件选中状态的 active 边方向\n@enumdesc 无, 上, 下, 左, 右\n@default 当 direction 为 'hoz' 时，默认值为 'bottom'，当 direction 为 'ver' 时，默认值为 'left'",
      "value": [
        {
          "value": "null",
          "computed": false,
          "description": "无"
        },
        {
          "value": "'top'",
          "computed": false,
          "description": "上"
        },
        {
          "value": "'bottom'",
          "computed": false,
          "description": "下"
        },
        {
          "value": "'left'",
          "computed": false,
          "description": "左"
        },
        {
          "value": "'right'",
          "computed": false,
          "description": "右"
        }
      ],
      "defaultValue": {
        "value": "当 direction 为 'hoz' 时，默认值为 'bottom'，当 direction 为 'ver' 时，默认值为 'left'",
        "computed": false
      }
    },
    "iconOnly": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否只显示图标",
      "docblock": "是否只显示图标"
    },
    "iconOnlyWidth": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "number"
          }
        ]
      },
      "required": false,
      "description": "iconOnly 模式下的宽度（仅在 iconOnly=true 时生效） 如果传入了iconOnlyWidth，那么会隐藏文本，例如 Nav.Item 的 label",
      "docblock": "iconOnly 模式下的宽度（仅在 iconOnly=true 时生效） 如果传入了iconOnlyWidth，那么会隐藏文本，例如 Nav.Item 的 label"
    },
    "iconTextOnly": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "iconOnly模式下是否展示文字（仅在 iconOnly=true 时生效）",
      "docblock": "iconOnly模式下是否展示文字（仅在 iconOnly=true 时生效）"
    },
    "hasArrow": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示右侧的箭头（仅在 iconOnly=true 时生效）",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "是否显示右侧的箭头（仅在 iconOnly=true 时生效）"
    },
    "hasTooltip": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否有 ToolTips （仅在 iconOnly=true 时生效）",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否有 ToolTips （仅在 iconOnly=true 时生效）"
    }
  },
  "methods": [],
  "description": "继承自 `Menu` 的能力请查看 `Menu` 文档",
  "subComponents": [
    {
      "name": "Group",
      "props": {
        "label": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "标签内容",
          "docblock": "标签内容"
        },
        "children": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "导航项和子导航",
          "docblock": "导航项和子导航"
        },
        "className": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "自定义类名",
          "docblock": "自定义类名"
        }
      },
      "methods": [],
      "description": "继承自 `Menu.Group` 的能力请查看 `Menu.Group` 文档"
    },
    {
      "name": "Item",
      "props": {
        "disabled": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否禁用",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否禁用"
        },
        "helper": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "帮助文本",
          "docblock": "帮助文本"
        },
        "children": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "导航内容",
          "docblock": "导航内容"
        },
        "icon": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "node"
              }
            ]
          },
          "required": false,
          "description": "自定义图标，可以使用 Icon 的 type，也可以使用组件 `<Icon type=\"icon type\" />`",
          "docblock": "自定义图标，可以使用 Icon 的 type，也可以使用组件 `<Icon type=\"icon type\" />`"
        }
      },
      "methods": [],
      "description": "继承自 `Menu.Item` 的能力请查看 `Menu.Item` 文档"
    },
    {
      "name": "PopupItem",
      "props": {
        "label": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "标签内容",
          "docblock": "标签内容"
        },
        "children": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "弹出内容",
          "docblock": "弹出内容"
        },
        "triggerType": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'click'",
                "computed": false
              },
              {
                "value": "'hover'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "子菜单打开的触发行为",
          "docblock": "子菜单打开的触发行为"
        },
        "className": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "自定义类名",
          "docblock": "自定义类名"
        },
        "icon": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "node"
              }
            ]
          },
          "required": false,
          "description": "自定义图标，可以使用 Icon 的 type, 也可以使用组件 `<Icon type=\"icon type\" />`",
          "docblock": "自定义图标，可以使用 Icon 的 type, 也可以使用组件 `<Icon type=\"icon type\" />`"
        }
      },
      "methods": [],
      "description": "继承自 `Menu.PopupItem` 的能力请查看 `Menu.PopupItem` 文档"
    },
    {
      "name": "SubNav",
      "props": {
        "className": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "自定义类名",
          "docblock": "自定义类名"
        },
        "icon": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "node"
              }
            ]
          },
          "required": false,
          "description": "自定义图标，可以使用 Icon 的 type，也可以使用组件 `<Icon type=\"your type\" />`",
          "docblock": "自定义图标，可以使用 Icon 的 type，也可以使用组件 `<Icon type=\"your type\" />`"
        },
        "label": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "标签内容",
          "docblock": "标签内容"
        },
        "selectable": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否可选",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否可选"
        },
        "children": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "导航项和子导航",
          "docblock": "导航项和子导航"
        },
        "noIcon": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否需要提示当前项可展开的 icon，默认是有的",
          "docblock": "是否需要提示当前项可展开的 icon，默认是有的"
        }
      },
      "methods": [],
      "description": "继承自 `Menu.SubMenu` 的能力请查看 `Menu.SubMenu` 文档"
    }
  ]
}