☰

GM_webextPref

A config library powered by webext-pref.

当前为 2018-08-24 提交的版本，查看 最新版本。

此脚本不应直接安装。它是供其他脚本使用的外部库，要使用该库请加入元指令 // @require https://update.cn-greasyfork.org/scripts/371339/623327/GM_webextPref.js

作者
eight
版本
0.3.0
创建于
2018-08-19
更新于
2018-08-24
大小
31.9 KB
许可证
MIT

GM_webextPref

Build Status codecov

Use webext-pref in userscripts. This library includes createPref, createView, a storage object implemented with GM API, and a dialog service.

Installation

Greasy Fork

Demo

https://rawgit.com/eight04/GM_webextPref/master/demo/demo.html

Usage

const pref = GM_webextPref({
  default: {
    useImage: true,
    excludeElements: "code, .highlight"
  },
  body: [
    {
      key: "useImage",
      type: "checkbox",
      label: "Use image"
    },
    {
      key: "excludeElements",
      type: "text",
      label: "Exclude elements"
    }
  ]
});

pref.ready()
  .then(() => {
    console.log(pref.get("useImage")); // true
  });

API

This module exports a single function.

GM_webextPref

const pref = GM_webextPref({
  default: Object,
  body: Array,
  getNewScope?: () => newScopeName: String,
  getMessage?: Function,
  alert?: Function,
  confirm?: Function,
  prompt?: Function
});

Create a pref object. pref inherits all methods from the pref object returned by createPref.

default would be sent to createPref; body, getNewScope, getMessage, alert, confirm, and prompt would be sent to createView.

If GM_registerMenuCommand exists, the function would register a menu command like:

GM_registerMenuCommand(GM_info.script.name + " - Configure", pref.openDialog);

So that users can open the config dialog through monkey menu.

pref.openDialog

pref.openDialog();

Open the config dialog.

Changelog

  • 0.3.0 (Aug 25, 2018)

    • Update webext-pref to 0.5.0. Now the script requires GM_deleteValue/GM.deleteValue APIs.

  • 0.2.1 (Aug 24, 2018)

    • Update webext-pref to 0.4.1. Add navbar tooltips.

  • 0.2.0 (Aug 21, 2018)

    • Update webext-pref to 0.4.0. Drop translate arg.

  • 0.1.5 (Aug 20, 2018)

    • Update webext-pref to 0.3.5. Fixed navbar error.

  • 0.1.4 (Aug 19, 2018)

    • Add: style help text.

  • 0.1.3 (Aug 19, 2018)

    • Fix: import/export buttons.
    • Enhance: larger title.

  • 0.1.2 (Aug 19, 2018)

    • Add: style checkbox children.

  • 0.1.1 (Aug 19, 2018)

    • Fix: missing metadata.

  • 0.1.0 (Aug 19, 2018)

    • First release.