Move custom preference out of the "Extensions" folder

[Hanksha]

Hi,

I'd like to know if there is a way to move custom preferences (from my own theia extension) out of the "Extensions" folder in the settings editor?

[msujew]

Hey @Hanksha,

you will need to override the PreferenceLayoutProvider and return a modified layout, see here:

theia/packages/preferences/src/browser/util/preference-layout.ts

Lines 326 to 328 in c1e4279

	getLayout(): PreferenceLayout[] {
	return DEFAULT_LAYOUT;
	}

[Hanksha]

Hi @msujew

Thanks that worked, but I could not use a "title" with it to group the properties together (in the schema), is there a way to do that?

[msujew]

I cannot really follow. What do you expect the result to look like?

[Hanksha]

I'd like them grouped like this:

But I get:

Layout:

const MARTINI_LAYOUT: PreferenceLayout[] = [
    {
        id: "martini",
        label: "Martini Designer",
        settings: ["martini.*"]
    },
    ...DEFAULT_LAYOUT
];

Schema:

export const rumPreferenceSchema: PreferenceSchema = {
    type: "object",
    properties: {
        "martini.sendDiagnosticData": {
            type: "boolean",
            default: true,
            description: ""
        },
        "martini.includeUserData": {
            type: "boolean",
            default: true,
            description: ""
        }
    }
};

If I set the title in the schema, they are grouped under Data Collection but they end up in "Extensions" folder and if I remove the title, they are all under "Martini Designer" but I'd like to have "Martini Designer" > "Data Collection" as a structure.

[Hanksha]

Ah I think I got it @msujew, I need do define the layout like this?

const MARTINI_LAYOUT: PreferenceLayout[] = [
    {
        id: "martini",
        label: "Martini Designer",
        settings: ["martini.*"],
        children: [
            {
                id: "martini.dataCollection",
                label: "Data Collection",
                settings: ["martini.dataCollection.*"]
            }
        ]
    },
    ...DEFAULT_LAYOUT
];

The only downside is that I have to define all statically in one spot while I broke down most features into multiple extensions. I guess I can just change the behavior of PreferenceLayoutProvider and introduce a contribution API for the layout instead.