Wiki source code of XWikiSelect
Version 2.1 by Guillaume Delhumeau on 2015/09/08
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = Summary = | ||
| 2 | The XWiki select component is a widget that have the same objective than a regular select box, but styled nicely and with parameters like icons, descriptions, etc... | ||
| 3 | |||
| 4 | This is an example of use: | ||
| 5 | |||
| 6 | {{image reference="xwiki-select.png /}} | ||
| 7 | |||
| 8 | = How to use = | ||
| 9 | This component is usable in any Wiki page or Velocity template. For a wiki page, you need to be both inside a \{\{velocity\}\} and a \{\{html\}\} macros. | ||
| 10 | |||
| 11 | You just need to call the ###xwikiSelect## macro with the corresponding parameters. | ||
| 12 | |||
| 13 | * //fieldName//: name of the input field | ||
| 14 | * //options//: an array of maps describing a category of options, which contains an array of options (see example) | ||
| 15 | * //defaultValue//: the default value to use (could be null) | ||
| 16 | * //firstIsDefaultIfDefaultNull//: either if defaultValue is null, select the first option or not | ||
| 17 | * //cssClass//: class to add to the div (could be '##xwiki-select-small##', '##xwiki-select-medium##', '##xwiki-select-tall##' or any other class) | ||
| 18 | |||
| 19 | = Example of use = | ||
| 20 | {{code language="velocity"}} | ||
| 21 | #set($options = [ | ||
| 22 | { | ||
| 23 | 'name': 'Category 1', | ||
| 24 | 'options': [ | ||
| 25 | { 'name': 'Option 1', 'value': 'option1', 'description': 'Description of the option 1', 'icon': 'wiki', 'data': {'some-data': 'some-value'}}, | ||
| 26 | { 'name': 'Option 2', 'value': 'option2', 'description': 'Description of the option 2', 'icon': 'page'} | ||
| 27 | ] | ||
| 28 | }, | ||
| 29 | { | ||
| 30 | 'name': 'Category 2', | ||
| 31 | 'options': [ | ||
| 32 | { 'name': 'Option 3', 'value': 'option3', 'description': 'Description of the option 3', 'icon': 'check'} | ||
| 33 | ] | ||
| 34 | } | ||
| 35 | ]) | ||
| 36 | #xwikiSelect('nameOfTheField', $options, 'option1', false, 'xwiki-select-small') | ||
| 37 | {{/code}} |
