Skip to content

Commit 5ef7083

Browse files
committed
docs(group): add usage for the parameter group
1 parent f075962 commit 5ef7083

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,75 @@ Properties:
282282
| key | yes | The message shown in the UI. |
283283
| value | yes | Unique identifier for the value. |
284284

285+
### Groups
286+
287+
Group Properties:
288+
289+
| Property | Required | Default Value | Description |
290+
|:-----------|:---------|:--------------|:-----------------------------------------------------------------------------------------|
291+
| name | yes | - | Unique identifier for the property. |
292+
| depends_on | no | - | If this group should only be shown when a specific condition is met on another property. |
293+
294+
DependsOn Properties:
295+
296+
| Property | Required | Default Value | Description |
297+
|:---------------|:---------|:--------------|:---------------------------------------------------------------------------------------------|
298+
| or_conditions | no | `[]` | The list of conditions in which at least one must be satisfied for the property to be shown. |
299+
| and_conditions | no | `[]` | The list of conditions in which all must be satisfied for the property to be shown. |
300+
301+
DependsOn Conditions:
302+
303+
- ValueEqualsCondition
304+
- ValueNotEqualsCondition
305+
- ValueContainsCondition
306+
- ValueNotContainsCondition
307+
- ValueEmptyCondition
308+
309+
#### ValueEqualsCondition
310+
311+
Properties:
312+
313+
| Property | Required | Default Value | Description |
314+
|:---------------|:---------|:--------------|:------------------------------------------------------------------------------------|
315+
| parameter_name | yes | - | The name of the group that the current group is dependent upon. |
316+
| value_equals | yes | - | The value the target parameter must equal for this condition to be considered true. |
317+
318+
#### ValueNotEqualsCondition
319+
320+
Properties:
321+
322+
| Property | Required | Default Value | Description |
323+
|:-----------------|:---------|:--------------|:----------------------------------------------------------------------------------------|
324+
| parameter_name | yes | - | The name of the group that the current group is dependent upon. |
325+
| value_not_equals | yes | - | The value the target parameter must not equal for this condition to be considered true. |
326+
327+
#### ValueContainsCondition
328+
329+
Properties:
330+
331+
| Property | Required | Default Value | Description |
332+
|:---------------|:---------|:--------------|:------------------------------------------------------------------------------------|
333+
| parameter_name | yes | - | The name of the group that the current group is dependent upon. |
334+
| value_contains | yes | - | A value the target parameter must contain for this condition to be considered true. |
335+
336+
#### ValueNotContainsCondition
337+
338+
Properties:
339+
340+
| Property | Required | Default Value | Description |
341+
|:-------------------|:---------|:--------------|:----------------------------------------------------------------------------------------|
342+
| parameter_name | yes | - | The name of the group that the current group is dependent upon. |
343+
| value_not_contains | yes | - | A value the target parameter must not contain for this condition to be considered true. |
344+
345+
#### ValueEmptyCondition
346+
347+
Properties:
348+
349+
| Property | Required | Default Value | Description |
350+
|:---------------|:---------|:--------------|:---------------------------------------------------------------------------------|
351+
| parameter_name | yes | - | The name of the group that the current group is dependent upon. |
352+
| value_empty | yes | - | A bool value reflecting whether the expected parameter should be empty or not. |
353+
285354
### Multiple Templates
286355

287356
You can define multiple templates in the `.czrc` file, separated by `---`:

0 commit comments

Comments
 (0)