-
Notifications
You must be signed in to change notification settings - Fork 185
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(forms): Add dynamic list section and clean up iframe section (#3138
) * feat: document dynamic list and related features Related to bpmn-io/form-js#796 * fix: iframe text spacing and closing note * style(formatting): technical review --------- Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
- Loading branch information
1 parent
2733fad
commit 03a8313
Showing
7 changed files
with
65 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
...ponents/modeler/forms/form-element-library/forms-element-library-dynamiclist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
id: forms-element-library-dynamiclist | ||
title: Dynamic list | ||
description: Learn about the dynamic list form element to dynamically manage a list of form elements. | ||
--- | ||
|
||
The **dynamic list** element is designed to dynamically manage a list of form elements. It enables users to add or remove items from the list and is particularly useful in scenarios where the number of items in a list is not fixed. | ||
|
||
![Dynamic List Symbol](/img/form-icons/form-dynamiclist.svg) | ||
|
||
## Configurable properties | ||
|
||
- **Group label**: Label displayed on top of the dynamic list. Can either be an [expression](../../feel/language-guide/feel-expressions-introduction.md), plain text, or [templating syntax](../configuration/forms-config-templating-syntax.md). | ||
- **Path**: Assigns a path that maps its children into a data object, defined as a variable name or a dot separated variable accessor. See the [data binding docs](../configuration/forms-config-data-binding.md) for more details. | ||
- **Default number of items**: Specifies the default number of items rendered when no input data is provided. | ||
- **Allow add/delete items**: Enables users to add new items to or delete existing items from the list. | ||
- **Disable collapse**: Prevents items in the list from being collapsed. | ||
- **Number of non-collapsing items**: Defines the number of items in the list that will not collapse. | ||
- **Vertical alignment**: Determines the alignment of items in the list. | ||
- **Hide if**: [Expression](../../feel/language-guide/feel-expressions-introduction.md) to hide the dynamic list. | ||
|
||
## Usage | ||
|
||
The dynamic list element facilitates the management of data lists in forms. It is highly adaptable, with features like default item count, add/delete capabilities, and control over item collapse. It's the ideal component for scenarios where users need to input a variable number of items, such as adding multiple contacts or entries in a form. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.