Browse Source

Update PropertySelect docs

up-style-manager
Artur Arseniev 5 years ago
parent
commit
d1f48a0362
  1. 11
      src/style_manager/model/PropertySelect.js

11
src/style_manager/model/PropertySelect.js

@ -1,10 +1,14 @@
import Property from './Property'; import Property from './Property';
/**
* @typedef PropertySelect
* @property {Array<Object>} options Array of option definitions, eg `[{ id: '100', label: 'Set 100' }]`
*/
export default class PropertySelect extends Property { export default class PropertySelect extends Property {
defaults() { defaults() {
return { return {
...Property.getDefaults(), ...Property.getDefaults(),
options: [], // Array of options, eg. [{ id: '100', label: 'Set 100' }] options: [],
full: 0, full: 0,
}; };
} }
@ -20,7 +24,8 @@ export default class PropertySelect extends Property {
} }
/** /**
* Get current selected option. * Get current selected option or by id.
* @param {String} id Option id.
* @returns {Object | null} * @returns {Object | null}
*/ */
getOption(id) { getOption(id) {
@ -30,7 +35,7 @@ export default class PropertySelect extends Property {
/** /**
* Update options. * Update options.
* @param {Array<Object>} value Array of options, eg. `[{ id: 'val-1', label: 'Value 1' }]` * @param {Array<Object>} value New array of options, eg. `[{ id: 'val-1', label: 'Value 1' }]`
*/ */
setOptions(value = []) { setOptions(value = []) {
this.set('options', value); this.set('options', value);

Loading…
Cancel
Save