Skip to content

QUICKSTART.md

Latest commit

 

History

History
104 lines (72 loc) · 3.16 KB

QUICKSTART.md

File metadata and controls

104 lines (72 loc) · 3.16 KB
Raw

WebKeyBind 快速开始指南

第一步：加载插件到Chrome

  1. 打开Chrome浏览器
  2. 访问 chrome://extensions/
  3. 启用右上角的"开发者模式"
  4. 点击"加载已解压的扩展程序"
  5. 选择 WebKeyBind 项目的根目录

第二步：试用插件

简单示例：为网页按钮绑定快捷键

  1. 打开测试页面 test.html 或访问任意网站
  2. 点击浏览器工具栏的 WebKeyBind 图标
  3. 点击"新增快捷键绑定"
  4. 点击"点击选择页面元素"（popup 会自动关闭）
  5. 在页面上，鼠标移动到你想绑定的按钮
  6. 元素会被绿色边框高亮
  7. 点击该元素 → 页面会自动弹出浮动配置面板 ✨
  8. 在配置面板中：
    • 点击"快捷键"输入框，按下你想要的快捷键（如 Ctrl+1）
    • 描述已自动填充，可修改
    • URL 模式已自动填充，可留空以匹配整个域名
  9. 点击"保存快捷键"

完成！ 现在在该页面按下 Ctrl+1，就会触发你绑定的按钮！

新功能：浮动配置面板 ✨

选择元素后，会自动弹出漂亮的配置面板，无需重新打开扩展！

特点：

  • 🎨 现代化 UI 设计
  • ⚡ 实时配置，立即生效
  • ✅ 自动填充描述和 URL
  • 🎯 点击遮罩或 ESC 键关闭
  • 💾 保存后自动加载，立即可用

常见问题

Q: 选择元素后没有配置面板弹出？

A: 请检查：

  1. 刷新扩展：在 chrome://extensions/ 中点击 WebKeyBind 的刷新按钮
  2. 刷新网页（F5）
  3. 打开控制台（F12）查看是否有错误

Q: 快捷键不生效？

A: 请检查：

  1. 快捷键是否与浏览器或其他扩展冲突
  2. 是否在输入框中（输入框中不触发快捷键）
  3. 页面是否匹配 URL 模式
  4. 在扩展中查看绑定列表，确认已保存

Q: 如何删除不需要的快捷键？

A: 在扩展 popup 的绑定列表中，点击对应绑定的"删除"按钮。

Q: 可以为不同的页面设置相同的快捷键吗？

A: 可以。绑定是按域名/URL匹配的，不同域名可以使用相同的快捷键。

Q: 如何测试快捷键是否工作？

A: 在扩展 popup 的绑定列表中，点击"测试"按钮，或直接在页面按下快捷键。

支持的快捷键组合

  • Ctrl + 任意键（如 Ctrl+S）
  • Alt + 任意键（如 Alt+Q）
  • Shift + 任意键（如 Shift+F）
  • Meta (Command/Windows 键) + 任意键
  • 组合使用（如 Ctrl+Alt+S）

测试页面

项目包含 test.html 文件，提供：

  • 4 个测试按钮
  • 点击日志显示
  • Content script 加载检测
  • 完整的使用说明

直接在浏览器中打开即可测试所有功能。

调试

如果遇到问题，可以查看控制台日志：

  • 网页调试: 按 F12 打开开发者工具，查看以 [WebKeyBind] 开头的日志
  • Popup调试: 右键点击扩展图标 → "检查弹出内容"
  • Background调试: 在 chrome://extensions/ 页面，点击"service worker"

下一步

  • 为常用网站的按钮绑定快捷键，提升效率
  • 尝试不同的 URL 模式匹配
  • 查看 README.md 了解更多功能
  • 开发者可参考 CLAUDE.md 了解架构并扩展功能

祝使用愉快！ 🚀