atjs参数有哪些?如何正确配置与使用?

at.js 是一个轻量级的 JavaScript 库,主要用于实现文本输入框中的自动补全功能,常见于社交平台、评论系统等需要@提及、标签补全的场景,其核心行为通过参数配置实现,合理设置参数能让开发者精准控制触发条件、数据交互、UI 展示等逻辑,以下从参数类型、作用场景及示例出发,详细解析 at.js 的关键参数。

atjs参数

at.js 参数详解

at.js 的参数通过初始化时传入对象配置,主要可分为触发控制、数据交互、UI 展示、回调函数四大类,具体参数如下表所示:

参数名 类型 默认值 作用说明 示例
trigger String 设置触发自动补全的字符,支持多字符(如 ‘#@’)或正则表达式。 trigger: '@'(触发@提及);trigger: '#@'(需输入#@才触发)
searchKey String ‘value’ 指定数据源中用于搜索的字段名,与后端返回数据字段对应。 若后端返回 {id: 1, name: '张三'},则 searchKey: 'name'
displayTpl String

  • ${value}
  • 下拉列表项的 HTML 模板,支持通过 ${字段名} 插入数据。displayTpl: '<li><img src="${avatar}"/>${name}</li>'(显示头像和姓名)
    insertTplString‘${value}’选中补全项后插入输入框的内容模板,可自定义格式(如带链接、标签)。insertTpl: '@${name}(${id})'(插入@张三(1))
    delayNumber300输入触发字符后,发送搜索请求的延迟时间(毫秒),避免频繁请求。delay: 500(输入后等待500ms再请求)
    maxItemsNumber5下拉列表最大显示数量,超出部分滚动显示。maxItems: 10(最多显示10条补全项)
    minCharsNumber0触发补全所需的最小字符数(如输入@后需再输入1个字符才触发搜索)。minChars: 1(输入@后需再输入至少1个字符)
    hideDropdownOnSelectBooleantrue选中补全项后是否自动隐藏下拉框。hideDropdownOnSelect: false(选中后仍显示下拉框)
    highlightFirstBooleanfalse是否自动高亮下拉列表的第一项,支持回车键快速选中。highlightFirst: true(默认选中第一项)
    callbacksObject配置生命周期回调函数,包括请求前、请求后、选中后等钩子。见下方“回调函数参数说明”

    回调函数参数说明

    callbacks 是 at.js 最灵活的部分,通过不同回调函数可自定义数据请求、数据处理逻辑:

    atjs参数

    • beforeQuery(query, callback):发送请求前的回调,query 为当前输入内容,callback 控制是否请求(如 callback({results: []}) 可直接返回数据)。
      示例:过滤空请求

      callbacks: {
        beforeQuery: function (query, callback) {
          if (query.length < 2) callback({results: []}); // 输入不足2字符不请求
          else callback();
        }
      }
    • afterRender($ul):下拉列表渲染后的回调,$ul 为 jQuery 对象,可自定义样式或事件。
      示例:为列表项添加点击事件

      afterRender: function ($ul) {
        $ul.find('li').on('click', function () {
          console.log('选中项:', $(this).data('item'));
        });
      }
    • afterInsert(value, $input):选中项插入输入框后的回调,value 为插入内容,$input 为输入框元素。
      示例:插入后清空输入框(如标签场景)

      afterInsert: function (value, $input) {
        $input.val(''); // 插入后清空输入,继续输入新标签
      }

    参数组合应用示例

    实现一个带头像的@提及功能,后端返回 {id: 1, name: '张三', avatar: 'url'},配置如下:

    $('#input').atwho({
      at: '@',              // 触发字符为@
      searchKey: 'name',    // 搜索name字段
      displayTpl: '<li><img src="${avatar}" width="20"/>${name}</li>', // 显示头像和姓名
      insertTpl: '@${name}', // 插入@张三
      delay: 400,           // 400ms延迟请求
      maxItems: 8,          // 最多显示8条
      callbacks: {
        afterInsert: function (value, $input) {
          console.log('插入内容:', value); // 插入后打印日志
        }
      }
    });

    相关问答 FAQs

    Q1:at.js 参数中的 beforeQueryafterQuery 有什么区别?
    A:beforeQuery 在发送请求前触发,可修改请求数据或直接返回本地数据(避免请求后端),适合缓存或过滤场景;afterQuery 在收到后端响应后触发,可对返回数据二次处理(如格式化、过滤空值),但无法阻止请求发送。beforeQuery 可判断本地是否有缓存数据,有则直接返回;afterQuery 可将后端返回的 {data: [...]} 提取为 [...] 供 at.js 渲染。

    atjs参数

    Q2:如何通过 at.js 参数实现自定义的@提及样式?
    A:通过 displayTpl 参数自定义 HTML 模板,结合 CSS 样式实现,设置 displayTpl: '<li class="mention-item"><span class="name">${name}</span><span class="id">#${id}</span></li>',并在 CSS 中定义 .mention-item { display: flex; align-items: center; padding: 5px; } .name { font-weight: bold; } .id { color: #999; margin-left: 5px; },即可实现带姓名和ID的@提及样式,同时通过 afterRender 回调可添加动态交互(如悬停高亮)。

    原创文章,发布者:酷番叔,转转请注明出处:https://cloud.kd.cn/ask/47782.html

    (0)
    酷番叔酷番叔
    上一篇 2025年10月29日 02:35
    下一篇 2025年10月29日 03:29

    相关推荐

    • ASP如何设置数据库连接?

      在Web开发中,ASP(Active Server Pages)作为一种经典的服务器端脚本技术,常用于构建动态网站,而数据库连接则是ASP应用的核心环节,它决定了网站能否高效、安全地与数据库进行交互,本文将详细介绍ASP设置数据库连接的方法、常见技巧及注意事项,帮助开发者掌握这一关键技术,数据库连接的基础知识数……

      2025年12月2日
      7600
    • 为什么你越休息越累?

      【重要提示与前提】指文档中前置的关键信息或要求,位于开头;用于确保读者理解后续内容的前提条件、背景或重要注意事项。

      2025年7月13日
      12700
    • ASP订单如何高效管理与追踪?

      在电子商务和企业管理系统中,订单处理是核心环节之一,而ASP(Active Server Pages)作为一种经典的Web开发技术,在构建订单管理系统时仍具有广泛的应用价值,ASP订单系统通过服务器端脚本动态生成页面,实现订单的创建、查询、修改和跟踪等功能,为企业和用户提供高效、便捷的订单管理体验,ASP订单系……

      2025年11月24日
      7700
    • asp如何调用api?

      在Web开发中,ASP(Active Server Pages)作为一种经典的服务器端脚本技术,常用于构建动态网页,通过调用API(应用程序接口),ASP可以实现与外部服务的数据交互,扩展应用功能,本文将详细介绍ASP调用API的方法、注意事项及实践案例,帮助开发者高效集成第三方服务,ASP调用API的基本方法……

      2025年11月30日
      8000
    • ASP如何加密数据库密码?

      在Web应用程序开发中,数据库安全是至关重要的一环,尤其是数据库密码的存储,若明文存储极易导致信息泄露,ASP(Active Server Pages)作为一种经典的Web开发技术,可通过多种方式对数据库密码进行加密处理,以提升系统的安全性,本文将详细介绍ASP中数据库密码加密的常用方法、实现步骤及最佳实践,密……

      2025年12月18日
      4900

    发表回复

    您的邮箱地址不会被公开。 必填项已用 * 标注

    联系我们

    400-880-8834

    在线咨询: QQ交谈

    邮件:HI@E.KD.CN

    关注微信