allo- / ffprofile

A tool to create firefox profiles with personalized defaults.
GNU Affero General Public License v3.0
769 stars 56 forks source link

Add "breaks" meta data #215

Open allo- opened 3 years ago

allo- commented 3 years ago

The idea with breaks metadata is to have something like

[
    {
        "name": "indexed_db", 
        "type": "boolean", 
        "initial": false, 
        "label": "Disable IndexedDB", 
        "help_text": "(...)",
        "addons": [], 
        "config": {
            "dom.indexedDB.enabled": false
        },
        "breaks": {
            "description": "IndexedDB is needed to store indexed data on your PC. This could for example be a save game or a chatlog. Disabling it will not only prevent websites from storing unique identifiers ('super cookies') but also from storing useful data."
            "type": "websites" # websites, (firefox) features, etc.
            "what": [
            "All sites, which require indexedDB to work",
            "Locally saving data on sites, like for example save games or chatlogs",
            "Example: Twitter now requires IndexedDB to work"
        ]}
    }
]

Rendered as

Disable IndexedDB
(description)

[
**This setting can break some websites.**
    IndexedDB is needed to store indexed data on your PC. This could for example be a save game or a chatlog. Disabling it will not only prevent websites from storing unique identifiers ('super cookies') but also from storing useful data.

 - All sites, which require indexedDB to work
 - Locally saving data on sites, like for example save games or chatlogs
 - Example: Twitter now requires IndexedDB to work
]

Instead of just having Disable IndexedDB (breaks things).

Maybe this could have a short description and a long description and the bullet points in some collapsible element.

Jieiku commented 2 years ago

Seems like a wonderful idea, makes this configuration tool even better! especially for first time users of the tool.

In addition your bulleted list could have alternatives, so that if a user sees that the setting will break sites that they use, then they could use a listed alternative solution, such as: