[ { "id": "oj-c.AccordionItemMultiple", "name": "AccordionItemMultiple", "memberof": "oj-c", "kind": "class", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "ojcomponent": true, "isvcomponent": true, "since": "20.0.0", "longname": "oj-c.AccordionItemMultiple", "pack": "oj-c", "classdesc": "

\n JET AccordionItemMultiple\n \n

\n

Description: The oj-c-accordion-item-multiple component renders collapsible content in a group, supporting multiple expansion mode (multiple items can be expanded at once). Use itemKey and expandedKeys to control and identify expanded items. Event handlers onOjExpand and onOjCollapse provide callbacks for responding to expansion and collapse events.

\n

This component is typically used in Layout & Nav scenarios, such as within templates for Table, ListView, or CardView. It supports accessibility via the aria-label attribute and requires header text for screen readers.

\n\n
\n<oj-c-accordion-item-multiple\n   item-key=\"item1\"\n   expanded-keys=\"[[expandedKeys]]\"\n   on-oj-expand=\"[[expandHandler]]\"\n   on-oj-collapse=\"[[collapseHandler]]\"\n   aria-label=\"Details for Item 1\"\n>\n  <h3 slot=\"header\">Item 1</h3>\n  <div>Content for Item 1</div>\n</oj-c-accordion-item-multiple>\n
\n\n

Accessibility

\n

Specify a value for the aria-label attribute with a meaningful description of the purpose of this accordion item for accessibility. Header text is required for screen readers.

\n\n

Keyboard End User Information

\n\n\n

Touch End User Information

\n\n\n

Validation and Messaging

\n

This component does not support validation or messaging directly. Use parent form components for validation if needed.

\n\n

User Assistance Text

\n

Provide clear header text and aria-labels for accessibility and user guidance.

", "scope": "static", "tagWithoutBrackets": "oj-c-accordion-item-multiple", "tagWithBrackets": "", "domInterface": "CAccordionItemMultipleElement", "ojPageTitle": "<oj-c-accordion-item-multiple>", "camelCaseName": "AccordionItemMultiple", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CAccordionItemMultipleElement extends JetElement>", "genericParameters": [ { "name": "K", "description": "Type extends string or number" } ] }, "ojsignature": [ { "target": "Type", "value": "interface CAccordionItemMultipleElement extends JetElement>", "genericParameters": [ { "name": "K", "description": "Type extends string or number" } ] } ], "tsdeprecated": [ { "type": "supersedes", "since": "20.0.0", "value": [ "oj-accordion" ] } ], "extension": { "catalog": { "category": "Layout & Nav" }, "vbdt": { "module": "oj-c/accordion-item-multiple" } }, "ojmodule": "accordion-item-multiple" }, { "id": "oj-c.AccordionItemMultiple#itemKey", "name": "itemKey", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "member", "longname": "oj-c.AccordionItemMultiple#itemKey", "scope": "instance", "type": { "names": [ "string|number" ] }, "optional": true, "ojdisplayname": "Item Key", "ojshortdesc": "Specifies the item key of each AccordionItemMultiple.", "description": "Specifies the item key of each AccordionItemMultiple.\nUse itemKey to uniquely identify each item in the accordion.", "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true } ] }, { "id": "oj-c.AccordionItemMultiple#expandedKeys", "name": "expandedKeys", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "member", "longname": "oj-c.AccordionItemMultiple#expandedKeys", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": false, "ojdisplayname": "Expanded Keys", "ojwriteback": true, "ojshortdesc": "Specifies the expandedKeys.", "description": "Specifies the expandedKeys property.\nUse expandedKeys to control which items are expanded.\nBind this property to an observable array in your ViewModel (e.g., ko.ObservableArray<string>) to programmatically expand/collapse items.", "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true } ] }, { "id": "oj-c.AccordionItemMultiple#disabled", "name": "disabled", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "member", "longname": "oj-c.AccordionItemMultiple#disabled", "scope": "instance", "type": { "names": [ "boolean" ] }, "optional": true, "ojdisplayname": "Disabled", "description": "Disables the item if set to true." }, { "id": "oj-c.AccordionItemMultiple#iconPosition", "name": "iconPosition", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "member", "longname": "oj-c.AccordionItemMultiple#iconPosition", "scope": "instance", "type": { "names": [ "\"end\"", "\"start\"" ] }, "optional": true, "ojdisplayname": "Icon Position", "description": "Changes chevron icon placement at the end of the collapsible header." }, { "id": "oj-c.AccordionItemMultiple#setProperty", "name": "setProperty", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "function", "longname": "oj-c.AccordionItemMultiple#setProperty", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.", "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.", "params": [ { "name": "property", "description": "The property name to set. Supports dot notation for subproperty access.", "type": { "names": [ "string" ] } }, { "name": "value", "description": "The new value to set the property to.", "type": { "names": [ "any" ] } } ] }, { "id": "oj-c.AccordionItemMultiple#getProperty", "name": "getProperty", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "function", "longname": "oj-c.AccordionItemMultiple#getProperty", "scope": "instance", "returns": [ { "type": { "names": [ "any" ] } } ], "ojshortdesc": "Retrieves the value of a property or a subproperty.", "description": "Retrieves the value of a property or a subproperty.", "params": [ { "name": "property", "description": "The property name to get. Supports dot notation for subproperty access.", "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.AccordionItemMultiple#setProperties", "name": "setProperties", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "function", "longname": "oj-c.AccordionItemMultiple#setProperties", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "Performs a batch set of properties.", "description": "Performs a batch set of properties.", "params": [ { "name": "properties", "description": "An object containing the property and value pairs to set.", "type": { "names": [ "object" ] } } ] }, { "id": "oj-c.AccordionItemMultiple#event:ojCollapse", "name": "ojCollapse", "kind": "event", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "longname": "oj-c.AccordionItemMultiple#event:ojCollapse", "scope": "instance", "ojshortdesc": "Triggered after the item has been collapsed (after animation completes).", "description": "

Note: The event detail contains the following properties: [oj-c.AccordionItemMultiple.AccordionItemMultipleDetail]{@link oj-c.AccordionItemMultiple.AccordionItemMultipleDetail}<K>

Triggered after the item has been collapsed (after animation completes)." }, { "id": "oj-c.AccordionItemMultiple#event:ojExpand", "name": "ojExpand", "kind": "event", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "longname": "oj-c.AccordionItemMultiple#event:ojExpand", "scope": "instance", "ojshortdesc": "Triggered after the item has been expanded (after animation completes).", "description": "

Note: The event detail contains the following properties: [oj-c.AccordionItemMultiple.AccordionItemMultipleDetail]{@link oj-c.AccordionItemMultiple.AccordionItemMultipleDetail}<K>

Triggered after the item has been expanded (after animation completes)." }, { "id": "oj-c.AccordionItemMultiple#header", "name": "header", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "member", "longname": "oj-c.AccordionItemMultiple#header", "scope": "instance", "ojdisplayname": "Header", "description": "Item's header. If not specified, the header contains only an open/close icon.\nThe header text is required for accessibility purposes.", "ojshortdesc": "Item's header. If not specified, the header contains only an open/close icon. The header text is required for accessibility purposes.", "ojslot": true }, { "id": "oj-c.AccordionItemMultiple#Default", "name": "Default", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "kind": "member", "longname": "oj-c.AccordionItemMultiple#Default", "scope": "instance", "ojdisplayname": "Content", "description": "The content node to be expanded or collapsed.\nPlace any content to be shown/hidden inside this property.", "ojshortdesc": "Item's content node. Place any content to be shown/hidden inside this property.", "ojchild": true }, { "id": "oj-c.AccordionItemMultiple.AccordionItemMultipleDetail", "name": "AccordionItemMultipleDetail", "kind": "typedef", "memberof": "oj-c.AccordionItemMultiple", "meta": { "filename": "accordion-item-multiple.tsx", "path": "web/components/oj-c/accordion-item-multiple" }, "longname": "oj-c.AccordionItemMultiple.AccordionItemMultipleDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Payload for the onOjCollapse event and onOjExpand event.\n

All of the event payloads listed below can be found under event.detail. See Events and Listeners for additional information.

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription
fromArray<K> | undefinedThe keys of the items that were previously expanded.
toArray<K> | nullThe keys of the items that are now expanded.
", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "fromKeys", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "fromKeys" } ] }, { "name": "toKeys", "optional": false, "type": { "names": [ "Array|null" ] }, "tstype": [ { "target": "Type", "value": "Array|null", "jsdocOverride": true, "for": "toKeys" } ] } ] } ]