mirror of
https://gitee.com/baidu/amis.git
synced 2024-12-05 13:38:56 +08:00
5.6 KiB
5.6 KiB
title | description | type | group | menuName | icon |
---|---|---|---|---|---|
Search Box 搜索框 | 0 | ⚙ 组件 | Search Box |
基本用法
用于展示一个简单搜索框,通常需要搭配其他组件使用。比如 page 配置 initApi
后,可以用来实现简单数据过滤查找,name
keywords 会作为参数传递给 page 的 initApi
。
{
"type": "page",
"initApi": "/api/mock2/page/initData?keywords=${keywords}",
"body": [
{
"type": "search-box",
"name": "keywords"
},
{
"type": "tpl",
"tpl": "<p>关键字:${keywords}</p><p>返回结果:${&|json}</p>"
}
]
}
加强样式
{
"type": "page",
"initApi": "/api/mock2/page/initData?keywords=${keywords}",
"body": [
{
"type": "search-box",
"name": "keywords",
"enhance": true
},
{
"type": "tpl",
"tpl": "<p>关键字:${keywords}</p><p>返回结果:${&|json}</p>"
}
]
}
可清除
{
"type": "page",
"initApi": "/api/mock2/page/initData?keywords=${keywords}",
"body": [
{
"type": "search-box",
"name": "keywords",
"clearable": true
},
{
"type": "tpl",
"tpl": "<p>关键字:${keywords}</p><p>返回结果:${&|json}</p>"
}
]
}
清除后立即搜索
2.8.0
及以上版本
设置"clearAndSubmit": true
后,清空搜索框内容后立即执行搜索,与searchImediately
不同的是,clearAndSubmit
仅作用于清空输入框的动作,而searchImediately
会影响所有搜索动作。
{
"type": "page",
"initApi": "/api/mock2/page/initData?keywords=${keywords}",
"body": [
{
"type": "search-box",
"name": "keywords",
"clearable": true,
"clearAndSubmit": true
},
{
"type": "tpl",
"tpl": "<p>关键字:${keywords}</p><p>返回结果:${&|json}</p>"
}
]
}
mini 版本
{
"type": "page",
"initApi": "/api/mock2/page/initData?keywords=${keywords}",
"body": [
{
"type": "search-box",
"name": "keywords",
"mini": true
},
{
"type": "tpl",
"tpl": "<p>关键字:${keywords}</p><p>返回结果:${&|json}</p>"
}
]
}
与 CRUD 搭配
{
"type": "crud",
"api": "/api/mock2/sample",
"syncLocation": false,
"headerToolbar": [
{
"type": "search-box",
"name": "keywords",
"align": "right",
"placeholder": "关键字检索"
}
],
"columns": [
{
"name": "id",
"label": "ID"
},
{
"name": "engine",
"label": "Rendering engine"
},
{
"name": "browser",
"label": "Browser"
},
{
"name": "platform",
"label": "Platform(s)"
},
{
"name": "version",
"label": "Engine version"
},
{
"name": "grade",
"label": "CSS grade"
}
]
}
与 Service 搭配
{
"type": "page",
"body": [
{
"type": "service",
"api": "/api/mock2/page/initData?keywords=${keywords}",
"body": [
{
"type": "search-box",
"name": "keywords"
},
{
"type": "tpl",
"tpl": "<p>关键字:${keywords}</p><p>返回结果:${&|json}</p>"
}
]
}
]
}
属性表
属性名 | 类型 | 默认值 | 说明 | 版本 |
---|---|---|---|---|
type | string |
search-box |
||
className | string |
外层 CSS 类名 | ||
mini | boolean |
是否为 mini 模式 | ||
searchImediately | boolean |
是否立即搜索 | ||
clearAndSubmit | boolean |
清空搜索框内容后立即执行搜索 | 2.8.0 |
事件表
2.4.1 及以上版本
当前组件会对外派发以下事件,可以通过onEvent
来监听这些事件,并通过actions
来配置执行的动作,在actions
中可以通过${事件参数名}
来获取事件产生的数据,详细请查看事件动作。
[name]
表示当前组件绑定的名称,即name
属性,如果没有配置name
属性,则通过value
取值。
事件名称 | 事件参数 | 说明 |
---|---|---|
search | [name]: string 组件的值 |
点击搜索图标时触发 |
change | [name]: string 组件的值 |
输入框值变化时触发 |
focus | [name]: string 组件的值 |
输入框获取焦点时触发 |
blur | [name]: string 组件的值 |
输入框失去焦点时触发 |
动作表
2.4.1 及以上版本
当前组件对外暴露以下特性动作,其他组件可以通过指定actionType: 动作名称
、componentId: 该组件id
来触发这些动作,动作配置可以通过args: {动作配置项名称: xxx}
来配置具体的参数,详细请查看事件动作。
动作名称 | 动作配置 | 说明 |
---|---|---|
clear | - | 清空 |
setValue | value: string 更新的值 |
更新数据 |