Skip to content

feat(ui5-search) add actions to search items #12405

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat(ui5-search) add actions to search items #12405

Show file tree
Hide file tree
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
18 changes: 18 additions & 0 deletions packages/fiori/src/SearchItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,20 @@ class SearchItem extends ListItemBase {
@slot()
image!: Array<HTMLElement>;

/**
* Defines the secondary actionable elements.
* This slot allows placing additional interactive elements (such as buttons, icons, or tags)
* next to the delete button, providing flexible customization for various user actions.
*
* **Note:** While the slot is flexible, for consistency with design guidelines,
* it's recommended to use `ui5-button` with `Transparent` design or `ui5-icon` elements.
*
* @public
* @since 2.13.0
*/
@slot()
secondaryActions!: Array<HTMLElement>;

_markupText = "";

@i18n("@ui5/webcomponents-fiori")
Expand Down Expand Up @@ -180,6 +194,10 @@ class SearchItem extends ListItemBase {
get _deleteButtonTooltip() {
return SearchItem.i18nBundle.getText(SEARCH_ITEM_DELETE_BUTTON);
}

get hasSecondaryActions() {
return !!this.secondaryActions.length;
}
}

SearchItem.define();
Expand Down
24 changes: 16 additions & 8 deletions packages/fiori/src/SearchItemTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,22 @@ export default function SearchFieldTemplate(this: SearchItem) {
<span part="subtitle" class="ui5-search-item-description">{this.description}</span>
</div>

{this.deletable &&
<Button class="ui5-search-item-selected-delete"
design={ButtonDesign.Transparent}
icon={decline}
onClick={this._onDeleteButtonClick}
tooltip={this._deleteButtonTooltip}
onKeyDown={this._onDeleteButtonKeyDown}></Button>
}
<div class="ui5-search-item-actions-container">
{this.hasSecondaryActions &&
<div class="ui5-search-item-secondary-actions">
<slot name="secondaryActions"></slot>
</div>
}

{this.deletable &&
<Button class="ui5-search-item-selected-delete"
design={ButtonDesign.Transparent}
icon={decline}
onClick={this._onDeleteButtonClick}
tooltip={this._deleteButtonTooltip}
onKeyDown={this._onDeleteButtonKeyDown}></Button>
}
</div>
</div>
</div>
</li >
Expand Down
22 changes: 21 additions & 1 deletion packages/fiori/src/themes/SearchItem.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,35 @@
flex: 1;
}

.ui5-search-item-actions-container {
display: flex;
align-items: center;
gap: 0.125rem;
}

:host([desktop]) .ui5-search-item-selected-delete {
display: none;
}

:host([desktop]) .ui5-search-item-secondary-actions {
display: none;
}

:host(:hover),
:host(:focus-within) {
.ui5-search-item-selected-delete {
display: inline-block;
}

.ui5-search-item-secondary-actions {
display: flex;
}
}

.ui5-search-item-secondary-actions {
display: flex;
align-items: center;
gap: 0.25rem;
}

.ui5-search-item-text {
Expand Down Expand Up @@ -85,4 +105,4 @@
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
}
22 changes: 22 additions & 0 deletions packages/fiori/test/pages/Search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,28 @@
<ui5-search id="delete-search" show-clear-icon></ui5-search>
</div>

<div class="container">
<ui5-label>Search with Secondary Actions - Example of flexible action slot</ui5-label>
<ui5-search id="secondary-actions-search" show-clear-icon>
<ui5-search-item text="List Item with Favorite Action" icon="history" deletable>
<ui5-button slot="secondaryActions" design="Transparent" icon="favorite" tooltip="Add to favorites"></ui5-button>
</ui5-search-item>
<ui5-search-item text="List Item with Edit Action" icon="search" deletable>
<ui5-button slot="secondaryActions" design="Transparent" icon="edit" tooltip="Edit item"></ui5-button>
</ui5-search-item>
<ui5-search-item text="List Item with Multiple Actions" icon="globe" deletable>
<ui5-button slot="secondaryActions" design="Transparent" tabindex="1" icon="share" tooltip="Share"></ui5-button>
<ui5-button slot="secondaryActions" design="Transparent" tabindex="1" icon="copy" tooltip="Copy"></ui5-button>
</ui5-search-item>
<ui5-search-item text="List Item with Tag Action" icon="history">
<ui5-tag slot="secondaryActions" design="Set2" color-scheme="8">Important</ui5-tag>
</ui5-search-item>
</ui5-search>
<ui5-text style="padding-top: 0.25rem; font-style: italic;">
Hover over search items to see secondary actions. Use Tab/Shift+Tab to navigate between action buttons and delete button.
</ui5-text>
</div>

<div class="container">
<ui5-label>Search with Suggestions - Filter by typing</ui5-label>
<ui5-search id="filtering" show-clear-icon placeholder="Start typing ..."></ui5-search>
Expand Down
Loading