Skip to content

Commit bd68d6a

Browse files
Merge pull request #142 from vlobzakov/vlobzakov-checkboxlist-added
JE-58440 checkboxlist field added to v6.1.1
2 parents 516c0e8 + e1889f7 commit bd68d6a

File tree

2 files changed

+52
-27
lines changed

2 files changed

+52
-27
lines changed

docs/creating-manifest/visual-settings.md

Lines changed: 52 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ where:
8181
* `text` - [multiline](#text) text field
8282
* `list` - drop-down menu with [textboxes](#list)
8383
* `checkbox` - [single checkbox](#checkbox) field
84-
<!-- * `checkboxlist` - [checkbox](#checkboxlist) grouping -->
84+
* `checkboxlist` - [checkbox](#checkboxlist) grouping
8585
* `radiolist` - [radio field](#radiolist) grouping
8686
* `radio-fieldset` - alias to `radiolist`
8787
* `dockertags` - drop-down menu with a list of [docker tags](#dockertags)
@@ -554,47 +554,72 @@ where:
554554
- `hideLabel` *[optional][boolean]* - shows/hides field label. Default value is *'false'*
555555
- `hidden` *[optional]*[boolean] - shows/hides field with its label. Default value is *'false'*.
556556

557-
<!--
558557
### checkboxlist
559558
Checkbox grouping.
560559

561-
![text](/img/checkboxlist.jpg)
560+
![text](/img/checkboxlist.jpg)
561+
562562
@@@
563563
```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
572580
```
573581
``` 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
582593
},
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+
]
588607
```
589608
@@!
590609

591-
where:
610+
This example returns values as follows:
611+
612+
*{ "options": "option2,option3", "option1": false, "option2": true, "option3": true }*
613+
614+
Field parameters:
592615

593616
- `caption` *[optional]* - field label
594617
- `values` - checkboxes (*"key"*:*"value"*)
595618
- `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+
598623

599624
### radiolist
600625
Radio elements grouping.
8.61 KB
Loading

0 commit comments

Comments
 (0)