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

    相关推荐

    • 命令提示符如何输入中文?

      在命令提示符中输入中文需先修改编码:输入命令 chcp 65001 切换为UTF-8编码,同时右键点击窗口标题栏,进入“属性”将字体改为“宋体”等支持中文的字体,确保正常显示,操作后即可输入中文。

      2025年7月12日
      12800
    • ASP退出登录代码怎么写?退出登录时session清除的关键步骤有哪些?

      在ASP开发中,退出登录功能的核心是清除用户的登录状态,这通常涉及服务端会话(Session)和客户端凭证(Cookie)的清理,确保用户无法通过后退或其他方式访问登录后的受限资源,以下是详细的实现逻辑、代码示例及注意事项,退出登录的核心逻辑退出登录的本质是终止用户与服务端的会话关联,并清除客户端可能存储的登录……

      2025年10月21日
      7700
    • ASP母版页模板如何创建与使用?

      ASP母版页模版在Web开发中,尤其是使用ASP.NET技术时,母版页(Master Page)是一种强大的工具,用于统一网站的布局和风格,通过母版页,开发者可以定义网站的通用结构(如页头、页脚、导航栏等),并将内容页(Content Page)与母版页结合,从而实现代码复用和一致性维护,本文将详细介绍ASP母……

      2026年1月7日
      7400
    • 如何高效检测ASP网站程序漏洞与安全风险?

      asp网站程序检测在互联网技术快速发展的今天,ASP(Active Server Pages)作为一种经典的网站开发技术,仍被广泛应用于企业官网、管理系统等场景,由于ASP技术的特性和安全性问题,定期对ASP网站程序进行检测至关重要,本文将详细介绍ASP网站程序检测的重要性、检测内容、常用工具及方法,帮助用户全……

      2025年12月20日
      6000
    • ASP课程学什么?内容有哪些?

      ASP课程简介ASP(Active Server Pages)是一种由微软开发的服务器端脚本技术,主要用于动态网页的开发,它允许开发者将HTML代码与脚本语言(如VBScript或JScript)结合,生成动态、交互式的网页内容,ASP课程旨在帮助学员掌握这一技术的基础知识和高级应用,从入门到实战,全面提升We……

      2025年12月4日
      7400

    发表回复

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

    联系我们

    400-880-8834

    在线咨询: QQ交谈

    邮件:HI@E.KD.CN

    关注微信