|
4 | 4 |
|
5 | 5 | ### 基础用法 |
6 | 6 |
|
| 7 | +默认使用一个内置 Textarea 组件。 |
| 8 | + |
7 | 9 | <div class="docs-preview-part"> |
8 | 10 | <sk-mention |
9 | 11 | placeholder="输入@试试…" |
@@ -53,24 +55,78 @@ export default { |
53 | 55 | </script> |
54 | 56 | ``` |
55 | 57 |
|
| 58 | +### 使用自定义编辑区域 |
| 59 | + |
| 60 | +可以在默认插槽中设置自定义的编辑区域,例如 input、contenteditable 等,需要确保 `editorSelector` 可以选择到该编辑区域。 |
| 61 | + |
| 62 | +<div class="docs-preview-part"> |
| 63 | + <sk-mention |
| 64 | + :menuItemLimit="5" |
| 65 | + :data="['JavaScript', 'HTML', 'CSS', 'Java', 'Go', 'C#', 'VB', 'Python', 'PHP', 'C', 'C++']" |
| 66 | + editorSelector="input" |
| 67 | + > |
| 68 | + <sk-input placeholder="输入@试试…" /> |
| 69 | + </sk-mention> |
| 70 | +</div> |
| 71 | +<div class="docs-preview-part"> |
| 72 | + <sk-mention |
| 73 | + :menuItemLimit="5" |
| 74 | + :data="['JavaScript', 'HTML', 'CSS', 'Java', 'Go', 'C#', 'VB', 'Python', 'PHP', 'C', 'C++']" |
| 75 | + editorSelector=".editor" |
| 76 | + > |
| 77 | + <div class="editor" style="background: #f7f7f7; margin-top: 10px; padding: 10px" contenteditable>输入@试试 </div> |
| 78 | + </sk-mention> |
| 79 | +</div> |
| 80 | +
|
| 81 | +```vue |
| 82 | +<template> |
| 83 | + <div class="docs-preview-part"> |
| 84 | + <sk-mention |
| 85 | + :menuItemLimit="5" |
| 86 | + :data="['JavaScript', 'HTML', 'CSS', 'Java', 'Go', 'C#', 'VB', 'Python', 'PHP', 'C', 'C++']" |
| 87 | + editorSelector="input" |
| 88 | + > |
| 89 | + <sk-input placeholder="输入@试试…" /> |
| 90 | + </sk-mention> |
| 91 | + </div> |
| 92 | + <div class="docs-preview-part"> |
| 93 | + <sk-mention |
| 94 | + :menuItemLimit="5" |
| 95 | + :data="['JavaScript', 'HTML', 'CSS', 'Java', 'Go', 'C#', 'VB', 'Python', 'PHP', 'C', 'C++']" |
| 96 | + editorSelector=".editor" |
| 97 | + > |
| 98 | + <div |
| 99 | + class="editor" |
| 100 | + style="background: #f7f7f7; margin-top: 10px; padding: 10px" |
| 101 | + contenteditable |
| 102 | + > |
| 103 | + 输入@试试 |
| 104 | + </div> |
| 105 | + </sk-mention> |
| 106 | + </div> |
| 107 | +</template> |
| 108 | +``` |
| 109 | + |
56 | 110 | ### API |
57 | 111 |
|
58 | | -| 参数 | 说明 | 类型 | 可选值 | 默认值 | |
59 | | -| ------------------- | ------------------------------------------ | ------------------ | --------- | ------ | ---- | |
60 | | -| trigger | 触发自动补全的符号 | string | | `@` | |
61 | | -| data | 同步筛选时的全部数据列表 | `MentionDataItem[] | string[]` | | `[]` | |
62 | | -| async | 是否异步获取数据 | bool | | false | |
63 | | -| menuItemLimit | 每次最多显示的条目数量 | number | | 25 | |
64 | | -| menuShowMinLength | 触发自动补全前键入的最少字符数量 | number | | 0 | |
65 | | -| requireLeadingSpace | 触发自动补全的符号前是否需要空格(0.2.2+) | number | | false | |
| 112 | +| 参数 | 说明 | 类型 | 可选值 | 默认值 | |
| 113 | +| ------------------- | ------------------------------------------ | ------------------ | --------- | ---------- | ---- | |
| 114 | +| trigger | 触发自动补全的符号 | string | | `@` | |
| 115 | +| data | 同步筛选时的全部数据列表 | `MentionDataItem[] | string[]` | | `[]` | |
| 116 | +| async | 是否异步获取数据 | bool | | false | |
| 117 | +| editorSelector | 用于选择到可编辑区域的选择器 | string | | `textarea` | |
| 118 | +| menuItemLimit | 每次最多显示的条目数量 | number | | 25 | |
| 119 | +| menuShowMinLength | 触发自动补全前键入的最少字符数量 | number | | 0 | |
| 120 | +| requireLeadingSpace | 触发自动补全的符号前是否需要空格(0.2.2+) | number | | false | |
66 | 121 |
|
67 | 122 | 同时也支持 [Textarea](../textarea/index) 的所有 props。 |
68 | 123 |
|
69 | 124 | ### 事件 |
70 | 125 |
|
71 | | -| 事件 | 说明 | 携带参数 | |
72 | | -| ---------- | -------------------------------------- | -------------------------------------------- | ---------- | |
73 | | -| asyncFetch | 异步获取回调函数,需要返回一个 Promise | `(word: string) => Promise<MentionDataItem[] | string[]>` | |
| 126 | +| 事件 | 说明 | 携带参数 | |
| 127 | +| ---------- | -------------------------------------------------- | -------------------------------------------- | ---------- | |
| 128 | +| asyncFetch | 异步获取回调函数,需要返回一个 Promise | `(word: string) => Promise<MentionDataItem[] | string[]>` | |
| 129 | +| attach | 在 tribute 完成加载时触发的回调,携带 tribute 实例 | `(tribute: Tribute<MentionDataItem>) => any` | |
74 | 130 |
|
75 | 131 | 同时也支持 [Textarea](../textarea/index) 的所有事件。 |
76 | 132 |
|
|
0 commit comments