Element: <oj-accordion>

Oracle® JavaScript Extension Toolkit (JET)
5.0.0

E90577-01

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:
  • 5.0.0
Since:
  • 0.6
Module:
  • ojaccordion

JET Accordion

Description: A JET Accordion contains one or more oj.ojCollapsible child elements.


<oj-accordion>
  <oj-collapsible>
    <h3>
      <img src="images/default.png"/>
      <span>Header 1</span>
    </h3>
    <p>Content 1.</p>
  </oj-collapsible>
  <oj-collapsible expanded="true">
    <h3>Header 3</h3>
    <p>Content 3</p>
  </oj-collapsible>
</oj-accordion>

Touch End User Information

Target Gesture Action
Collapsible header Tap Toggle disclosure state.

Keyboard End User Information

Target Key Action
Collapsible header Space or Enter Toggle disclosure state.
Collapsible header Tab Navigate to next collapsible header and if none then the next element on page.
Collapsible header Shift+Tab Navigate to previous collapsible header and if none then the previous element on page.
Collapsible header UpArrow or LeftArrow (RightArrow in RTL) Move focus to the previous collapsible header with wrap around.
Collapsible header DownArrow or RightArrow (LeftArrow in RTL) Move focus to the next collapsible header with wrap around.
Collapsible header Home Move focus to the first collapsible header.
Collapsible header End Move focus to the last collapsible header.

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

Reading direction

In the unusual case that the directionality (LTR or RTL) changes post-init, the accordion 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 elements can have up to two types of child content:

  • Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
  • Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child. This is documented under the "Default" heading below.

Default

The <oj-accordion> element accepts one or more <oj-collapsible> elements as children.

Example

Initialize the Accordion with two Collapsible children specified:

<oj-accordion>
  <oj-collapsible>
    <h3>Header 1</h3>
    <p>Content 1</p>
  </oj-collapsible>
  <oj-collapsible expanded="true">
    <h3>Header 2</h3>
    <p>Content 2</p>
  </oj-collapsible>
</oj-accordion>

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 and demos 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.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

Attributes

expanded :Array<string>|Array<number>|Array<{id?: string, index?: number}>|null

Array contains either string ids or numeric zero-based indices or objects containing string id and/or numeric index of the collapsibles that should be expanded.

Setter value: array of either string ids or numeric indices or objects containing either string id or numeric index or both. If the object contains both id and index, numeric index takes precedence.

Getter value: array of objects containing numeric index and string id, if available. If an expanded collapsible has a page author provided id, that id is returned.

Note: The default value of null means that accordion doesn't modify the expanded state of its child collapsibles. When the value is specified, it overrides the expanded state of its child collapsibles.

Default Value:
  • null
Supports writeback:
  • true
Names
Item Name
Property expanded
Property change event expandedChanged
Property change listener attribute (must be of type function) on-expanded-changed
Examples

Initialize the accordion with the expanded attribute specified:

<oj-accordion expanded="['collapsible2']"></oj-accordion>

Get or set the expanded property after initialization:

// getter
var expanded = myAccordion.expanded;

// setter
myAccordion.expanded=['collapsible1'];

multiple :boolean

Allow multiple collapsibles to be open at the same time. Note: if multiple is true, the beforeCollapse/beforeExpand/collapse/expand events will not be fired by the accordion. They are however fired by the collapsibles.
Default Value:
  • false
Names
Item Name
Property multiple
Property change event multipleChanged
Property change listener attribute (must be of type function) on-multiple-changed
Examples

Initialize the accordion with the multiple attribute specified:

<oj-accordion multiple='true'></oj-accordion>

Get or set the multiple property after initialization:

// getter
var multipleValue = myAccordion.multiple;

// setter
myAccordion.multiple=true;

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
Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

Events

ojBeforeCollapse

Triggered immediately before any collapsible in the accordion is collapsed. Call event.preventDefault() in the event listener to veto the event, which prevents the content from collapsing. If multiple is true, the beforeCollapse event will not be fired by the accordion.
Properties:

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

Name Type Description
toCollapsible Element The collapsible being expanded.
fromCollapsible Element The collapsible being collapsed.
Examples

Specify an ojBeforeCollapse listener via the DOM attribute:

<oj-accordion on-oj-before-collapse='[[listener]]'></oj-accordion>

Specify an ojBeforeCollapse listener via the JavaScript property:

myAccordion.onOjBeforeCollapse = listener;

Add an ojBeforeCollapse listener via the addEventListener API:

myAccordion.addEventListener('ojBeforeCollapse', listener);

ojBeforeExpand

Triggered immediately before any collapsible in the accordion is expanded. Call event.preventDefault() in the event listener to veto the event, which prevents the content from expanding. If multiple is true, the beforeExpand event will not be fired by the accordion.
Properties:

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

Name Type Description
toCollapsible Element The collapsible being expanded.
fromCollapsible Element The collapsible being collapsed.
Examples

Specify an ojBeforeExpand listener via the DOM attribute:

<oj-accordion on-oj-before-expand='[[listener]]'></oj-accordion>

Specify an ojBeforeExpand listener via the JavaScript property:

myAccordion.onOjBeforeExpand = listener;

Add an ojBeforeExpand listener via the addEventListener API:

myAccordion.addEventListener('ojBeforeExpand', listener);

ojCollapse

Triggered after any collapsible in the accordion has been collapsed (after animation completes). The collapse can be cancelled by calling event.preventDefault(). If multiple is true, the collapse event will not be fired by the accordion.
Properties:

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

Name Type Description
toCollapsible Element The collapsible being expanded.
fromCollapsible Element The collapsible being collapsed.
Examples

Specify an ojCollapse listener via the DOM attribute:

<oj-accordion on-oj-collapse='[[listener]]'></oj-accordion>

Specify an ojCollapse listener via the JavaScript property:

myAccordion.onOjCollapse = listener;

Add an ojCollapse listener via the addEventListener API:

myAccordion.addEventListener('ojCollapse', listener);

ojExpand

Triggered after the accordion has been expanded (after animation completes). The expand can be cancelled by calling event.preventDefault(). If multiple is true, the expand event will not be fired by the accordion.
Properties:

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

Name Type Description
toCollapsible Element The collapsible being expanded.
fromCollapsible Element The collapsible being collapsed.
Examples

Specify an ojExpand listener via the DOM attribute:

<oj-accordion on-oj-expand='[[listener]]'></oj-accordion>

Specify an ojExpand listener via the JavaScript property:

myAccordion.onOjExpand = listener;

Add an ojExpand listener via the addEventListener API:

myAccordion.addEventListener('ojExpand', listener);

Methods

getProperty(property) → {*}

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.
Since:
  • 4.0.0
Returns:
Type
*
Example

Get a single subproperty of a complex property:

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

refresh() → {void}

Refreshes the visual state of the accordion.

This method does not accept any arguments.

Returns:
Type
void
Example

Invoke the refresh method:

myAccordion.refresh();

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.
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 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 * 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");