< text-expander > 元素
激活一个建议菜单,以扩展您输入的文本片段.
安装
$ npm install --save @github/text-expander-element
使用量
脚本
导入为 ES 模块 :
import '@github/text-expander-element'
带有脚本标签 :
<script type="module" src="./node_modules/@github/text-expander-element/dist/bundle.js">
标记
<text-expander keys=": @ #" multiword="#">
<textarea></textarea>
</text-expander>
属性
keys是菜单激活密钥的空格分隔列表multiword定义扩展是否应使用几个词- 您可以提供一个空格分隔的激活键列表,该列表应支持多字匹配
suffix是一个在扩展时附加到值的字符串,默认是一个单空字符
活动
text-expander-change 匹配密钥时,会开火。 单位 event.detail 您可以找到:
key: 匹配的密钥;例如::。 。 。 .text: 匹配文本;例如:cat,用于:cat。 。 。 .- 如果
key指定于multiword属性然后匹配的文本可以包含多个字;例如cat and dog页:1:cat and dog。 。 。 .
- 如果
provide: 获得菜单结果时要调用的函数。 需要一个Promise与{matched: boolean, fragment: HTMLElement}地点matched说明是否有建议,以及fragment是要在页面上显示的菜单内容.
const expander = document.querySelector('text-expander')
expander.addEventListener('text-expander-change', function(event) {
const {key, provide, text} = event.detail
if (key !== ':') return
const suggestions = document.querySelector('.emoji-suggestions').cloneNode(true)
suggestions.hidden = false
for (const suggestion of suggestions.children) {
if (!suggestion.textContent.match(text)) {
suggestion.remove()
}
}
provide(Promise.resolve({matched: suggestions.childElementCount > 0, fragment: suggestions}))
})
退回的碎片应当由过滤器组成 [role=option] 待选项目。 例如:
<ul class="emoji-suggestions" hidden>
<li role="option" data-value="🐈">🐈 :cat2:</li>
<li role="option" data-value="🐕">🐕 :dog:</li>
</ul>
text-expander-value 当选定某一项时,会开火。 单位 event.detail 您可以找到:
key: 匹配的密钥;例如::。 。 。 .item: 所选项目。 这将是其中之一[role=option]。用这个解决value。 。 。 .value: 用于替换查询的无效值占位符。 要替换文本查询,只需重新指定此值.continue: 插入一个值后指定是否继续自动补全的布尔值。 默认为false如果设置为true,不会在插入值后添加空格,并且会继续开火text-expander-change活动.
const expander = document.querySelector('text-expander')
expander.addEventListener('text-expander-value', function(event) {
const {key, item} = event.detail
if (key === ':') {
event.detail.value = item.getAttribute('data-value')
}
})
text-expander-committed 在下面之后发射 input 在 DOM 中更新了值。 单位 event.detail 您可以找到:
input编号:HTMLInputElement或者说HTMLTextAreaElement刚刚有value对DOM的承诺.
const expander = document.querySelector('text-expander')
expander.addEventListener('text-expander-committed', function(event) {
const {input} = event.detail
})
text-expander-activate 在菜单被指定并附在DOM之后即被发射,就在它即将被定位到文本以扩展之前。 用于指定类或调用显示菜单的必备方法, 例如 .showPopover()。 。 。 .
text-expander-deactivate 在菜单未分配和从DOM中取出之前就被解雇了 这对删除类或运行清除如从缓存中去除是有用的.
浏览器支持
浏览器, 不本地 自定义元素支持 需要一个 多边填充。 。 。 .
- 颜色
- 火花
- 萨法里
- 微软边缘
发展
npm install
npm test
许可证
以麻省理工学院许可证分发。 详情见LICENSE.