Optional bindingOptional boundsbounds for the value of the object. This is used for numeric inputs like number and sliders. This can be an array of [min, max] or a function that returns an array of [min, max].
Optional childrenChildren of this object. This is used for folders and dropdowns. This can be an array of UiObjectConfig objects, or an array of functions that returns an array of UiObjectConfig objects. Note: it could be a function that returns an array as well, but its not added to the type yet.
Optional disabledThe Ui input will be disabled if this is true, i.e. the user will not be able to change the value. This can be a boolean or a function that returns a boolean.
Optional dispatchThis is used to specify when to change the values and/or call the function(like onClick) or change events. Default is 'postFrame'
Optional domExtra HTMLElements to be added to the UI element. This is used for customizing the UI. This can be an array of HTMLElement or a function that returns an array of HTMLElement.
Optional expandedOnly for folders. The Ui element will be expanded if this is true. This can be a boolean or a function that returns a boolean. If this is not set to a function, config.expanded can be read to get the current state.
Optional getgetValue function. This is used for inputs, if property, value is not specified. This is called to get the value of the input on each render/update. It is ignored if property or value is specified.
Optional hiddenThe Ui element will be hidden if this is true. This can be a boolean or a function that returns a boolean.
Optional inlineOnly for elements with inline picker support This can be a boolean or a function that returns a boolean.
Optional labelThe label to use for the object. This is used as the title for folders, and as the label for inputs. This can be a string or a function that returns a string. If not provided, the label will be determined automatically, by the key of the property or sets to defaults
Optional ononChange callbacks can be added to the config object to be called when the value of the object changes. This can be a function or an array of functions. When it's specified with a container(with children) object, it will be called when any of the children change, and the config of the child that's changed will be available in the arguments
Optional onA function to be called when the Ui element is clicked. Only for buttons. This is an alias of config.value or config.property for buttons.
Rest ...args: any[]Optional onOnly for folders. The callback called when a folder is expanded or collapsed.
Optional parentInternal
Can be set by the parent, if this is a child object.
Rest ...args: ChangeArgsOptional pathPath of the binding inside the value. (dot separated json path) In case of property it is appended to the property path.
Optional propertyThe property to bind to. This is used for inputs. This can be an array of [target, key] or a function that returns an array of [target, key]. key can be a number for arrays, or a dot separated path for json objects.
Optional readThe Ui input will be read-only if this is true, i.e. the user will not be able to change the value. This can be a boolean or a function that returns a boolean. This can also be achieved by setting specifying a getValue function, but not a setValue function. Or by setting disabled to true.
Optional setsetValue function. This is used for inputs, if property, value is not specified. This is called when the value of the input changes. It is ignored if property or value is specified.
The value to set
Rest ...args: ChangeArgsother arguments like the config, renderer, etc. See source code for details.
Optional stepstepSize for specifying the min change in the value. This is used for numeric inputs like number and slider. The value will be rounded to the nearest multiple of stepSize. This can be a number or a function that returns a number.
Optional tagstags can be added to the config object to be used for filtering, like rendering only objects with a certain tag. This can be a string or an array of strings.
Optional typeThe type of the object. This is used to determine the component to use. Examples: 'button', 'slider', 'dropdown', 'folder', 'input' etc
Optional uiAfter initial rendering, config.uiRef will be set to the instance of the UI component that's created. The type of this will depend on the type of the component and the base UI library used. This can be used to access the UI component directly, for example to add event listeners. Note that the uiRef might change on render.
Optional uiThe type of the UI component that's referenced by config.uiRef. This is set during rendering and used to re-render the UI if config.type changes.
Optional uiAfter initial rendering, config.uiRefresh will be set to a function that can be used to re-render the UI.
Optional deep: booleanIf true, the UI will be re-rendered recursively, otherwise only the current object will be re-rendered.
Optional mode: TUiRefreshModes | "immediate"The mode to re-render in. See TUiRefreshModes for details. Use when syncing with custom render loop
Optional delay: numberThe delay in ms to wait before re-rendering. This is useful if multiple changes are made in quick succession. If another refresh event is in the queue for the same object, it will be postponed by this amount. This is not exact for small values.
Optional uuidAn optional uuid to identify this object. If not provided, one will be generated during first render. This must be provided if a new UiObjectConfig object is generated each time the config is rendered.
Optional valueThe value of the object. This is used for inputs, if property is not provided.
Generated using TypeDoc
Alias for property