Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 2.78 KB

README.zh-CN.md

File metadata and controls

110 lines (79 loc) · 2.78 KB

jsdelivr npm version codecov

English | 简体中文

控制按下 TabShift+Tab 后聚焦的元素。

tab-goto

安装

npm:

npm install tab-goto

Yarn:

yarn add tab-goto

使用

你可以为 tab-gotoshift-tab-goto 属性设置任何 CSS 选择器来控制按下 Tab 或者 Shift+Tab 后聚焦的元素。我们内部会使用 querySelector() 寻找要聚焦的元素。

CDN:

<script src="https://cdn.jsdelivr.net/npm/tab-goto@0.1.1"></script>

<input class="my-input" tab-goto="#my-div" />
<button my-button tab-goto=".my-input" shift-tab-goto='[my-data="div1"]'>
  my button
</button>
<div id="my-div" my-data="div1" tab-goto="[my-button]" tabindex="0">my-div</div>

ESM:

import "tab-goto";

API

config(options)

config() 函数用来配置 tab goto 使用的属性名和启用/禁用聚焦到设置的元素。

例子

CDN:

<input class="my-input" my-tab-goto="#my-div" />
<button my-button my-tab-goto=".my-input" my-shift-tab-goto='[my-data="div1"]'>
  my button
</button>
<div id="my-div" my-data="div1" my-tab-goto="[my-button]" tabindex="0">
  my-div
</div>

<script src="https://cdn.jsdelivr.net/npm/tab-goto@0.1.1"></script>
<script>
  window.tabGoto.config({
    tabGotoName: "my-tab-goto",
    shiftTabGotoName: "my-shift-tab-goto",
    enableTabGoto: true,
    enableShiftTabGoto: true,
  });
</script>

ESM:

import { config as configTabGoto } from "tab-goto";

configTabGoto({
  tabGotoName: "my-tab-goto",
  shiftTabGotoName: "my-shift-tab-goto",
  enableTabGoto: true,
  enableShiftTabGoto: true,
});

参数

  • options (Object) - 选项对象。
    • tabGotoName (string) - 按下 Tab 读取的属性的名称。默认值:tab-goto
    • shiftTabGotoName (string) - 按下 Shift+Tab 读取的属性的名称。默认值: shift-tab-goto
    • enableTabGoto (boolean) - 是否启用按下 Tab 聚焦到设置的元素。默认值: true
    • enableShiftTabGoto (boolean) - 是否启用按下 Shift+Tab 聚焦到设置的元素。默认值: true