From 248875d243cdb868958c24a0c8031080628c57d7 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 27 Apr 2021 09:28:05 +0200 Subject: [PATCH] Fix plugins doc --- support/doc/plugins/guide.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 8d85092e7..53d53c26d 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -173,9 +173,18 @@ function register (...) { registerSetting({ name: 'admin-name', label: 'Admin name', + type: 'input', - // type: input | input-checkbox | input-password | input-textarea | markdown-text | markdown-enhanced | 'select' | 'html' - default: 'my super name' + // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html' + + // Optional + descriptionHTML: 'The purpose of this field is...', + + default: 'my super name', + + // If the setting is not private, anyone can view its value (client code included) + // If the setting is private, only server-side hooks can access it + private: false }) const adminName = await settingsManager.getSetting('admin-name')