监听表单 submit 事件比 keyup 更可靠,因 layui 表单需 lay-submit 属性和匹配的 lay-filter 才能触发 form.on('submit'),自动收集 data.field 并阻止刷新,而 keyup 易失效且兼容性差。

监听表单 submit 事件比监听 keyup 更可靠
直接给输入框绑 keyup 监听回车(event.keyCode === 13)看似简单,但容易漏掉焦点不在输入框时的回车、表单自动提交、移动端软键盘回车行为不一致等问题。Layui 表单默认支持回车触发表单提交,只要把搜索逻辑放在 form.on('submit(...)') 里就行,这是最稳的做法。
确保你的搜索区域是标准 <form></form> 结构,且有 lay-submit 属性:
- 必须加
lay-submit属性,否则 Layui 不会拦截原生 submit 并触发监听 -
lay-filter="search-form"的值要和 JS 中监听时用的一致 - 按钮用
lay-submit或type="submit"均可,但推荐显式写lay-submit
正确绑定 form submit 监听器
Layui 的 form.on('submit(...)') 是唯一需要初始化的入口,不能漏掉 form.render()(如果动态插入表单才需手动调),常规静态页面只需确保模块加载完成即可。
layui.use(['form'], function() {
var form = layui.form;
form.on('submit(search-form)', function(data) {
var keyword = data.field.keyword;
// 这里执行搜索逻辑,比如 Ajax 请求
console.log('搜索关键词:', keyword);
return false; // 阻止页面跳转或刷新
});
});
-
data.field自动收集所有带name的表单项值,无需手动$('#xxx').val() - 必须
return false,否则浏览器会按原生表单逻辑提交并刷新页面 - 如果表单里还有其他按钮(如重置),确保它们不是
type="submit",否则也会触发该监听
为什么不要用 input 的 keyup 回车监听
有人会写 $('#keyword').on('keyup', function(e) { if (e.keyCode === 13) { ... } }),这在 Layui 场景下有明显缺陷:
- 当输入框被
layui-form渲染后,原始 DOM 可能被替换,直接 jQuery 绑定易失效 - 移动端 iOS Safari 软键盘「搜索」按钮可能不触发
keyCode === 13,而表单 submit 事件能兼容 - 用户聚焦到搜索按钮再按回车,或用语音输入后按回车,
keyup绑在 input 上就完全捕获不到 - 若页面有多个表单,
keyup逻辑容易互相干扰,而form.on天然按 filter 隔离
额外注意:防重复提交和 loading 状态
回车触发搜索后,用户可能连续猛按,导致多次请求。Layui 本身不处理这个,得自己加防护:
form.on('submit(search-form)', function(data) {
var btn = $(this).find('button[lay-submit]');
var loadingText = btn.text();
btn.attr('disabled', 'disabled').text('搜索中...');
$.get('/api/search', data.field, function(res) {
// 处理结果
}).always(function() {
btn.removeAttr('disabled').text(loadingText);
});
return false;
});
- 禁用按钮比单纯设
loading: true更直观,也防止用户误操作 - 一定要在
always(而非success)里恢复按钮状态,否则失败后按钮永远卡住 - 如果用了 Layui 的
layer.load(),记得对应layer.close(),别漏掉
真正要注意的是:表单必须有 lay-submit 和匹配的 lay-filter,少一个,整个回车搜索就静默失效——这点很容易查半天才发现是属性拼错了。











