GM_config 开源项目教程

GM_config 开源项目教程

GM_configA lightweight, reusable, cross-browser graphical settings framework for inclusion in user scripts.项目地址:https://gitcode.com/gh_mirrors/gm/GM_config

项目介绍

GM_config 是一个用于创建轻量级图形设置对话框的工具，主要用于用户脚本中。尽管其名称可能让人误以为它是 Greasemonkey 的官方 API，但实际上它是一个独立的工具。通过在用户脚本中包含 GM_config，开发者可以轻松地为用户提供一个设置界面，以便用户调整脚本的参数。

项目快速启动

安装与配置

首先，确保你已经安装了 Greasemonkey 或其他兼容的用户脚本管理器。然后，你可以通过以下步骤快速启动 GM_config：

1. 克隆项目仓库：

   git clone https://github.com/sizzlemctwizzle/GM_config.git
   

2. 在用户脚本中引入 GM_config：

   // @require https://openuserjs.org/src/libs/sizzle/GM_config.js
   // @grant GM_getValue
   // @grant GM_setValue
   

3. 初始化配置对话框：

   GM_config.init({
       title: '配置对话框标题',
       fields: {
           text: {
               label: '文本字段',
               type: 'text',
               default: '默认值'
           },
           number: {
               label: '数字字段',
               type: 'number',
               default: 12345
           },
           checkbox: {
               label: '复选框字段',
               type: 'checkbox',
               default: true
           }
       }
   });
   

4. 打开配置对话框：

   GM_config.open();
   

示例代码

以下是一个完整的示例，展示了如何在用户脚本中使用 GM_config：

// ==UserScript==
// @name         GM_config 示例
// @namespace    http://tampermonkey.net/
// @version      0.1
// @description  使用 GM_config 创建配置对话框
// @author       Your Name
// @match        http://*/*
// @grant        GM_getValue
// @grant        GM_setValue
// @require      https://openuserjs.org/src/libs/sizzle/GM_config.js
// ==/UserScript==

(function() {
    'use strict';

    GM_config.init({
        title: '示例配置对话框',
        fields: {
            text: {
                label: '文本字段',
                type: 'text',
                default: '默认值'
            },
            number: {
                label: '数字字段',
                type: 'number',
                default: 12345
            },
            checkbox: {
                label: '复选框字段',
                type: 'checkbox',
                default: true
            }
        }
    });

    GM_registerMenuCommand('打开配置对话框', GM_config.open);
})();

应用案例和最佳实践

应用案例

GM_config 可以用于各种需要用户自定义设置的场景，例如：

• 广告拦截器：允许用户自定义需要拦截的广告类型。
• 网页增强工具：允许用户自定义网页的显示样式或功能。
• 数据抓取工具：允许用户自定义抓取的数据类型和范围。

最佳实践

• 清晰的字段标签：确保每个配置字段都有清晰易懂的标签。
• 默认值设置：为每个字段设置合理的默认值，以便用户快速开始使用。
• 类型检查：根据字段类型进行输入验证，确保用户输入的数据有效。
• 保存回调：在配置对话框关闭时，提供保存回调函数，以便处理用户设置的保存逻辑。

典型生态项目

GM_config 作为一个用户脚本工具，与其他用户脚本项目和工具兼容性良好。以下是一些典型的生态项目：

• Greasemonkey：一个流行的用户脚本管理器，支持 GM_config。
• Tampermonkey：另一个广泛使用的用户脚本管理器，与 GM_config 兼容。
• Violentmonkey：一个轻量级的用户脚本管理器，同样支持 GM

GM_configA lightweight, reusable, cross-browser graphical settings framework for inclusion in user scripts.项目地址:https://gitcode.com/gh_mirrors/gm/GM_config