From f50118239a7d8cf1ffd149485253c2233a6669e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Espino=20Garc=C3=ADa?= Date: Mon, 29 Jan 2024 10:52:41 +0100 Subject: [PATCH] Add missing comments to types/plugins/user_setttings.ts (#26038) Co-authored-by: Mattermost Build --- webapp/channels/src/types/plugins/user_settings.ts | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/webapp/channels/src/types/plugins/user_settings.ts b/webapp/channels/src/types/plugins/user_settings.ts index e2208c9123..6461aaf429 100644 --- a/webapp/channels/src/types/plugins/user_settings.ts +++ b/webapp/channels/src/types/plugins/user_settings.ts @@ -11,14 +11,24 @@ export type PluginConfiguration = { /** URL to the icon to show in the UI. No icon will show the plug outline icon. */ icon?: string; - sections: PluginConfigurationSection[]; + + /** Action that will appear at the beginning of the plugin settings tab */ action?: PluginConfigurationAction; + sections: PluginConfigurationSection[]; } export type PluginConfigurationAction = { + + /** Text shown as the title of the action */ title: string; + + /** Text shown as the body of the action */ text: string; + + /** Text shown at the button */ buttonText: string; + + /** This function is called when the button on the action is clicked */ onClick: () => void; }