Element: <oj-switcher>

Oracle® JavaScript Extension Toolkit (JET)
5.2.0
E97691-01

JET Custom Elements

JET components are implemented as custom HTML elements. In addition to the component attributes documented in this page, JET components also support standard HTML global attributes like id and aria-label.

The JET data binding syntax can be used to define both component and global attributes through the use of dynamically evaluated expressions. All attributes (component and global) support attribute-level binding by prefixing the attribute name with ":" (e.g. :id="[...]"). When using attribute-level binding, all expression values are treated as strings. Additionally, component attributes support property-level binding by using the attribute name directly with no ":" prefix. When using property-level binding, the expressions should evaluate to the types documented by the corresponding attributes. Property-level binding is strongly recommended over attribute-level binding for component attributes.

A detailed description of working with custom HTML elements can be found in: JET Custom Element Usage.

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:

5.2.0

Since:

4.0.0

Module:

ojswitcher

The switcher element dynamically decides which child element should be made visible. It will make a child element visible only if it's slot attribute's value matches with switcher's value property.

If child content is expensive to render, use oj-defer to defer rendering until child element is made visible.


<oj-switcher value="[[selectedValue]]">
 <div slot="home">...<div>
 <div slot="about">...<div>
 <div slot="settings">...<div>
 ...
</oj-switcher>

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.

Attributes

value :string

value of the switcher. Setting value will make all child elements with matching slot attribute as visible and hides elements which are not matching.

Default Value:

""

Names

Item	Name
Property	`value`
Property change event	`valueChanged`
Property change listener attribute (must be of type function)	`on-value-changed`

Examples

Initialize the Switcher with the value attribute specified:

 <oj-switcher value='settings'> ... </oj-switcher>

Read value property:

var selectedValue = mySwitcher.value;

Change value property:

mySwitcher.value = 'settings';

Methods

getProperty(property) → {any}

Retrieves a value for a property or a single subproperty for complex properties.

Parameters:

Name	Type	Description
`property`	string	The property name to get. Supports dot notation for subproperty access.

Returns:

Type: any

Example

Get a single subproperty of a complex property:

var subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');

refresh() → {void}

Refreshes the visual state of the component.

Returns:

Type: void

setProperties(properties) → {void}

Performs a batch set of properties.

Parameters:

Name	Type	Description
`properties`	Object	An object containing the property and value pairs to set.

Returns:

Type: void

Example

Set a batch of properties:

myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});

setProperty(property, value) → {void}

Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.

Parameters:

Name	Type	Description
`property`	string	The property name to set. Supports dot notation for subproperty access.
`value`	any	The new value to set the property to.

Returns:

Type: void

Example

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");