Bilibili-Evolved/registry/lib/components/utils/keymap/help.md
2025-03-31 23:37:02 +08:00

3.0 KiB

快捷键设置帮助

在快捷键设置中, 每个动作都配备了 3 套按键, 分别是默认按键, 预设按键和自定义按键 (优先级依次升高). 默认按键由动作自带, 预设按键将根据选择的预设而变化, 如果都不是所希望的按键, 则可以添加自定义按键.

自定义按键提供了一个文本框来输入按键定义 (失去焦点时自动保存), 这是一种特殊的表示键盘按键的写法, 规则为:

  • 留空表示永远不会触发 (禁用)
  • 直接写下按键的名称 (对应 KeyboardEventcodekey 属性)
  • 多个按键用空格隔开, 如果按键本身就是空格, 可以用 space 来表示
  • 可以有一些组合键: shift / ctrl / alt / meta, meta 在 Windows 上是 Win 键, 在 macOS 上是 Command 键
  • 如果希望映射到多种按键, 可以继续用空格隔开, 但注意组合键是固定的, 例如: 配置 a b 表示 AB 键, 而配置 shift a b 就表示 Shift + A / Shift + B
  • 组合键是精确匹配的, 按下 Ctrl + Shift + A 不能触发配置为 shift a 的快捷键
  • 如果希望组合键可按可不按, 可以给它套上一个 [], 例如 [ctrl] shift a 表示 Ctrl + Shift +A / Shift + A
  • b 站自带有一些快捷键, 修改本组件提供的相同动作快捷键不会影响 b 站自带的快捷键, 如果希望屏蔽掉 b 站自带的快捷键, 可以安装 快捷键扩展 - 无动作 插件, 并将无动作绑定到希望屏蔽的快捷键上. 例如希望用 C 键投币且不希望自带的 W 键触发投币, 则应该在组件里配置投币为 c, 无动作为 w

预设

在第三列的表头中可以通过下拉框切换预设, 预设是一套固定的按键定义, 方便快速切换到用户更熟悉的按键风格中. 插件可以使用 keymap.presets 作为 key 添加新的预设.

示例:

addData('keymap.presets', (presetBase: Record<string, string>, builtInPresets: Record<string, Record<string, string>>) => {
  builtInPresets.myPreset = {
    like: 'l',
    pause: 'space',
    longJumpForward: 'shift rightArrow',
    longJumpBackward: 'shift leftArrow',
    seekBegin: 'ctrl [shift] 0',
  },
})

动作

插件可以使用 keymap.actions 作为 key 添加新的动作, 动作的默认按键需要添加到 presetBase 上, 动作返回值是一个 boolean 值, true 表示完成了快捷键动作, 应当阻止其他事件; 反之表示动作在当前情况不适用, 应当执行原先的事件.

示例:

addData('keymap.actions', (actions: Record<string, KeyBindingAction>) => {
  actions.watchlater = {
    displayName: '稍后再看',
    run: context => {
      const { clickElement } = context
      return clickElement('.video-toolbar .ops .watchlater, .more-ops-list .ops-watch-later, .video-toolbar-module .see-later-box', context)
    },
  }
})
addData('keymap.presets', (presetBase: Record<string, string>) => {
  presetBase.watchlater = 'shift w'
})