@@ -67,3 +67,63 @@ title: 'XSender'
6767
6868### 前置提示词
6969<demo src =" ./demos/befor-tip.vue " ></demo >
70+
71+
72+ ## 属性
73+
74+ ### Props
75+ | 属性| 类型 | 是否必填 | 默认值 | 说明 |
76+ | --| ----------------------| -----| -----------| -------------|
77+ | ` placeholder ` | string | false | ` 请输入内容 ` | 提示占位语 |
78+ | ` device ` | PC \| H5 \| auto | false | ` auto ` | 交互设备 |
79+ | ` autoFocus ` | boolean | false | ` false ` | 渲染完成后是否自动聚焦 |
80+ | ` variant ` | default \| updown | false | ` default ` | 布局变体 |
81+ | ` maxLength ` | number | false | ` -1 ` | 输入长度限制 |
82+ | ` submitType ` | enter \| shiftEnter | false| ` enter ` | 提交类型 |
83+ | ` customStyle ` | CSSStyleDeclaration | false| ` {} ` | 自定义输入框样式 |
84+ | ` loading ` | boolean | false| ` false ` | 加载中状态 |
85+ | ` disabled ` | boolean | false| ` false ` | 禁用状态 |
86+ | ` clearable ` | boolean | false| ` false ` | 显示清空按钮 |
87+ | ` headerAnimationTimer ` | number | false| ` 300 ` | 头部动画时间 |
88+ | ` mentionConfig ` | MentionConfig | false| ` null ` | 提及用户配置 |
89+ | ` triggerConfig ` | TriggerConfig[ ] | false| ` null ` | 指令弹窗配置 |
90+ | ` selectConfig ` | SelectConfig[ ] | false| ` null ` | 标签选择弹窗配置 |
91+ | ` tipConfig ` | TipConfig \| boolean | false| ` true ` | 前置提示词配置 |
92+ | ` getPlugin ` | () => typeof XSender | false| ` null ` | 自定义底层插件版本 |
93+
94+ ### MentionConfig
95+ | 属性| 类型 | 是否必填 | 默认值 | 说明 |
96+ | --| -----------------------------------------------------| -------| ---------| ----------------|
97+ | ` dialogTitle ` | string | true | ` '' ` | 提及用户弹窗标题 |
98+ | ` options ` | \< { id: string, name: string, avatar?: string }\> [ ] | true | ` [] ` | 数据选项 |
99+ | ` callEvery ` | boolean | false | ` false ` | 是否需要提及所有人选项 |
100+ | ` everyText ` | string | false | ` 所有人 ` | 提及所有人的选项文案 |
101+ | ` asyncMatch ` | (matchStr: string) => Promise<MentionItem[ ] > | false | ` null ` | 提及弹窗选项启用异步匹配模式 |
102+ | ` emptyText ` | string | false | ` 暂无数据 ` | 异步匹配选项为空时的提示文案 |
103+
104+ ### TriggerConfig
105+ | 属性 | 类型 | 是否必填 | 默认值 | 说明 |
106+ | ---------------| ------------------------------------| -------| --------| ------------|
107+ | ` dialogTitle ` | string | true | ` '' ` | 指令弹窗标题 |
108+ | ` key ` | string | true | ` null ` | 触发指令选择的按键符 |
109+ | ` options ` | \< { id: string, name: string }\> [ ] | true | ` [] ` | 数据选项 |
110+
111+ ### SelectConfig
112+ | 属性 | 类型 | 是否必填 | 默认值 | 说明 |
113+ | ----------------| ------------------------------------------------------| -------| -----------| --------------|
114+ | ` dialogTitle ` | string | true | ` '' ` | 标签选择弹窗标题 |
115+ | ` key ` | string | true | ` null ` | 选择标签标识 |
116+ | ` options ` | \< { id: string, name: string, preview?: string }\> [ ] | true | ` [] ` | 数据选项 |
117+ | ` multiple ` | boolean | false | ` false ` | 开启多选 |
118+ | ` emptyText ` | string | false | ` 暂无数据 ` | 无选项时的提示文案 |
119+ | ` showSearch ` | boolean | false | ` false ` | 开启搜索功能 |
120+ | ` placeholder ` | string | false | ` 输入关键字查询 ` | 搜索提示占位语 |
121+ | ` searchEmptyText ` | string | false | ` 暂无数据 ` | 搜索内容为空时的提示文案 |
122+
123+ ### TipConfig
124+ | 属性 | 类型 | 是否必填 | 默认值 | 说明 |
125+ | ----------------| ------------------------------------------------------| -------| -----------| --------------|
126+ | ` tipTemplate ` | string | false | ` '' ` | 前置提示词模板 |
127+ | ` dialogTemplate ` | string | false | ` '' ` | 指令弹窗模板 |
128+ | ` closeNames ` | string[ ] | false | ` [] ` | 关闭弹窗的按键符列表 |
129+ | ` offsetTop ` | number | false | ` 0 ` | 弹窗顶部偏移量 |
0 commit comments