[ { "id": "oj-c.TabBar", "name": "TabBar", "memberof": "oj-c", "kind": "class", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "ojcomponent": true, "isvcomponent": true, "since": "17.0.0", "longname": "oj-c.TabBar", "pack": "oj-c", "classdesc": "

\n JET TabBar\n \n

\n\nThe oj-c-tab-bar enables horizontal navigation.\n\n

\n Touch End User Information\n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetGestureAction
TabTapSelects the tab.
Remove buttonTapRemoves the tab.
Arrow buttonTapWhen tabs are displayed inside a conveyor belt, tapping the arrow button will scroll the conveyor belt.
\n\n

\n Keyboard End User Information\n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetKeyAction
TabEnter or SpaceSelect the current tab.
LeftArrow or RightArrowNavigate to the previous or next tab.
DeleteRemove the current tab.
EscHide the tooltip if tooltip is shown.
HomeNavigates to the first tab in the tablist.
EndNavigates to the last tab in the tablist.
Command/Ctrl + Shift + LeftArrow (RightArrow in RTL)Moves the tab before the previous tab.
Command/Ctrl + Shift + RightArrow (LeftArrow in RTL)Moves the tab after the next tab.
DropdownUpArrow or DownArrowNavigate the tab represented as item in the list in the direction of the arrow.
Enter or SpaceSelect the highlighted choice from the dropdown and close the dropdown.
EscClose the dropdown.
\n\n

\nAccessibility\n\n

\n

It is not recommended to use oj-c-tab-bar only for the purpose of rendering links that navigate to a different page. Instead, each item that has a link should be interactive and activating it should display or switch a content panel within the same page or context.

", "scope": "static", "tagWithoutBrackets": "oj-c-tab-bar", "tagWithBrackets": "", "domInterface": "CTabBarElement", "ojPageTitle": "<oj-c-tab-bar>", "camelCaseName": "TabBar", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CTabBarElement extends JetElement>" }, "ojsignature": [ { "target": "Type", "value": "interface CTabBarElement extends JetElement>" } ], "tsdeprecated": [ { "type": "supersedes", "since": "19.0.0", "value": [ "oj-tab-bar" ] } ], "ojmodule": "tab-bar" }, { "id": "oj-c.TabBar#data", "name": "data", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#data", "scope": "instance", "type": { "names": [ "Array|DataProvider" ] }, "optional": true, "ojdisplayname": "data", "ojshortdesc": "An array of tabs", "description": "Specifies the data definitions for the tabs.", "defaultvalue": "[]", "tstype": [ { "target": "Type", "value": "Array|oj-c.TabBar.TabLinkItemData>|DataProvider | oj-c.TabBar.TabLinkItemData>", "jsdocOverride": true, "module": { "DataProvider": "ojdataprovider" } } ] }, { "id": "oj-c.TabBar#selection", "name": "selection", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#selection", "scope": "instance", "type": { "names": [ "string|number" ] }, "optional": true, "ojdisplayname": "Selected Tab", "ojwriteback": true, "ojshortdesc": "The key of the selected tab", "description": "The key of the currently selected tab.", "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true } ] }, { "id": "oj-c.TabBar#reorderable", "name": "reorderable", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#reorderable", "scope": "instance", "type": { "names": [ "\"disabled\"", "\"enabled\"" ] }, "optional": true, "ojdisplayname": "reorderable", "ojshortdesc": "The reorderable configuration for tabs.", "description": "Specifies if the tabs can be reordered within the tab bar.\nNote: Do not use with overflow=\"popup\" as reorder is not supported with\npopup.", "ojvalues": [ { "name": "enabled", "description": "Enables reordering of items in tabbar.", "displayName": "Enabled", "type": { "names": [ "string" ] } }, { "name": "disabled", "description": "Disables reordering of items in tabbar.", "displayName": "Disabled", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'disabled'" }, { "id": "oj-c.TabBar#overflow", "name": "overflow", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#overflow", "scope": "instance", "type": { "names": [ "\"hidden\"", "\"popup\"", "\"conveyor\"" ] }, "optional": true, "ojdisplayname": "Layout", "ojshortdesc": "Specifies the overflow behavior.", "description": "Specifies the overflow behavior", "defaultvalue": "'hidden'" }, { "id": "oj-c.TabBar#display", "name": "display", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#display", "scope": "instance", "type": { "names": [ "\"standard\"", "\"icons\"", "\"stacked\"" ] }, "optional": true, "ojdisplayname": "Tabs Display", "ojshortdesc": "The display configuration for tabs.", "description": "Whether to display both the label and icons (\"standard\") or just the icons (\"icons\") or to render stacked display (\"stacked\").\nIn the latter case, the label is displayed in a tooltip instead.", "ojvalues": [ { "name": "standard", "description": "Label and icon are shown for all tabs.", "displayName": "Standard", "type": { "names": [ "string" ] } }, { "name": "icons", "description": "Only icons are shown for all tabs.", "displayName": "Icons", "type": { "names": [ "string" ] } }, { "name": "stacked", "description": "Stacks the badge over the icon and icon over the label when applicable.", "displayName": "Stacked", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'standard'" }, { "id": "oj-c.TabBar#layout", "name": "layout", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#layout", "scope": "instance", "type": { "names": [ "\"stretch\"", "\"condense\"" ] }, "optional": true, "ojdisplayname": "Layout", "ojshortdesc": "The layout configuration for tabs.", "description": "Whether to stretch the tab bar items to occupy available space or to condense items", "ojvalues": [ { "name": "stretch", "description": "Stretches the tab bar items to occupy available space ", "displayName": "Stretch", "type": { "names": [ "string" ] } }, { "name": "condense", "description": "Condenses the space occupied by tab bar items", "displayName": "Condense", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'stretch'" }, { "id": "oj-c.TabBar#edge", "name": "edge", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#edge", "scope": "instance", "type": { "names": [ "\"top\"", "\"bottom\"" ] }, "optional": true, "ojdisplayname": "Edge", "ojshortdesc": "The edge configuration for tabs.", "description": "The position of the TabBar.", "defaultvalue": "'top'" }, { "id": "oj-c.TabBar#truncation", "name": "truncation", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#truncation", "scope": "instance", "type": { "names": [ "\"none\"", "\"progressive\"" ] }, "optional": true, "ojdisplayname": "Truncation", "ojshortdesc": "The truncation configuration for tab labels.", "description": "Truncation applies to the tab labels when there is not enough room to display all tabs.", "defaultvalue": "'none'" }, { "id": "oj-c.TabBar#contextMenuConfig", "name": "contextMenuConfig", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "member", "longname": "oj-c.TabBar#contextMenuConfig", "scope": "instance", "type": { "names": [ "object" ] }, "optional": true, "ojdisplayname": "Context Menu Config", "ojshortdesc": "Specifies a context menu configuration.", "description": "Specifies a context menu configuration.\nIt takes the keys `accessibleLabel` and `items`,\nwhere `accessibleLabel` is optional and items required . `items` function returns an array\nof menu item object representations that indicates what menu items are going to be part of\nmenu based on some specific context menu context.\n\n\n\n\n\n\n\n\n\n
Context Menu Item TypeDef
ContextMenuSeparator{ type: 'separator'}
MenuItem{\ntype?: 'item';\nlabel: string;\nkey: string;\ndisabled?: boolean;\nonAction?: () => void;\nstartIcon?: MenuIcon;\nendIcon?: MenuIcon;\nvariant?: 'standard' | 'destructive';\n};
ContextMenuSubMenu{\ntype: 'submenu';\nlabel?: string;\ndisabled?: boolean;\nstartIcon?: string;\nitems?: Array<ContextMenuItems>;\n};
ContextMenuSelectSingle{\ntype: 'selectsingle';\nkey?: string;\nitems?: Array<MenuSelectItem>;\nselection?: string;\nonSelection?: (detail: { value: string }) => void;\n};
ContextMenuSelectMultiple{\ntype: 'selectmultiple';\nkey?: string;\nitems?: Array<MenuSelectItem>;\nselection?: Array<string>;\nonSelection?: (detail: { value: Array<string> }) => void;\n};
MenuIcon{\ntype?: 'class';\n class: string;\n }\n| {\n type: 'img';\n src: string;\n };
MenuSelectItem{\nlabel: string;\ndisabled?: boolean;\nendIcon?: MenuIcon;\nvalue: string;\n}
", "tstype": [ { "target": "Type", "value": "oj-c.TabBar.CTabBarContextMenuConfig", "jsdocOverride": true } ] }, { "id": "oj-c.TabBar#_doReorderHelper", "name": "_doReorderHelper", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "function", "longname": "oj-c.TabBar#_doReorderHelper", "scope": "instance", "returns": [ { "type": { "names": [ "void" ] } } ], "ojshortdesc": "This is a private method that should only be called by the webelement API.", "description": "This is a private method that should only be called by the webelement API.", "params": [ { "name": "tabBarKeys", "type": { "names": [ "Array" ] } } ], "ojhidden": true }, { "id": "oj-c.TabBar#setProperty", "name": "setProperty", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "function", "longname": "oj-c.TabBar#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.TabBar#getProperty", "name": "getProperty", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "function", "longname": "oj-c.TabBar#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.TabBar#setProperties", "name": "setProperties", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "kind": "function", "longname": "oj-c.TabBar#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.TabBar#event:ojBeforeSelect", "name": "ojBeforeSelect", "kind": "event", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar#event:ojBeforeSelect", "scope": "instance", "ojshortdesc": "Triggered before a tab is selected.", "ojdisplayname": "Before Select", "description": "

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

Triggered before user selects a tab which includes user gestures or selection is changed programmatically." }, { "id": "oj-c.TabBar#event:ojRemove", "name": "ojRemove", "kind": "event", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar#event:ojRemove", "scope": "instance", "ojshortdesc": "Triggered when user performs a remove gesture on a tab.", "ojdisplayname": "Remove", "description": "

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

Triggered when user performs a remove gesture on a tab. The remove gestures include:\n
    \n
  • User clicks the remove icon in a tab
    • \n
  • User presses Delete key on a tab
    • \n
" }, { "id": "oj-c.TabBar#event:ojReorder", "name": "ojReorder", "kind": "event", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar#event:ojReorder", "scope": "instance", "ojshortdesc": "Triggered when user performs a reorder gesture on a tab.", "ojdisplayname": "Reorder", "description": "

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

Triggered when user performs a reorder gesture on a tab. The reorder gestures include:\n
    \n
  • User drags a tab and drops it in a new drop location
    • \n
  • User presses Command + Shift + Arrow key(s) on a tab
    • \n
\nNote: Do not use with overflow=\"popup\" as reorder is not supported with\npopup." }, { "id": "oj-c.TabBar#event:ojSelectionAction", "name": "ojSelectionAction", "kind": "event", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar#event:ojSelectionAction", "scope": "instance", "ojshortdesc": "Triggered when user performs an action gesture on a tab.", "ojdisplayname": "Selection Action", "description": "

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

Triggered when user performs a selection action gesture on a tab. The action gestures include:\n
    \n
  • User clicks anywhere in a tab
    • \n
  • User taps anywhere in a tab
    • \n
  • User pressed spacebar or enter key on a tab
    • \n
" }, { "id": "oj-c.TabBar.touchDoc", "name": "touchDoc", "kind": "member", "longname": "oj-c.TabBar.touchDoc", "description": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetGestureAction
TabTapSelects the tab.
Remove buttonTapRemoves the tab.
Arrow buttonTapWhen tabs are displayed inside a conveyor belt, tapping the arrow button will scroll the conveyor belt.
", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "ojfragment": true }, { "id": "oj-c.TabBar.keyboardDoc", "name": "keyboardDoc", "kind": "member", "longname": "oj-c.TabBar.keyboardDoc", "description": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetKeyAction
TabEnter or SpaceSelect the current tab.
LeftArrow or RightArrowNavigate to the previous or next tab.
DeleteRemove the current tab.
EscHide the tooltip if tooltip is shown.
HomeNavigates to the first tab in the tablist.
EndNavigates to the last tab in the tablist.
Command/Ctrl + Shift + LeftArrow (RightArrow in RTL)Moves the tab before the previous tab.
Command/Ctrl + Shift + RightArrow (LeftArrow in RTL)Moves the tab after the next tab.
DropdownUpArrow or DownArrowNavigate the tab represented as item in the list in the direction of the arrow.
Enter or SpaceSelect the highlighted choice from the dropdown and close the dropdown.
EscClose the dropdown.
", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "ojfragment": true }, { "id": "oj-c.TabBar.TabData", "name": "TabData", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.TabData", "type": { "names": [ "Object" ] }, "scope": "static", "description": "The data item object that represents a tab.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "itemKey", "description": "Key of the TabBarItem", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "itemKey" } ] }, { "name": "label", "description": "Label of the TabBarItem. For icon only display this label is the content\nfor aria-label and tooltip text of the Tab.", "optional": false, "type": { "names": [ "string" ] } }, { "name": "icon", "description": "The icon before the label in non-stack case, icon above the label in\nstacked case or the stand alone icon when no label is specified.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "icon" } ] }, { "name": "badge", "description": "The content to be rendered inside the Badge component.", "optional": true, "type": { "names": [ "number" ] } }, { "name": "metadata", "description": "The content to be rendered inside the Text component as a metadata,\nthat appears after the label in non stack case only.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "severity", "description": "The status icon to be rendered after the label in non stack case only.", "optional": true, "type": { "names": [ "\"none\"", "\"error\"", "\"confirmation\"", "\"info\"", "\"warning\"" ] } }, { "name": "tabPanelId", "description": "Accepts the tabpanel element's ID associated with the tab item", "optional": true, "type": { "names": [ "string" ] } }, { "name": "isRemovable", "description": "Renders a remove icon allowing the tabs to be removed.", "optional": true, "type": { "names": [ "boolean" ] } } ], "ojexports": true }, { "id": "oj-c.TabBar.TabLinkItemData", "name": "TabLinkItemData", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.TabLinkItemData", "type": { "names": [ "Object" ] }, "scope": "static", "description": "The data item object that represents a tab with link.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "itemKey", "description": "Key of the TabBarItem", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "itemKey" } ] }, { "name": "label", "description": "Label of the TabBarItem. For icon only display this label is the content\nfor aria-label and tooltip text of the Tab.", "optional": false, "type": { "names": [ "string" ] } }, { "name": "icon", "description": "The icon before the label in non-stack case, icon above the label in\nstacked case or the stand alone icon when no label is specified.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "icon" } ] }, { "name": "badge", "description": "The content to be rendered inside the Badge component.", "optional": true, "type": { "names": [ "number" ] } }, { "name": "metadata", "description": "The content to be rendered inside the Text component as a metadata,\nthat appears after the label in non stack case only.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "severity", "description": "The status icon to be rendered after the label in non stack case only.", "optional": true, "type": { "names": [ "\"none\"", "\"error\"", "\"confirmation\"", "\"info\"", "\"warning\"" ] } }, { "name": "tabPanelId", "description": "Accepts the tabpanel element's ID associated with the tab item", "optional": true, "type": { "names": [ "string" ] } }, { "name": "href", "description": "Sets the URL that the hyperlink points to. If there is no valid URL use \"#\" for href value to navigate to the top of the page.", "optional": false, "type": { "names": [ "string" ] } } ], "ojexports": true }, { "id": "oj-c.TabBar.KeyDetail", "name": "KeyDetail", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.KeyDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Payload for onOjBeforeSelect and onOjRemove events.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "key", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "key" } ] }, { "name": "accept", "tstype": [ { "target": "Type", "value": "(acceptPromise:Promise) => void", "for": "accept", "jsdocOverride": true } ], "description": "This method can be called with an application-created Promise to cancel this event asynchronously. The Promise should be resolved or rejected to accept or cancel the event, respectively.", "type": { "names": [ "function" ] } } ] }, { "id": "oj-c.TabBar.ReorderDetail", "name": "ReorderDetail", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.ReorderDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Payload for onOjReorder event.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "reorderedKeys", "description": "The new order of keys after reorder", "optional": false, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "reorderedKeys" } ] } ] }, { "id": "oj-c.TabBar.SelectionActionDetail", "name": "SelectionActionDetail", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.SelectionActionDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Payload for onOjSelectionAction event.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "previousValue", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "previousValue" } ] }, { "name": "value", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "value" } ] } ] }, { "id": "oj-c.TabBar.CTabBarItemContextMenuContext", "name": "CTabBarItemContextMenuContext", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.CTabBarItemContextMenuContext", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "itemKey", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "itemKey" } ] }, { "name": "hasDefaultMenuItems", "optional": false, "type": { "names": [ "boolean" ] } } ] }, { "id": "oj-c.TabBar.MenuItem", "name": "MenuItem", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.MenuItem", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Specifies a standard menu item.", "properties": [ { "name": "type", "description": "Specifies a standard menu item.", "optional": true, "type": { "names": [ "\"item\"" ] }, "ojshortdesc": "Specifies a standard menu item." }, { "name": "label", "description": "The menu item label.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The menu item label." }, { "name": "key", "description": "A unique key associated with the menu item.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the menu item." }, { "name": "disabled", "description": "Specifies if the menu item is disabled (enabled by default).", "optional": true, "type": { "names": [ "boolean" ] }, "ojshortdesc": "Specifies if the menu item is disabled (enabled by default)." }, { "name": "onAction", "description": "Optional callback function associated with the menu item.", "optional": true, "type": { "names": [ "function" ] }, "ojshortdesc": "Optional callback function associated with the menu item." }, { "name": "startIcon", "description": "Optional icon to render at the start of the menu item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "startIcon" } ], "ojshortdesc": "Optional icon to render at the start of the menu item." }, { "name": "endIcon", "description": "Optional icon to render at the end of the menu item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "endIcon" } ], "ojshortdesc": "Optional icon to render at the end of the menu item." }, { "name": "variant", "description": "Specifies the menu item behavior.", "optional": true, "type": { "names": [ "\"standard\"", "\"destructive\"" ] }, "ojshortdesc": "Specifies the menu item behavior." } ] }, { "id": "oj-c.TabBar.ContextMenuSeparator", "name": "ContextMenuSeparator", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.ContextMenuSeparator", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "optional": false, "type": { "names": [ "\"separator\"" ] } } ] }, { "id": "oj-c.TabBar.MenuSelectItem", "name": "MenuSelectItem", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.MenuSelectItem", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Specifies a selectable item in a menu item.", "properties": [ { "name": "label", "description": "The selectable item label.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The selectable item label." }, { "name": "disabled", "description": "Specifies if the selectable item is disabled (enabled by default).", "optional": true, "type": { "names": [ "boolean" ] }, "ojshortdesc": "Specifies if the selectable item is disabled (enabled by default)." }, { "name": "startIcon", "description": "Optional icon to render at the start of the selectable item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "startIcon" } ], "ojshortdesc": "Optional icon to render at the start of the selectable item." }, { "name": "endIcon", "description": "Optional icon to render at the end of the selectable item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "endIcon" } ], "ojshortdesc": "Optional icon to render at the end of the selectable item." }, { "name": "value", "description": "The value associated with the selectable item.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The value associated with the selectable item." } ] }, { "id": "oj-c.TabBar.MenuSelection", "name": "MenuSelection", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.MenuSelection", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "at", "optional": false, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(index: number) => string | undefined", "jsdocOverride": true, "for": "at" } ] } ] }, { "id": "oj-c.TabBar.SelectMenuItemDetail", "name": "SelectMenuItemDetail", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.SelectMenuItemDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "value", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "T", "jsdocOverride": true, "for": "value" } ] }, { "name": "menuSelectionGroupKey", "optional": false, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.TabBar.ContextMenuSelectSingle", "name": "ContextMenuSelectSingle", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.ContextMenuSelectSingle", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "description": "Specifies a select single menu item.", "optional": false, "type": { "names": [ "\"selectsingle\"" ] }, "ojshortdesc": "Specifies a select single menu item." }, { "name": "key", "description": "A unique key associated with the select single.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the select single." }, { "name": "items", "description": "Specifies the array of select items that make up the select single.", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "items" } ] }, { "name": "selection", "optional": true, "type": { "names": [ "string" ] } }, { "name": "onSelection", "optional": true, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(detail: oj-c.TabBar.SelectMenuItemDetail) => void", "jsdocOverride": true, "for": "onSelection" } ] } ] }, { "id": "oj-c.TabBar.ContextMenuSelectMultiple", "name": "ContextMenuSelectMultiple", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.ContextMenuSelectMultiple", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "description": "Specifies a select multiple menu item.", "optional": false, "type": { "names": [ "\"selectmultiple\"" ] }, "ojshortdesc": "Specifies a select multiple menu item." }, { "name": "key", "description": "A unique key associated with the select multiple.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the select multiple." }, { "name": "items", "description": "Specifies the array of select items that make up the select multiple.", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "items" } ] }, { "name": "selection", "optional": true, "type": { "names": [ "Array" ] } }, { "name": "onSelection", "optional": true, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(detail: oj-c.TabBar.SelectMenuItemDetail) => void", "jsdocOverride": true, "for": "onSelection" } ] } ] }, { "id": "oj-c.TabBar.ContextMenuSubMenu", "name": "ContextMenuSubMenu", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.ContextMenuSubMenu", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "description": "Specifies a submenu menu item.", "optional": false, "type": { "names": [ "\"submenu\"" ] }, "ojshortdesc": "Specifies a submenu menu item." }, { "name": "key", "description": "A unique key associated with the submenu menu item.", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the submenu menu item." }, { "name": "label", "description": "The submenu label.", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "The submenu label." }, { "name": "disabled", "description": "Specifies if the submenu is disabled (enabled by default).", "optional": true, "type": { "names": [ "boolean" ] }, "ojshortdesc": "Specifies if the submenu is disabled (enabled by default)." }, { "name": "startIcon", "description": "Optional icon to render at the start of the submenu.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "startIcon" } ], "ojshortdesc": "Optional icon to render at the start of the submenu." }, { "name": "items", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "items" } ] } ] }, { "id": "oj-c.TabBar.CTabBarContextMenuConfig", "name": "CTabBarContextMenuConfig", "kind": "typedef", "memberof": "oj-c.TabBar", "meta": { "filename": "tab-bar.tsx", "path": "web/components/oj-c/tab-bar" }, "longname": "oj-c.TabBar.CTabBarContextMenuConfig", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "items", "optional": false, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(context: oj-c.TabBar.CTabBarItemContextMenuContext) => (\"remove\" | ContextMenuItems | \"defaultMenuItems\" | \"reorder\")[]", "jsdocOverride": true, "for": "items" } ] }, { "name": "accessibleLabel", "optional": true, "type": { "names": [ "string" ] } } ] } ]