common-intellisense
Version:
1,924 lines (1,923 loc) • 331 kB
JSON
[
{
"name": "NutButton",
"description": "按钮用于触发一个操作,如提交表单。",
"description_zh": "按钮用于触发一个操作,如提交表单。",
"tag": "按钮",
"props": {
"type": {
"default": "default",
"value": "",
"type": "string",
"description": "类型,可选值为 primary info warning danger success default",
"description_zh": "类型,可选值为 primary info warning danger success default"
},
"size": {
"default": "normal",
"value": "",
"type": "string",
"description": "尺寸,可选值为 large small mini normal",
"description_zh": "尺寸,可选值为 large small mini normal"
},
"shape": {
"default": "round",
"value": "",
"type": "string",
"description": "形状,可选值为 square round",
"description_zh": "形状,可选值为 square round"
},
"color": {
"default": "-",
"value": "",
"type": "string",
"description": "按钮颜色,支持传入 linear-gradient 渐变色",
"description_zh": "按钮颜色,支持传入 linear-gradient 渐变色"
},
"plain": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否为朴素按钮",
"description_zh": "是否为朴素按钮"
},
"disabled": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否禁用按钮",
"description_zh": "是否禁用按钮"
},
"block": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否为块级元素",
"description_zh": "是否为块级元素"
},
"loading": {
"default": "false",
"value": "",
"type": "boolean",
"description": "按钮 loading 状态",
"description_zh": "按钮 loading 状态"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/button",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/button",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击按钮时触发",
"description_zh": "点击按钮时触发",
"params": "event: MouseEvent"
}
],
"methods": [],
"slots": [
{
"name": "default",
"description": "按钮内容",
"description_zh": "按钮内容"
},
{
"name": "icon",
"description": "按钮图标",
"description_zh": "按钮图标"
}
],
"filename": "Button",
"suggestions": []
},
{
"name": "NutCellGroup",
"description": "列表项,可组成列表。",
"description_zh": "列表项,可组成列表。",
"tag": "单元格",
"props": {
"title": {
"default": "-",
"value": "",
"type": "string",
"description": "分组标题",
"description_zh": "分组标题"
},
"desc": {
"default": "-",
"value": "",
"type": "string",
"description": "分组描述",
"description_zh": "分组描述"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/cell",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/cell",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "title",
"description": "自定义 title 标题区域",
"description_zh": "自定义 title 标题区域"
},
{
"name": "desc",
"description": "自定义 desc 描述区域",
"description_zh": "自定义 desc 描述区域"
}
],
"filename": "CellGroup",
"suggestions": [
"nut-cell"
]
},
{
"name": "NutCell",
"description": "列表项,可组成列表。",
"description_zh": "列表项,可组成列表。",
"tag": "单元格",
"props": {
"title": {
"default": "-",
"value": "",
"type": "string",
"description": "标题名称",
"description_zh": "标题名称"
},
"sub-title": {
"default": "-",
"value": "",
"type": "string",
"description": "左侧副标题",
"description_zh": "左侧副标题"
},
"desc": {
"default": "-",
"value": "",
"type": "string",
"description": "右侧描述",
"description_zh": "右侧描述"
},
"desc-text-align": {
"default": "right",
"value": "",
"type": "string",
"description": "右侧描述文本对齐方式 text-align",
"description_zh": "右侧描述文本对齐方式 text-align"
},
"is-link": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否展示右侧箭头并开启点击反馈",
"description_zh": "是否展示右侧箭头并开启点击反馈"
},
":round-radius": {
"default": "6px",
"value": "",
"type": "number",
"description": "圆角半径",
"description_zh": "圆角半径"
},
"url": {
"default": "-",
"value": "",
"type": "string",
"description": "点击后跳转的链接地址",
"description_zh": "点击后跳转的链接地址"
},
"to": {
"default": "-",
"value": "",
"type": "string | object",
"description": "点击后跳转的目标路由对象,同 vue-router 的 to 属性 属性",
"description_zh": "点击后跳转的目标路由对象,同 vue-router 的 to 属性 属性"
},
"replace": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否在跳转时替换当前页面历史",
"description_zh": "是否在跳转时替换当前页面历史"
},
"center": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否使内容垂直居中",
"description_zh": "是否使内容垂直居中"
},
"size": {
"default": "-",
"value": "",
"type": "string",
"description": "单元格大小,可选值为 large",
"description_zh": "单元格大小,可选值为 large"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/cell",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/cell",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击事件",
"description_zh": "点击事件",
"params": "event:Event"
}
],
"methods": [],
"slots": [
{
"name": "icon",
"description": "自定义左侧 icon 区域",
"description_zh": "自定义左侧 icon 区域"
},
{
"name": "default",
"description": "自定义内容",
"description_zh": "自定义内容"
},
{
"name": "link",
"description": "自定义右侧 link 区域",
"description_zh": "自定义右侧 link 区域"
},
{
"name": "title",
"description": "自定义 title 标题区域",
"description_zh": "自定义 title 标题区域"
},
{
"name": "desc",
"description": "自定义 desc 描述区域",
"description_zh": "自定义 desc 描述区域"
}
],
"filename": "Cell",
"suggestions": []
},
{
"name": "NutConfigProvider",
"description": "用于全局配置 NutUI 组件,提供暗黑模式,动态主题。",
"description_zh": "用于全局配置 NutUI 组件,提供暗黑模式,动态主题。",
"tag": "全局配置",
"props": {
"theme": {
"default": "-",
"value": "",
"type": "string",
"description": "主题风格,设置为 dark 来开启深色模式,全局生效",
"description_zh": "主题风格,设置为 dark 来开启深色模式,全局生效"
},
":theme-vars": {
"default": "-",
"value": "",
"type": "object",
"description": "自定义主题变量",
"description_zh": "自定义主题变量"
},
"tag": {
"default": "div",
"value": "",
"type": "string",
"description": "根节点对应的 HTML 标签名",
"description_zh": "根节点对应的 HTML 标签名"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/configprovider",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/configprovider",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [],
"filename": "ConfigProvider",
"suggestions": []
},
{
"name": "NutImage",
"description": "增强版的 img 标签,提供多种图片填充模式,支持图片加载中提示、加载失败提示。",
"description_zh": "增强版的 img 标签,提供多种图片填充模式,支持图片加载中提示、加载失败提示。",
"tag": "图片",
"props": {
"src": {
"default": "-",
"value": "",
"type": "string",
"description": "图片链接",
"description_zh": "图片链接"
},
"fit": {
"default": "fill",
"value": "",
"type": "ImageFit",
"description": "图片填充模式,等同于原生的 object-fit 属性",
"description_zh": "图片填充模式,等同于原生的 object-fit 属性"
},
"position": {
"default": "center",
"value": "",
"type": "ImagePosition",
"description": "图片位置,等同于原生的 object-position 属性",
"description_zh": "图片位置,等同于原生的 object-position 属性"
},
"alt": {
"default": "-",
"value": "",
"type": "string",
"description": "替代文本",
"description_zh": "替代文本"
},
"width": {
"default": "-",
"value": "",
"type": "string",
"description": "宽度,默认单位 px",
"description_zh": "宽度,默认单位 px"
},
"height": {
"default": "-",
"value": "",
"type": "string",
"description": "高度,默认单位 px",
"description_zh": "高度,默认单位 px"
},
"round": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否显示为圆角",
"description_zh": "是否显示为圆角"
},
"radius": {
"default": "-",
"value": "",
"type": "string | number",
"description": "圆角大小",
"description_zh": "圆角大小"
},
"show-error": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否展示图片加载失败",
"description_zh": "是否展示图片加载失败"
},
"show-loading": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否展示加载中图片",
"description_zh": "是否展示加载中图片"
},
"lazy-load4.0.8": {
"default": "false",
"value": "",
"type": "boolean",
"description": "懒加载",
"description_zh": "懒加载"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/image",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/image",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击图片时触发",
"description_zh": "点击图片时触发",
"params": "event: Event"
},
{
"name": "load",
"description": "图片加载完后触发",
"description_zh": "图片加载完后触发",
"params": "–"
},
{
"name": "error",
"description": "图片加载失败后触发",
"description_zh": "图片加载失败后触发",
"params": "–"
}
],
"methods": [],
"slots": [
{
"name": "loading",
"description": "自定义加载中的提示内容",
"description_zh": "自定义加载中的提示内容"
},
{
"name": "error",
"description": "自定义记载失败的提示内容",
"description_zh": "自定义记载失败的提示内容"
}
],
"filename": "Image",
"suggestions": []
},
{
"name": "NutOverlay",
"description": "创建一个遮罩层,通常用于阻止用户进行其他操作",
"description_zh": "创建一个遮罩层,通常用于阻止用户进行其他操作",
"tag": "遮罩层",
"props": {
"v-model:visible": {
"default": "false",
"value": "",
"type": "boolean",
"description": "控制遮罩的显示/隐藏",
"description_zh": "控制遮罩的显示/隐藏"
},
"z-index": {
"default": "2000",
"value": "",
"type": "string | number",
"description": "自定义遮罩层级",
"description_zh": "自定义遮罩层级"
},
"duration": {
"default": "0.3",
"value": "",
"type": "string | number",
"description": "显示/隐藏的动画时长,单位秒",
"description_zh": "显示/隐藏的动画时长,单位秒"
},
"overlay-class": {
"default": "-",
"value": "",
"type": "string",
"description": "自定义遮罩类名",
"description_zh": "自定义遮罩类名"
},
":overlay-style": {
"default": "-",
"value": "",
"type": "CSSProperties",
"description": "自定义遮罩样式",
"description_zh": "自定义遮罩样式"
},
"lock-scroll": {
"default": "true",
"value": "",
"type": "boolean",
"description": "遮罩显示时的背景是否锁定",
"description_zh": "遮罩显示时的背景是否锁定"
},
"close-on-click-overlay": {
"default": "true",
"value": "",
"type": "boolean",
"description": "点击遮罩时是否关闭",
"description_zh": "点击遮罩时是否关闭"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/overlay",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/overlay",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击时触发",
"description_zh": "点击时触发",
"params": "event: MouseEvent"
}
],
"methods": [],
"slots": [
{
"name": "default",
"description": "内嵌遮罩内容自定义",
"description_zh": "内嵌遮罩内容自定义"
}
],
"filename": "Overlay",
"suggestions": []
},
{
"name": "NutPopup",
"description": "弹出层容器,用于展示弹窗、信息提示等内容,支持多个弹出层叠加展示",
"description_zh": "弹出层容器,用于展示弹窗、信息提示等内容,支持多个弹出层叠加展示",
"tag": "弹出层",
"props": {
"v-model:visible": {
"default": "false",
"value": "",
"type": "boolean",
"description": "控制当前组件显示/隐藏",
"description_zh": "控制当前组件显示/隐藏"
},
"z-index": {
"default": "2000",
"value": "",
"type": "string | number",
"description": "遮罩层级",
"description_zh": "遮罩层级"
},
"duration": {
"default": "0.3",
"value": "",
"type": "string | number",
"description": "组件显示/隐藏的动画时长,单位秒",
"description_zh": "组件显示/隐藏的动画时长,单位秒"
},
"lock-scroll": {
"default": "true",
"value": "",
"type": "boolean",
"description": "背景是否锁定",
"description_zh": "背景是否锁定"
},
"overlay": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否显示遮罩",
"description_zh": "是否显示遮罩"
},
"close-on-click-overlay": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否点击遮罩关闭",
"description_zh": "是否点击遮罩关闭"
},
"position": {
"default": "\"center\"",
"value": "",
"type": "string",
"description": "弹出位置(top,bottom,left,right,center)",
"description_zh": "弹出位置(top,bottom,left,right,center)"
},
"transition": {
"default": "-",
"value": "",
"type": "string",
"description": "动画名",
"description_zh": "动画名"
},
":style": {
"default": "-",
"value": "",
"type": "CSSProperties",
"description": "自定义弹框样式",
"description_zh": "自定义弹框样式"
},
"pop-class": {
"default": "-",
"value": "",
"type": "string",
"description": "自定义弹框类名",
"description_zh": "自定义弹框类名"
},
"closeable": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否显示关闭按钮",
"description_zh": "是否显示关闭按钮"
},
"close-icon-position": {
"default": "\"top-right\"",
"value": "",
"type": "string",
"description": "关闭按钮位置(top-left,top-right,bottom-left,bottom-right)",
"description_zh": "关闭按钮位置(top-left,top-right,bottom-left,bottom-right)"
},
"destroy-on-close": {
"default": "true",
"value": "",
"type": "boolean",
"description": "弹层关闭后 slot内容会不会清空",
"description_zh": "弹层关闭后 slot内容会不会清空"
},
"round": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否显示圆角",
"description_zh": "是否显示圆角"
},
"overlay-class": {
"default": "‘’",
"value": "",
"type": "string",
"description": "自定义遮罩层类名",
"description_zh": "自定义遮罩层类名"
},
"overlay-style": {
"default": "‘’",
"value": "",
"type": "string",
"description": "自定义遮罩层样式",
"description_zh": "自定义遮罩层样式"
},
"safe-area-inset-bottom": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否开启全面屏底部安全区适配,仅当 position 为 bottom 时有效",
"description_zh": "是否开启全面屏底部安全区适配,仅当 position 为 bottom 时有效"
},
"teleport": {
"default": "\"body\"",
"value": "",
"type": "string",
"description": "指定挂载节点",
"description_zh": "指定挂载节点"
},
"teleport-disable": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否挂载节点,false 不挂载,true 挂载",
"description_zh": "是否挂载节点,false 不挂载,true 挂载"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/popup",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/popup",
"typeDetail": {},
"events": [
{
"name": "click-pop",
"description": "点击弹出层时触发",
"description_zh": "点击弹出层时触发",
"params": "event: Event"
},
{
"name": "click-close-icon",
"description": "点击关闭图标时触发",
"description_zh": "点击关闭图标时触发",
"params": "event: Event"
},
{
"name": "open",
"description": "打开弹框时触发",
"description_zh": "打开弹框时触发",
"params": "-"
},
{
"name": "close",
"description": "关闭弹框时触发",
"description_zh": "关闭弹框时触发",
"params": "-"
},
{
"name": "opened",
"description": "遮罩打开动画结束时触发",
"description_zh": "遮罩打开动画结束时触发",
"params": "el: Element"
},
{
"name": "closed",
"description": "遮罩关闭动画结束时触发",
"description_zh": "遮罩关闭动画结束时触发",
"params": "el: Element"
},
{
"name": "click-overlay",
"description": "点击遮罩触发",
"description_zh": "点击遮罩触发",
"params": "event: Event"
}
],
"methods": [],
"slots": [
{
"name": "default",
"description": "自定义内嵌内容",
"description_zh": "自定义内嵌内容"
},
{
"name": "close-icon",
"description": "关闭按钮的自定义图标",
"description_zh": "关闭按钮的自定义图标"
}
],
"filename": "Popup",
"suggestions": []
},
{
"name": "NutDivider",
"description": "用于将内容分隔为多个区域。",
"description_zh": "用于将内容分隔为多个区域。",
"tag": "分割线",
"props": {
"dashed": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否使用虚线",
"description_zh": "是否使用虚线"
},
"hairline": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否使用 0.5px 线",
"description_zh": "是否使用 0.5px 线"
},
"content-position": {
"default": "center",
"value": "",
"type": "string",
"description": "内容位置,可选值为 left、right",
"description_zh": "内容位置,可选值为 left、right"
},
"direction": {
"default": "horizontal",
"value": "",
"type": "string",
"description": "水平还是垂直类型,可选值 vertical",
"description_zh": "水平还是垂直类型,可选值 vertical"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/divider",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/divider",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "default",
"description": "内容,仅在 direction 为 horizontal 时生效",
"description_zh": "内容,仅在 direction 为 horizontal 时生效"
}
],
"filename": "Divider",
"suggestions": []
},
{
"name": "NutGrid",
"description": "用于分隔成等宽区块进行页面导航。",
"description_zh": "用于分隔成等宽区块进行页面导航。",
"tag": "宫格",
"props": {
"column-num": {
"default": "4",
"value": "",
"type": "number | string",
"description": "列数",
"description_zh": "列数"
},
"border": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否显示边框",
"description_zh": "是否显示边框"
},
"gutter": {
"default": "0",
"value": "",
"type": "number | string",
"description": "格子之间的间距,默认单位为 px",
"description_zh": "格子之间的间距,默认单位为 px"
},
"center": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否将格子内容居中显示",
"description_zh": "是否将格子内容居中显示"
},
"square": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否将格子固定为正方形",
"description_zh": "是否将格子固定为正方形"
},
"reverse": {
"default": "false",
"value": "",
"type": "boolean",
"description": "内容翻转",
"description_zh": "内容翻转"
},
"direction": {
"default": "vertical",
"value": "",
"type": "string",
"description": "格子内容排列的方向,可选值为 horizontal",
"description_zh": "格子内容排列的方向,可选值为 horizontal"
},
"clickable": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否开启格子点击反馈",
"description_zh": "是否开启格子点击反馈"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/grid",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/grid",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [],
"filename": "Grid",
"suggestions": [
"nut-grid-item"
]
},
{
"name": "NutGridItem",
"description": "用于分隔成等宽区块进行页面导航。",
"description_zh": "用于分隔成等宽区块进行页面导航。",
"tag": "宫格",
"props": {
"text": {
"default": "-",
"value": "",
"type": "string",
"description": "文字",
"description_zh": "文字"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/grid",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/grid",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击格子时触发",
"description_zh": "点击格子时触发",
"params": "event: Event"
}
],
"methods": [],
"slots": [
{
"name": "default",
"description": "自定义所有内容",
"description_zh": "自定义所有内容"
},
{
"name": "text",
"description": "自定义文字",
"description_zh": "自定义文字"
}
],
"filename": "GridItem",
"suggestions": []
},
{
"name": "NutRow",
"description": "用于快速进行布局",
"description_zh": "用于快速进行布局",
"tag": "布局",
"props": {
"type": {
"default": "-",
"value": "",
"type": "string",
"description": "布局方式,可选值为 flex",
"description_zh": "布局方式,可选值为 flex"
},
"gutter": {
"default": "-",
"value": "",
"type": "string | number",
"description": "列元素之间的间距(单位为px)",
"description_zh": "列元素之间的间距(单位为px)"
},
"justify": {
"default": "start",
"value": "",
"type": "string",
"description": "Flex 主轴对齐方式,可选值为 start end center space-around space-between space-evenly",
"description_zh": "Flex 主轴对齐方式,可选值为 start end center space-around space-between space-evenly"
},
"align": {
"default": "flex-start",
"value": "",
"type": "string",
"description": "Flex 交叉轴对齐方式,可选值为 flex-start center flex-end",
"description_zh": "Flex 交叉轴对齐方式,可选值为 flex-start center flex-end"
},
"flex-wrap": {
"default": "nowrap",
"value": "",
"type": "string",
"description": "Flex 是否换行,可选值为 nowrap wrap reverse",
"description_zh": "Flex 是否换行,可选值为 nowrap wrap reverse"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/layout",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/layout",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击时触发",
"description_zh": "点击时触发",
"params": "event: MouseEvent"
}
],
"methods": [],
"slots": [],
"filename": "Row",
"suggestions": [
"nut-col"
]
},
{
"name": "NutCol",
"description": "用于快速进行布局",
"description_zh": "用于快速进行布局",
"tag": "布局",
"props": {
"span": {
"default": "24",
"value": "",
"type": "string | number",
"description": "列元素宽度(共分为 24 份,例如设置一行 3 个,那么 span 值为 8)",
"description_zh": "列元素宽度(共分为 24 份,例如设置一行 3 个,那么 span 值为 8)"
},
"offset": {
"default": "0",
"value": "",
"type": "string | number",
"description": "列元素偏移距离",
"description_zh": "列元素偏移距离"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/layout",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/layout",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "点击时触发",
"description_zh": "点击时触发",
"params": "event: MouseEvent"
}
],
"methods": [],
"slots": [],
"filename": "Col",
"suggestions": []
},
{
"name": "NutSpace",
"description": "设置元素之间的间距。在 NutUI >= 4.2.0 版本中提供。",
"description_zh": "设置元素之间的间距。在 NutUI >= 4.2.0 版本中提供。",
"tag": "间距",
"props": {
"direction": {
"default": "horizontal",
"value": "",
"type": "string",
"description": "间距方向,可选值 vertical horizontal",
"description_zh": "间距方向,可选值 vertical horizontal"
},
"align": {
"default": "-",
"value": "",
"type": "string",
"description": "交叉轴对齐方式,可选值 start end center baseline",
"description_zh": "交叉轴对齐方式,可选值 start end center baseline"
},
"justify": {
"default": "-",
"value": "",
"type": "string",
"description": "主轴对齐方式,可选值 start end center between around evenly stretch",
"description_zh": "主轴对齐方式,可选值 start end center between around evenly stretch"
},
"wrap": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否自动换行,仅在 horizontal 时有效",
"description_zh": "是否自动换行,仅在 horizontal 时有效"
},
"fill": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否让 Space 变为一个块级元素,填充整个父元素",
"description_zh": "是否让 Space 变为一个块级元素,填充整个父元素"
},
"gutter": {
"default": "-",
"value": "",
"type": "number | string | number[] | string[]",
"description": "间距大小,如 20px 2em,默认单位为 px,支持数组形式来分别设置横向和纵向间距",
"description_zh": "间距大小,如 20px 2em,默认单位为 px,支持数组形式来分别设置横向和纵向间距"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/space",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/space",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "default",
"description": "Default slot",
"description_zh": "Default slot"
}
],
"filename": "Space",
"suggestions": []
},
{
"name": "NutSticky",
"description": "使用 fixed 定位实现的类似 position: sticky 的吸顶效果。",
"description_zh": "使用 fixed 定位实现的类似 position: sticky 的吸顶效果。",
"tag": "粘性布局",
"props": {
"position": {
"default": "top",
"value": "",
"type": "string",
"description": "吸附位置(top、bottom)",
"description_zh": "吸附位置(top、bottom)"
},
":top": {
"default": "0",
"value": "",
"type": "number",
"description": "吸顶距离,position 为 top 时生效",
"description_zh": "吸顶距离,position 为 top 时生效"
},
":bottom": {
"default": "0",
"value": "",
"type": "number",
"description": "吸底距离,position 为 bottom 时生效",
"description_zh": "吸底距离,position 为 bottom 时生效"
},
"container": {
"default": "-",
"value": "",
"type": "Element",
"description": "容器的 HTML 节点",
"description_zh": "容器的 HTML 节点"
},
":z-index": {
"default": "99",
"value": "",
"type": "number",
"description": "吸附时的层级",
"description_zh": "吸附时的层级"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sticky",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sticky",
"typeDetail": {},
"events": [
{
"name": "change",
"description": "吸附状态改变时触发",
"description_zh": "吸附状态改变时触发",
"params": "fixed: boolean"
}
],
"methods": [],
"slots": [],
"filename": "Sticky",
"suggestions": []
},
{
"name": "NutElevator",
"description": "用于列表快速定位以及索引的显示",
"description_zh": "用于列表快速定位以及索引的显示",
"tag": "电梯楼层",
"props": {
"height": {
"default": "200px",
"value": "",
"type": "number | string",
"description": "电梯区域的高度",
"description_zh": "电梯区域的高度"
},
"accept-key": {
"default": "title",
"value": "",
"type": "string",
"description": "索引 key 值",
"description_zh": "索引 key 值"
},
"index-list": {
"default": "[{id: 0, name: ''}]",
"value": "",
"type": "Array(item 需包含 id、name 属性, name 支持传入 html 结构)",
"description": "索引列表",
"description_zh": "索引列表"
},
"is-sticky": {
"default": "false",
"value": "",
"type": "boolean",
"description": "索引是否吸顶",
"description_zh": "索引是否吸顶"
},
":space-height": {
"default": "23",
"value": "",
"type": "number",
"description": "右侧锚点的上下间距",
"description_zh": "右侧锚点的上下间距"
},
":title-height": {
"default": "35",
"value": "",
"type": "number",
"description": "左侧索引的高度",
"description_zh": "左侧索引的高度"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/elevator",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/elevator",
"typeDetail": {},
"events": [
{
"name": "click-item",
"description": "点击内容",
"description_zh": "点击内容",
"params": "key: string, item: { id: 0, name: '' }"
},
{
"name": "click-index",
"description": "点击索引",
"description_zh": "点击索引",
"params": "key: string"
},
{
"name": "change",
"description": "索引改变",
"description_zh": "索引改变",
"params": "index: number"
}
],
"methods": [
{
"name": "scrollTo",
"description": "index:number",
"params": "滚动到对应索引的位置",
"description_zh": "index:number"
}
],
"slots": [
{
"name": "default",
"description": "自定义左侧索引下每条数据的内容",
"description_zh": "自定义左侧索引下每条数据的内容"
}
],
"filename": "Elevator",
"suggestions": []
},
{
"name": "NutFixedNav",
"description": "悬浮收起体验交互,用于快捷导航",
"description_zh": "悬浮收起体验交互,用于快捷导航",
"tag": "悬浮导航",
"props": {
"visible": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否打开",
"description_zh": "是否打开"
},
"nav-list": {
"default": "[]",
"value": "",
"type": "Array",
"description": "悬浮列表内容数据",
"description_zh": "悬浮列表内容数据"
},
"active-color": {
"default": "#fa2c19 默认集成主题色",
"value": "",
"type": "string",
"description": "选中按钮文案颜色",
"description_zh": "选中按钮文案颜色"
},
"active-text": {
"default": "收起导航",
"value": "",
"type": "string",
"description": "收起列表按钮文案",
"description_zh": "收起列表按钮文案"
},
"un-active-text": {
"default": "快速导航",
"value": "",
"type": "string",
"description": "展开列表按钮文案",
"description_zh": "展开列表按钮文案"
},
"type": {
"default": "right",
"value": "",
"type": "string",
"description": "导航方向,可选值 left right",
"description_zh": "导航方向,可选值 left right"
},
"overlay": {
"default": "true",
"value": "",
"type": "boolean",
"description": "展开时是否显示遮罩",
"description_zh": "展开时是否显示遮罩"
},
":position": {
"default": "{top: 'auto',bottom: 'auto'}",
"value": "",
"type": "object",
"description": "fixed 垂直位置",
"description_zh": "fixed 垂直位置"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/fixednav",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/fixednav",
"typeDetail": {},
"events": [
{
"name": "selected",
"description": "选择之后触发",
"description_zh": "选择之后触发",
"params": "{item:item,$event:Event}"
}
],
"methods": [],
"slots": [
{
"name": "btn",
"description": "自定义按钮",
"description_zh": "自定义按钮"
},
{
"name": "list",
"description": "自定义展开列表内容",
"description_zh": "自定义展开列表内容"
}
],
"filename": "FixedNav",
"suggestions": []
},
{
"name": "NutIndicator",
"description": "显示一个任务或流程的进度,常用于开通流程。",
"description_zh": "显示一个任务或流程的进度,常用于开通流程。",
"tag": "指示器",
"props": {
":current": {
"default": "1",
"value": "",
"type": "number",
"description": "当前步骤",
"description_zh": "当前步骤"
},
":size": {
"default": "3",
"value": "",
"type": "number",
"description": "步骤长度",
"description_zh": "步骤长度"
},
"block": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否启用块级布局",
"description_zh": "是否启用块级布局"
},
"align": {
"default": "left",
"value": "",
"type": "string",
"description": "对齐方式,仅在 block 为 true 时生效, 可选值 left, right, center",
"description_zh": "对齐方式,仅在 block 为 true 时生效, 可选值 left, right, center"
},
"fill-zero": {
"default": "true",
"value": "",
"type": "boolean",
"description": "单数前面是否补 0",
"description_zh": "单数前面是否补 0"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/indicator",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/indicator",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [],
"filename": "Indicator",
"suggestions": []
},
{
"name": "NutMenu",
"description": "向下弹出的菜单列表",
"description_zh": "向下弹出的菜单列表",
"tag": "菜单",
"props": {
"direction": {
"default": "down",
"value": "",
"type": "string",
"description": "菜单展开方向,可选值为 up",
"description_zh": "菜单展开方向,可选值为 up"
},
"duration": {
"default": "0.3",
"value": "",
"type": "string | number",
"description": "动画时长,单位 s",
"description_zh": "动画时长,单位 s"
},
"active-color": {
"default": "#F2270C",
"value": "",
"type": "string",
"description": "选项的选中态图标颜色",
"description_zh": "选项的选中态图标颜色"
},
"close-on-click-overlay": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否在点击遮罩层后关闭菜单",
"description_zh": "是否在点击遮罩层后关闭菜单"
},
"scroll-fixed": {
"default": "false",
"value": "",
"type": "boolean | string | number",
"description": "滚动后是否固定,可设置固定位置",
"description_zh": "滚动后是否固定,可设置固定位置"
},
"title-class": {
"default": "-",
"value": "",
"type": "string",
"description": "自定义标题样式类",
"description_zh": "自定义标题样式类"
},
"lock-scroll": {
"default": "true",
"value": "",
"type": "boolean",
"description": "背景是否锁定",
"description_zh": "背景是否锁定"
},
"overlay": {
"default": "true",
"value": "",
"type": "boolean",
"description": "是否开启背景遮罩",
"description_zh": "是否开启背景遮罩"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/menu",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/menu",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [
{
"name": "icon",
"description": "自定义标题图标",
"description_zh": "自定义标题图标"
}
],
"filename": "Menu",
"suggestions": [
"nut-menu-item"
]
},
{
"name": "NutMenuItem",
"description": "向下弹出的菜单列表",
"description_zh": "向下弹出的菜单列表",
"tag": "菜单",
"props": {
"title": {
"default": "当前选中项文字",
"value": "",
"type": "string",
"description": "菜单项标题",
"description_zh": "菜单项标题"
},
"options": {
"default": "-",
"value": "",
"type": "Array",
"description": "选项数组",
"description_zh": "选项数组"
},
"disabled": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否禁用菜单",
"description_zh": "是否禁用菜单"
},
":cols": {
"default": "1",
"value": "",
"type": "number",
"description": "可以设置一行展示多少列 options",
"description_zh": "可以设置一行展示多少列 options"
},
"active-title-class": {
"default": "-",
"value": "",
"type": "string",
"description": "选项选中时自定义标题样式类",
"description_zh": "选项选中时自定义标题样式类"
},
"inactive-title-class": {
"default": "-",
"value": "",
"type": "string",
"description": "选项非选中时自定义标题样式类",
"description_zh": "选项非选中时自定义标题样式类"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/menu",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/menu",
"typeDetail": {},
"events": [
{
"name": "change",
"description": "选择 option 之后触发",
"description_zh": "选择 option 之后触发",
"params": "选择的 value"
},
{
"name": "toggle",
"description": "切换菜单展示状态,传 true 为显示,false 为隐藏,不传参为取反",
"description_zh": "切换菜单展示状态,传 true 为显示,false 为隐藏,不传参为取反",
"params": "show?: boolean"
},
{
"name": "open",
"description": "打开菜单栏时触发",
"description_zh": "打开菜单栏时触发",
"params": "-"
},
{
"name": "close",
"description": "关闭菜单栏时触发",
"description_zh": "关闭菜单栏时触发",
"params": "-"
}
],
"methods": [],
"slots": [
{
"name": "icon",
"description": "自定义选项图标",
"description_zh": "自定义选项图标"
}
],
"filename": "MenuItem",
"suggestions": []
},
{
"name": "NutNavbar",
"description": "提供导航功能,常用于页面顶部。",
"description_zh": "提供导航功能,常用于页面顶部。",
"tag": "头部导航",
"props": {
"title": {
"default": "-",
"value": "",
"type": "string",
"description": "标题名称",
"description_zh": "标题名称"
},
"left-text": {
"default": "-",
"value": "",
"type": "string",
"description": "左侧文案",
"description_zh": "左侧文案"
},
"desc": {
"default": "-",
"value": "",
"type": "string",
"description": "右侧描述",
"description_zh": "右侧描述"
},
"left-show": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否展示左侧箭头",
"description_zh": "是否展示左侧箭头"
},
"title-icon": {
"default": "false",
"value": "",
"type": "boolean",
"description": "标题中是否展示 icon",
"description_zh": "标题中是否展示 icon"
},
"border": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否显示下边框",
"description_zh": "是否显示下边框"
},
"fixed": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否固定到顶部",
"description_zh": "是否固定到顶部"
},
"placeholder": {
"default": "false",
"value": "",
"type": "boolean",
"description": "固定在顶部时,是否在标签位置生成一个等高的占位元素",
"description_zh": "固定在顶部时,是否在标签位置生成一个等高的占位元素"
},
"safe-area-inset-top": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否开启顶部安全区适配",
"description_zh": "是否开启顶部安全区适配"
},
"z-index": {
"default": "-",
"value": "",
"type": "number | string",
"description": "导航栏 z-index",
"description_zh": "导航栏 z-index"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/navbar",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/navbar",
"typeDetail": {},
"events": [
{
"name": "click-title4.1.5",
"description": "点击页面标题事件",
"description_zh": "点击页面标题事件",
"params": "event:Event"
},
{
"name": "click-icon4.1.5",
"description": "点击页面标题 icon 事件",
"description_zh": "点击页面标题 icon 事件",
"params": "event:Event"
},
{
"name": "click-right4.1.5",
"description": "点击右侧按钮事件",
"description_zh": "点击右侧按钮事件",
"params": "event:Event"
},
{
"name": "click-back4.1.5",
"description": "点击左侧图标事件",
"description_zh": "点击左侧图标事件",
"params": "event:Event"
},
{
"name": "on-click-title",
"description": "点击页面标题事件",
"description_zh": "点击页面标题事件",
"params": "event:Event"
},
{
"name": "on-click-icon",
"description": "点击页面标题 icon 事件",
"description_zh": "点击页面标题 icon 事件",
"params": "event:Event"
},
{
"name": "on-click-right",
"description": "点击右侧按钮事件",
"description_zh": "点击右侧按钮事件",
"params": "event:Event"
},
{
"name": "on-click-back",
"description": "点击左侧图标事件",
"description_zh": "点击左侧图标事件",
"params": "event:Event"
}
],
"methods": [],
"slots": [
{
"name": "left",
"description": "自定义左侧内容",
"description_zh": "自定义左侧内容"
},
{
"name": "right",
"description": "自定义右侧内容",
"description_zh": "自定义右侧内容"
},
{
"name": "content",
"description": "自定义导航栏中间内容",
"description_zh": "自定义导航栏中间内容"
},
{
"name": "left-show",
"description": "左侧箭头自定义图标",
"description_zh": "左侧箭头自定义图标"
},
{
"name": "title-icon",
"description": "标题中自定义图标",
"description_zh": "标题中自定义图标"
}
],
"filename": "Navbar",
"suggestions": []
},
{
"name": "NutPagination",
"description": "当数据量较多时,采用分页的形式分隔长列表。",
"description_zh": "当数据量较多时,采用分页的形式分隔长列表。",
"tag": "分页",
"props": {
":v-model": {
"default": "1",
"value": "",
"type": "number",
"description": "当前页码",
"description_zh": "当前页码"
},
"mode": {
"default": "multi",
"value": "",
"type": "string",
"description": "显示模式,可选值为 simple",
"description_zh": "显示模式,可选值为 simple"
},
"prev-text": {
"default": "上一页",
"value": "",
"type": "string",
"description": "上一页按钮文字",
"description_zh": "上一页按钮文字"
},
"next-text": {
"default": "下一页",
"value": "",
"type": "string",
"description": "下一页按钮文字",
"description_zh": "下一页按钮文字"
},
"page-count": {
"default": "传入/根据页数计算",
"value": "",
"type": "string | number",
"description": "总页数",
"description_zh": "总页数"
},
"total-items": {
"default": "0",
"value": "",
"type": "string | number",
"description": "总记录数",
"description_zh": "总记录数"
},
"items-per-page": {
"default": "10",
"value": "",
"type": "string | number",
"description": "每页记录数",
"description_zh": "每页记录数"
},
"show-page-size": {
"default": "5",
"value": "",
"type": "string | number",
"description": "显示的页码个数",
"description_zh": "显示的页码个数"
},
"force-ellipses": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否显示省略号",
"description_zh": "是否显示省略号"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/pagination",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/pagination",
"typeDetail": {},
"events": [
{
"name": "change",
"description": "页码改变时触发",
"description_zh": "页码改变时触发",
"params": "value"
}
],
"methods": [],
"slots": [
{
"name": "prev-text",
"description": "自定义上一页按钮内容",
"description_zh": "自定义上一页按钮内容"
},
{
"name": "next-text",
"description": "自定义下一页按钮内容",
"description_zh": "自定义下一页按钮内容"
},
{
"name": "page",
"description": "自定义页码",
"description_zh": "自定义页码"
}
],
"filename": "Pagination",
"suggestions": []
},
{
"name": "NutSideNavbar",
"description": "用于内容选择和切换",
"description_zh": "用于内容选择和切换",
"tag": "侧边栏导航",
"props": {
"offset": {
"default": "15",
"value": "",
"type": "number | string",
"description": "导航缩进宽度",
"description_zh": "导航缩进宽度"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sidenavbar",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sidenavbar",
"typeDetail": {},
"events": [],
"methods": [],
"slots": [],
"filename": "SideNavbar",
"suggestions": []
},
{
"name": "NutSubSideNavbar",
"description": "用于内容选择和切换",
"description_zh": "用于内容选择和切换",
"tag": "侧边栏导航",
"props": {
"title": {
"default": "``",
"value": "",
"type": "string",
"description": "导航标题",
"description_zh": "导航标题"
},
"open": {
"default": "true",
"value": "",
"type": "boolean",
"description": "导航是否默认展开",
"description_zh": "导航是否默认展开"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sidenavbar",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sidenavbar",
"typeDetail": {},
"events": [
{
"name": "title-click",
"description": "导航点击",
"description_zh": "导航点击",
"params": "-"
}
],
"methods": [],
"slots": [],
"filename": "SubSideNavbar",
"suggestions": [
"nut-side-navbar-item"
]
},
{
"name": "NutSideNavbarItem",
"description": "用于内容选择和切换",
"description_zh": "用于内容选择和切换",
"tag": "侧边栏导航",
"props": {
"title": {
"default": "15",
"value": "",
"type": "string",
"description": "导航标题",
"description_zh": "导航标题"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sidenavbar",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/sidenavbar",
"typeDetail": {},
"events": [
{
"name": "click",
"description": "导航点击",
"description_zh": "导航点击",
"params": "-"
}
],
"methods": [],
"slots": [],
"filename": "SideNavbarItem",
"suggestions": []
},
{
"name": "NutTabbar",
"description": "底部导航常用场景",
"description_zh": "底部导航常用场景",
"tag": "标签栏",
"props": {
"v-model": {
"default": "0",
"value": "",
"type": "string | number",
"description": "选中标签的索引值或者名称",
"description_zh": "选中标签的索引值或者名称"
},
"bottom": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否固定在页面底部",
"description_zh": "是否固定在页面底部"
},
"unactive-color": {
"default": "#7d7e80",
"value": "",
"type": "string",
"description": "icon 未激活的颜色",
"description_zh": "icon 未激活的颜色"
},
"active-color": {
"default": "#1989fa",
"value": "",
"type": "string",
"description": "icon 激活的颜色",
"description_zh": "icon 激活的颜色"
},
"safe-area-inset-bottom": {
"default": "false",
"value": "",
"type": "boolean",
"description": "是否开启 iphone 系列全面屏底部安全区适配",
"description_zh": "是否开启 iphone 系列全面屏底部安全区适配"
},
"placeholder": {
"default": "false",
"value": "",
"type": "boolean",
"description": "固定在底部时,是否在标签位置生成一个等高的占位元素",
"description_zh": "固定在底部时,是否在标签位置生成一个等高的占位元素"
},
"before-switch version": {
"default": "() => true",
"value": "",
"type": "(data, value) => boolean | Promise<boolean>",
"description": "切换前的回调函数,返回 false 时拦截切换操作",
"description_zh": "切换前的回调函数,返回 false 时拦截切换操作"
}
},
"link": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/tabbar",
"link_zh": "https://nutui.jd.com/h5/vue/4x/#/zh-CN/component/tabbar",
"typeDetail": {},
"events": [
{
"name": "tab-switch",
"description": "切换页签时触发事件",
"description_zh": "切换页签时触发事件",
"params": "点击的数据和索引值"
}
],
"methods": [],
"slots": [],
"filename": "Tabbar",
"suggestions": [
"nut-tabbar-item"
]
},
{
"name": "NutTabbarItem",
"description": "底部导航常用场景",
"description_zh": "底部导航常用场景",
"tag": "标签栏",
"props": {
"tab-title": {
"default": "–",
"value": "",