button-registry-example.json5

//
// Draft example of a button registry format based on the specs located here:
// https://docs.google.com/document/d/1Mjk1n-J6ndY8w95htonpIZSmqOm43KHNc2u6WKNBQ6A
//
{
    // Each Button ID in the registry needs a unique ID to be saved as. This ID is for the
    // button registry to keep track, not for the actual siteconfig. This top level key is
    // the Button ID.
    "open-reddit": {
        // This is a code that is written out in the spec, but can evolve as we need it.
        // APP, WEB, KEY, X.Y
        buttonType: "WEB",
        // Support notes. Can be written in english, or supplied an i18n message bundle ID.
        // If the ID doesn't exist in the message bundles can be rendered as is.
        supportNotes: "Should work in any web browser",
        // Icon ID from our in development set of icons
        buttonIconID: "open-web",
        // URL to get more information and documentation about this button.
        learnMoreUrl: "http://morphic.world/buttons/open-reddit",
        // This is the ACTUAL data that goes in the siteConfig for Morphic, so it should
        // follow the syntax and formatting used in the siteconfig. This is either a set
        // of key value pairs as follows, or for official builtin button types a string id,
        // see the language and screen-zoom examples below.
        buttonData: {
            "buttonId": "MakeYourOwn",
            "buttonName": "Open Reddit",
            "buttonType": "WEB",
            "buttonData": "www.reddit.com",
            "fullScreen": true,
            "popupText": "<p>Open Reddit in a web browser.</p>",
            "description": "The full description of the button..."
        }
    },
    "morphic-language-button-official": {
        buttonType: "1.0",
        supportNotes: "Works with any version of Windows 10 or MacOS",
        buttonIconID: "language",
        learnMoreUrl: "http://morphic.world/buttons/official/language",
        buttonData: "language"
    },
    "morphic-screen-zoom-official": {
        buttonType: "1.0",
        supportNotes: "Works with any version of Windows 10 or MacOS",
        buttonIconID: "utilities",
        learnMoreUrl: "http://morphic.world/buttons/official/screen-zoom",
        buttonData: "screen-zoom"
    },
    "some-other-type-of-button": {
        buttonType: "APP",
        supportNotes: "Requires Windows 10 released after March 2019  (version 1903 or higher)",
        buttonIconID: "application",
        learnMoreUrl: "http://thirdparty.developer.org/some-button",
        buttonData: {
            "buttonId": "MakeYourOwn",
            "buttonName": "Launch Notepad",
            "buttonType": "APP",
            "buttonData": "C:\\Windows\\system32\\notepad.exe",
            "fullScreen": true,
            "popupText": "<p>Launch the Notepad application.</p>",
            "description": "The full description of the button..."
        }
    }
}