Coral.Accordion

Current Version: 3.2.6
Note:Any Coral CSS classes and attributes not explicitly mentioned in the public documentation are private and subject to change. Their direct use is not recommended and at high risk of breaking after subsequent updates of CoralUI library. For technical details of how to use Coral safely, please refer to the CoralUI Architecture.
Github: @coralui/coralui-component-accordion

An accordion consists of multiple collapsibles. When one collapsible in the accordion is expanded, the others are collapsed.

Coral.Accordion.Item Attributes

selected

Sets an item as expanded.

Item B content.
Show Markup 
<coral-accordion>
  <coral-accordion-item>
    <coral-accordion-item-label>Item A</coral-accordion-item-label>
    <coral-accordion-item-content>Item A content.</coral-accordion-item-content>
  </coral-accordion-item>
  <coral-accordion-item selected>
    <coral-accordion-item-label>Item B</coral-accordion-item-label>
    <coral-accordion-item-content>Item B content.</coral-accordion-item-content>
  </coral-accordion-item>
</coral-accordion>

disabled

Disables the an item so it cannot be expanded.

Show Markup 
<coral-accordion>
  <coral-accordion-item>
    <coral-accordion-item-label>Item A</coral-accordion-item-label>
    <coral-accordion-item-content>Item A content.</coral-accordion-item-content>
  </coral-accordion-item>
  <coral-accordion-item disabled>
    <coral-accordion-item-label>Item B</coral-accordion-item-label>
    <coral-accordion-item-content>Item B content.</coral-accordion-item-content>
  </coral-accordion-item>
  <coral-accordion-item>
    <coral-accordion-item-label>Item C</coral-accordion-item-label>
    <coral-accordion-item-content>Item C content.</coral-accordion-item-content>
  </coral-accordion-item>
</coral-accordion>

coral-interactive

Mark an element and its children as being interactive. If an element or one of its parents has the coral-interactive attribute and is clicked, then the toggling of the accordion item will not occur.

Show Markup 
<coral-accordion>
  <coral-accordion-item>
    <coral-accordion-item-label><span>Item A</span>
      <coral-checkbox coral-interactive></coral-checkbox>
    </coral-accordion-item-label>
    <coral-accordion-item-content>Item A content.</coral-accordion-item-content>
  </coral-accordion-item>
  <coral-accordion-item disabled>
    <coral-accordion-item-label>Item B
      <div coral-interactive>
        <button is="null">Action 1</button>
        <button is="null">Action 2</button>
      </div>
    </coral-accordion-item-label>
    <coral-accordion-item-content>Item B content.</coral-accordion-item-content>
  </coral-accordion-item>
  <coral-accordion-item>
    <coral-accordion-item-label>Item C</coral-accordion-item-label>
    <coral-accordion-item-content>Item C content.</coral-accordion-item-content>
  </coral-accordion-item>
</coral-accordion>

Coral.Accordion API

Constructor

JavaScript:

new Coral.Accordion() or document.createElement('coral-accordion')

HTML Tag:

<coral-accordion>

Extends

Mixes In

Sub-components

Static Properties

Coral.Accordion.variant {String}

Enum for Accordion variant values.

Properties:

Name Type Value Description
DEFAULT String default Default Tabpanel look and feel.
QUIET String quiet Quiet variant with minimal borders.
LARGE String large Large variant, typically used inside a navigation rail since it does not have borders on the sides.

Instance Properties

instance.hidden {Boolean}

Reflected
Whether this component is hidden or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • hidden

instance.items {Coral.Collection}

Readonly
The Collection Interface that allows interacting with the items that the component contains. See Coral.Collection for more details.

instance.selectedItem {HTMLElement}

Readonly
Returns the first selected item in the selectionList. The value null is returned if no element is selected.

instance.variant {Coral.Accordion.variant}

The Accordion's variant.
Default Value:
  • Coral.Accordion.variant.DEFAULT
HTML Attribute:
  • variant

Methods

instance.get

Get the value of a property.
Parameters:
Name Type Description
property String The name of the property to fetch the value of.
Returns:
Property value. {*}
Inherited From:

instance.hide

Hide this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.off

Remove an event listener.
Parameters:
Name Type Optional Description
eventName String No
 The event name to stop listening for.
selector String Yes
 The selector that was used for event delegation.
func function No
 The function that was passed to on().
useCapture Boolean Yes
 Only remove listeners with useCapture set to the value passed in.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.on

Add an event listener.
Parameters:
Name Type Optional Default Description
eventName String No
 The event name to listen for.
selector String Yes
 The selector to use for event delegation.
func function No
 The function that will be called when the event is triggered.
useCapture Boolean Yes
 Whether or not to listen during the capturing or bubbling phase.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.remove

Non-destructively remove this element. It can be re-added by simply appending it to the document again. It will be garbage collected if there are no more references to it.
Inherited From:

instance.set

Set a single property.
Parameters:
Name Type Description
property String The name of the property to set.
value * The value to set the property to.
silent Boolean If true, events should not be triggered as a result of this set.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.show

Show this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.trigger

Trigger an event.
Parameters:
Name Type Optional Default Description
eventName String No
 The event name to trigger.
props Object Yes
 Additional properties to make available to handlers as event.detail.
bubbles Boolean Yes
 Set to false to prevent the event from bubbling.
cancelable Boolean Yes
 Set to false to prevent the event from being cancelable.
Returns:
CustomEvent object {CustomEvent}
Inherited From:

Events

coral-collection:add

Triggered when an item is added to the Collection. Collection events are not synchronous so the DOM may reflect a different reality although every addition or removal will be reported.
Callback Parameters:
Name Type Description
event Object

Event object.

Name Type Description
event.detail.item HTMLElement The item that was added.
Inherited From:

coral-collection:remove

Triggered when an item is removed from a Collection. Collection events are not synchronous so the DOM may reflect a different reality although every addition or removal will be reported.
Callback Parameters:
Name Type Description
event Object

Event object.

Name Type Description
event.detail.item HTMLElement The item that was removed.
Inherited From:

coral-accordion:change

Triggered when the selected item has changed.
Callback Parameters:
Name Type Description
event Object

Event object

Name Type Description
event.detail Object

Name Type Description
event.detail.oldSelection HTMLElement The prior selected item(s).
event.detail.selection HTMLElement The newly selected item(s).

coral-component:attached

Triggered when the component is attached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:
Deprecated:
  • since 1.14.0, use MutationObserver instead.

    coral-component:detached

    Triggered when the component is detached to the DOM.
    Callback Parameters:
    Name Type Description
    event Object Event object.
    Inherited From:
    Deprecated:
    • since 1.14.0, use MutationObserver instead.

      coral-component:ready

      Triggerred when the component has been upgraded and is ready for use.
      Callback Parameters:
      Name Type Description
      event Object Event object.
      Inherited From:
      Deprecated:
      • since 1.9.0, use Coral.commons.ready() instead.

        Coral.Accordion.Item API

        Constructor

        JavaScript:

        new Coral.Accordion.Item() or document.createElement('coral-accordion-item')

        HTML Tag:

        <coral-accordion-item>

        Extends

        Mixes In

        Sub-components

        Instance Properties

        instance.content {HTMLElement}

        The content of this accordion item.

        instance.disabled {Boolean}

        Reflected
        Whether this item is disabled. When set to true, this will prevent every user interaction with the item. If disabled is set to true for a selected item it will be deselected.
        Default Value:
        • false
        HTML Attribute:
        • disabled

        instance.hidden {Boolean}

        Reflected
        Whether this component is hidden or not.
        Inherited From:
        Default Value:
        • false
        HTML Attribute:
        • hidden

        instance.label {HTMLElement}

        The label of this accordion item.

        instance.selected {Boolean}

        Reflected
        Whether the item is selected. Selected cannot be set to true if the item is disabled.
        Default Value:
        • false
        HTML Attribute:
        • selected

        Methods

        instance._onCollapsed

        Handles styling of the container after collapsing.

        instance.get

        Get the value of a property.
        Parameters:
        Name Type Description
        property String The name of the property to fetch the value of.
        Returns:
        Property value. {*}
        Inherited From:

        instance.hide

        Hide this component.
        Returns:
        this, chainable {Coral.Component}
        Inherited From:

        instance.off

        Remove an event listener.
        Parameters:
        Name Type Optional Description
        eventName String No
        		 The event name to stop listening for.
        selector String Yes
        		 The selector that was used for event delegation.
        func function No
        		 The function that was passed to on().
        useCapture Boolean Yes
        		 Only remove listeners with useCapture set to the value passed in.
        Returns:
        this, chainable. {Coral.Component}
        Inherited From:

        instance.on

        Add an event listener.
        Parameters:
        Name Type Optional Default Description
        eventName String No
        		 The event name to listen for.
        selector String Yes
        		 The selector to use for event delegation.
        func function No
        		 The function that will be called when the event is triggered.
        useCapture Boolean Yes
        		 Whether or not to listen during the capturing or bubbling phase.
        Returns:
        this, chainable. {Coral.Component}
        Inherited From:

        instance.remove

        Non-destructively remove this element. It can be re-added by simply appending it to the document again. It will be garbage collected if there are no more references to it.
        Inherited From:

        instance.set

        Set a single property.
        Parameters:
        Name Type Description
        property String The name of the property to set.
        value * The value to set the property to.
        silent Boolean If true, events should not be triggered as a result of this set.
        Returns:
        this, chainable. {Coral.Component}
        Inherited From:

        instance.show

        Show this component.
        Returns:
        this, chainable {Coral.Component}
        Inherited From:

        instance.trigger

        Trigger an event.
        Parameters:
        Name Type Optional Default Description
        eventName String No
        		 The event name to trigger.
        props Object Yes
        		 Additional properties to make available to handlers as event.detail.
        bubbles Boolean Yes
        		 Set to false to prevent the event from bubbling.
        cancelable Boolean Yes
        		 Set to false to prevent the event from being cancelable.
        Returns:
        CustomEvent object {CustomEvent}
        Inherited From:

        Events

        coral-component:attached

        Triggered when the component is attached to the DOM.
        Callback Parameters:
        Name Type Description
        event Object Event object.
        Inherited From:
        Deprecated:
        • since 1.14.0, use MutationObserver instead.

          coral-component:detached

          Triggered when the component is detached to the DOM.
          Callback Parameters:
          Name Type Description
          event Object Event object.
          Inherited From:
          Deprecated:
          • since 1.14.0, use MutationObserver instead.

            coral-component:ready

            Triggerred when the component has been upgraded and is ready for use.
            Callback Parameters:
            Name Type Description
            event Object Event object.
            Inherited From:
            Deprecated:
            • since 1.9.0, use Coral.commons.ready() instead.