|
81 | 81 | * `text` - [multiline](#text) text field |
82 | 82 | * `list` - drop-down menu with [textboxes](#list) |
83 | 83 | * `checkbox` - [single checkbox](#checkbox) field |
84 | | -<!-- * `checkboxlist` - [checkbox](#checkboxlist) grouping --> |
| 84 | + * `checkboxlist` - [checkbox](#checkboxlist) grouping |
85 | 85 | * `radiolist` - [radio field](#radiolist) grouping |
86 | 86 | * `radio-fieldset` - alias to `radiolist` |
87 | 87 | * `dockertags` - drop-down menu with a list of [docker tags](#dockertags) |
@@ -554,47 +554,72 @@ where: |
554 | 554 | - `hideLabel` *[optional][boolean]* - shows/hides field label. Default value is *'false'* |
555 | 555 | - `hidden` *[optional]*[boolean] - shows/hides field with its label. Default value is *'false'*. |
556 | 556 |
|
557 | | -<!-- |
558 | 557 | ### checkboxlist |
559 | 558 | Checkbox grouping. |
560 | 559 |
|
561 | | - |
| 560 | + |
| 561 | + |
562 | 562 | @@@ |
563 | 563 | ```yaml |
564 | | -fields: |
565 | | - - type: checkboxlist |
566 | | - caption: Checkbox List |
567 | | - values: |
568 | | - value1: hello |
569 | | - value2: world |
570 | | - hideLabel: false |
571 | | - hidden: false |
| 564 | + - type: checkboxlist |
| 565 | + caption: Options |
| 566 | + name: options |
| 567 | + columns: 2 |
| 568 | + values: |
| 569 | + - name: option1 |
| 570 | + caption: Option 1 |
| 571 | + value: false |
| 572 | + |
| 573 | + - name: option2 |
| 574 | + caption: Option 2 |
| 575 | + value: true |
| 576 | + |
| 577 | + - name: option3 |
| 578 | + caption: Option 3 |
| 579 | + value: true |
572 | 580 | ``` |
573 | 581 | ``` json |
574 | | -{ |
575 | | - "fields": [ |
576 | | - { |
577 | | - "type": "checkboxlist", |
578 | | - "caption": "Checkbox List", |
579 | | - "values": { |
580 | | - "value1": "hello", |
581 | | - "value2": "world" |
| 582 | +[ |
| 583 | + { |
| 584 | + "type": "checkboxlist", |
| 585 | + "caption": "Options", |
| 586 | + "name": "options", |
| 587 | + "columns": 2, |
| 588 | + "values": [ |
| 589 | + { |
| 590 | + "name": "option1", |
| 591 | + "caption": "Option 1", |
| 592 | + "value": false |
582 | 593 | }, |
583 | | - "hideLabel": false, |
584 | | - "hidden": false |
585 | | - } |
586 | | - ] |
587 | | -} |
| 594 | + { |
| 595 | + "name": "option2", |
| 596 | + "caption": "Option 2", |
| 597 | + "value": true |
| 598 | + }, |
| 599 | + { |
| 600 | + "name": "option3", |
| 601 | + "caption": "Option 3", |
| 602 | + "value": true |
| 603 | + } |
| 604 | + ] |
| 605 | + } |
| 606 | +] |
588 | 607 | ``` |
589 | 608 | @@! |
590 | 609 |
|
591 | | -where: |
| 610 | +This example returns values as follows: |
| 611 | + |
| 612 | +*{ "options": "option2,option3", "option1": false, "option2": true, "option3": true }* |
| 613 | + |
| 614 | +Field parameters: |
592 | 615 |
|
593 | 616 | - `caption` *[optional]* - field label |
594 | 617 | - `values` - checkboxes (*"key"*:*"value"*) |
595 | 618 | - `hideLabel` *[optional] [boolean]* - shows/hides field label. Default value is *'false'* |
596 | | -- `hidden` *[optional]*[boolean] - shows/hides field with its label. Default value is *'false'*. |
597 | | ---> |
| 619 | +- `hidden` *[optional]*[boolean] - shows/hides field with its label. Default value is *'false'* |
| 620 | +- `delimiter` *[optional][string]* - a delimiter character to separate list data items. The default value is a comma ',' |
| 621 | +- `columns` *[optional][Number]* - specifies the number of columns to be created when displaying grouped checkboxlist controls using automatic layout. The default value is 1. |
| 622 | + |
598 | 623 |
|
599 | 624 | ### radiolist |
600 | 625 | Radio elements grouping. |
|
0 commit comments