From 3bd7e6e1011bd286eaf8aaaac521849512a7c5f0 Mon Sep 17 00:00:00 2001 From: Carita Date: Mon, 12 Aug 2024 10:03:56 -0700 Subject: [PATCH] #2088 Title info doc updates (#2101) Signed-off-by: Carita Ou --- docs/pages/04.03-ui-hints.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/pages/04.03-ui-hints.md b/docs/pages/04.03-ui-hints.md index cfbbd3a5cb..2c99ecf5f8 100644 --- a/docs/pages/04.03-ui-hints.md +++ b/docs/pages/04.03-ui-hints.md @@ -291,6 +291,23 @@ Example complex_type_info section: } ] ``` + +## Title-info +The title_info sections defines what will be displayed in the title section alongside the `titleDefinition`. + +Title info attributes. + +* `action_refs` (*array[string]*) List of action to be displayed in the title section. Each action_ref must have a corresponding action defined in the action_info section. + +Example title info section: +```js +"title_info": { + "action_refs": [ + "increment" + ] +} +``` + ## Action Info The action_info section defines an action. Actions are used to callback to the application to perform an operation.