Element: <oj-collapsible>

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

class ojCollapsible

QuickNav

Attributes

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:
  • 7.1.0
Since:
  • 0.6.0
Module:
  • ojcollapsible

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To typecheck the element APIs, import as below.
import {ojCollapsible} from "ojs/ojcollapsible";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojcollapsible";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.


JET Collapsible

Description: A JET Collapsible displays a header that can be expanded to show additional content beneath it. The child element of the oj-collapsible in the named header slot is displayed in the header, while the child element in the default slot is displayed as the content.

Note for performance reasons, if the collapsible content is expensive to render, you should wrap it in an oj-defer element (API doc oj.ojDefer) to defer the rendering of that content.
See the Collapsible - Deferred Rendering demo for an example.


<oj-collapsible>
  <h3 slot='header'>Header 1</h3>
  <p>Content 1</p>
</oj-collapsible>

Touch End User Information

Target Gesture Action
Header Tap Toggle disclosure state

Keyboard End User Information

Target Key Action
Header Space or Enter Toggle disclosure state.

Disabled items can receive keyboard focus, but do not allow any other interaction.

Styling

The following CSS classes can be applied by the page author as needed.

Class Description
oj-clickthrough-disabled Use on any element inside the header where you do not want Collapsible to process the click event.

Reading direction

In the unusual case that the directionality (LTR or RTL) changes post-init, the collapsible must be refresh()ed.

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.

Slots

JET components that allow child content support slots. Please see the slots section of the JET component overview doc for more information on allowed slot content and slot types.

Default

The default slot is the collapsible's content.

contextMenu

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot.

The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc of the individual components for details.

Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

The header slot is the collapsible's header. If not specified, the header contains only an open/close icon. Note that the header text is required for JET collapsible for accessibility purposes.

Attributes

disabled :boolean

Disables the collapsible if set to true.
Default Value:
  • false
Names
Item Name
Property disabled
Property change event disabledChanged
Property change listener attribute (must be of type function) on-disabled-changed

expand-area :"header"|"disclosureIcon"

Where in the header to click to toggle disclosure.
Supported Values:
Value Description
"disclosureIcon" click the disclosureIcon to toggle disclosure
"header" click any where in the header to toggle disclosure
Default Value:
  • "header"
Names
Item Name
Property expandArea
Property change event expandAreaChanged
Property change listener attribute (must be of type function) on-expand-area-changed

expanded :boolean

Specifies if the content is expanded.
Default Value:
  • false
Supports writeback:
  • true
Names
Item Name
Property expanded
Property change event expandedChanged
Property change listener attribute (must be of type function) on-expanded-changed

translations :object|null

A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

If the component does not contain any translatable resource, the default value of this attribute will be null. If not, an object containing all resources relevant to the component.

If this component has translations, their documentation immediately follows this doc entry.

Names
Item Name
Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function) on-translations-changed

Events

ojBeforeCollapse

Triggered immediately before the collapsible is collapsed. Call event.preventDefault() in the event listener to veto the event, which prevents the content from collapsing.
Properties:

All of the event payloads listed below can be found under event.detail.

Name Type Description
header Element The header that is about to be collapsed.
content Element The content that is about to be collapsed.

ojBeforeExpand

Triggered immediately before the collapsible is expanded. Call event.preventDefault() in the event listener to veto the event, which prevents the content from expanding.
Properties:

All of the event payloads listed below can be found under event.detail.

Name Type Description
header Element The header that is about to be expanded.
content Element The content that is about to be expanded.

ojCollapse

Triggered after the collapsible has been collapsed.
Properties:

All of the event payloads listed below can be found under event.detail.

Name Type Description
header Element The header that was just collapsed.
content Element The content that was just collapsed.

ojExpand

Triggered after the collapsible has been expanded (after animation completes).
Properties:

All of the event payloads listed below can be found under event.detail.

Name Type Description
header Element The header that was just expanded.
content Element The content that was just expanded.

Methods

getProperty(property) → {any}

Retrieves the value of a property or a subproperty. The return type will be the same as the type of the property as specified in this API document. If the method is invoked with an incorrect property/subproperty name, it returns undefined.
Parameters:
Name Type Description
property string The property name to get. Supports dot notation for subproperty access.
Since:
  • 4.0.0
Returns:
Type
any
Example

Get a single subproperty of a complex property:

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

refresh() → {void}

Refreshes the visual state of the collapsible.

This method does not accept any arguments.

Returns:
Type
void

setProperties(properties) → {void}

Performs a batch set of properties. The type of value for each property being set must match the type of the property as specified in this API document.
Parameters:
Name Type Description
properties Object An object containing the property and value pairs to set.
Since:
  • 4.0.0
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 subproperty (of a complex property) and notifies the component of the change, triggering a [property]Changed event. The value should be of the same type as the type of the attribute mentioned in this API document.
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.
Since:
  • 4.0.0
Returns:
Type
void
Example

Set a single subproperty of a complex property:

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