Skip to content

docs(ui5-toolbar-item): improve overview section in JSDoc #13165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dobrinyonkov wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −2
Open

docs(ui5-toolbar-item): improve overview section in JSDoc #13165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions packages/main/src/ToolbarItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,22 @@ interface IOverflowToolbarItem extends HTMLElement {
/**
* @class
*
* Represents an abstract class for items, used in the `ui5-toolbar`.
* ### Overview
* The `ui5-toolbar-item` is a wrapper component used to integrate UI5 Web Components into the `ui5-toolbar`.
* It renders within the toolbar's shadow DOM and manages the lifecycle
* and overflow behavior of its child component.
*
* ### Structure
* The toolbar item wraps a single UI5 Web Component (such as CheckBox, Title, etc.) and handles:
* - Overflow management (determining if the item should be displayed in the main toolbar or overflow popover)
* - Automatic popover closing on interaction
* - CSS custom state exposure for styling based on overflow state
*
* ### Usage
* The `ui5-toolbar-item` is typically used implicitly when adding components to a toolbar,
* but specialized wrappers like `ui5-toolbar-button` provide
* component-specific functionality and should be preferred when available.
*
*
* @cssState overflowed - When the item is displayed in the overflow popover. Use this state to apply different styles when the item is overflowed. Available since 2.20.0.
* @constructor
Expand Down Expand Up @@ -64,7 +79,7 @@ class ToolbarItem extends UI5Element {
overflowPriority: `${ToolbarItemOverflowBehavior}` = "Default";

/**
* Defines if the toolbar overflow popup should close upon intereaction with the item.
* Defines if the toolbar overflow popup should close upon interaction with the item.
* It will close by default.
* @default false
* @public
Expand Down
Loading