Skip to content
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

Jump to bottom

feat(ui5-tokenizer): enable multiline mode #9964

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

feat(ui5-tokenizer): enable multiline mode #9964

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
4 changes: 4 additions & 0 deletions packages/main/src/Tokenizer.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@
{{#each tokens}}
<slot name="{{this._individualSlot}}"></slot>
{{/each}}

{{#if showEffectiveClearAll}}
<span @click={{handleClearAll}} class="ui5-tokenizer--clear-all">Clear All</span>
{{/if}}
</div>

{{#if showNMore}}
Expand Down
65 changes: 51 additions & 14 deletions packages/main/src/Tokenizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import UI5Element from "@ui5/webcomponents-base/dist/UI5Element.js";
import property from "@ui5/webcomponents-base/dist/decorators/property.js";
import slot from "@ui5/webcomponents-base/dist/decorators/slot.js";
import event from "@ui5/webcomponents-base/dist/decorators/event.js";
import getEffectiveScrollbarStyle from "@ui5/webcomponents-base/dist/util/getEffectiveScrollbarStyle.js";
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
import litRender from "@ui5/webcomponents-base/dist/renderer/LitRenderer.js";
import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
Expand Down Expand Up @@ -144,6 +145,7 @@ enum ClipboardDataOperation {
ResponsivePopoverCommonCss,
SuggestionsCss,
TokenizerPopoverCss,
getEffectiveScrollbarStyle(),
],
dependencies: [
ResponsivePopover,
Expand Down Expand Up @@ -205,6 +207,12 @@ class Tokenizer extends UI5Element {
@property({ type: Boolean })
readonly = false;

@property({ type: Boolean })
multiLine = false;

@property({ type: Boolean })
showClearAll = false;

/**
* Defines whether the component is disabled.
*
Expand Down Expand Up @@ -317,7 +325,7 @@ class Tokenizer extends UI5Element {
static i18nBundle: I18nBundle;
_resizeHandler: ResizeObserverCallback;
_itemNav: ItemNavigation;
_scrollEnablement: ScrollEnablement;
_scrollEnablement: ScrollEnablement | undefined;
_expandedScrollWidth?: number;
_tokenDeleting = false;
_preventCollapse = false;
Expand All @@ -340,16 +348,23 @@ class Tokenizer extends UI5Element {
getItemsCallback: this._getVisibleTokens.bind(this),
});

this._scrollEnablement = new ScrollEnablement(this);
this._deletedDialogItems = [];
}

handleClearAll() {
this.fireEvent<TokenizerTokenDeleteEventDetail>("token-delete", { tokens: this._tokens });
}

onBeforeRendering() {
if (!this.multiLine) {
this._scrollEnablement = new ScrollEnablement(this);
}

const tokensLength = this._tokens.length;
this._tokensCount = tokensLength;

this._tokens.forEach(token => {
token.singleToken = tokensLength === 1;
token.singleToken = (tokensLength === 1) || this.multiLine;
token.readonly = this.readonly;
});
}
Expand Down Expand Up @@ -399,13 +414,19 @@ class Tokenizer extends UI5Element {
}
}

onTokenSelect() {
onTokenSelect(e: CustomEvent) {
const tokens = this._tokens;
const firstToken = tokens[0];
const targetToken = e.target as Token;

if (tokens.length === 1 && firstToken.isTruncatable) {
this.open = firstToken.selected;
}

if (this.multiLine && targetToken.isTruncatable) {
this.opener = targetToken;
this.open = targetToken.selected;
}
}

_getVisibleTokens() {
Expand All @@ -428,7 +449,9 @@ class Tokenizer extends UI5Element {
firstToken.forcedTabIndex = "0";
}

this._scrollEnablement.scrollContainer = this.contentDom;
if (this._scrollEnablement) {
this._scrollEnablement.scrollContainer = this.contentDom;
}

if (this.expanded) {
this._expandedScrollWidth = this.contentDom.scrollWidth;
Expand Down Expand Up @@ -568,9 +591,15 @@ class Tokenizer extends UI5Element {
}

handleBeforeOpen() {
this._tokens.forEach(token => {
token._isVisible = true;
});
if (this.multiLine) {
this._tokens.forEach(token => {
token._isVisible = this._selectedTokens[0] === token;
});
} else {
this._tokens.forEach(token => {
token._isVisible = true;
});
}

const list = this._getList();
const firstListItem = list.querySelectorAll("[ui5-li]")[0]! as ListItem;
Expand Down Expand Up @@ -931,6 +960,14 @@ class Tokenizer extends UI5Element {
}
}

get hasTokens() {
return this._tokens.length > 0;
}

get showEffectiveClearAll() {
return this.showClearAll && this.hasTokens;
}

_fillClipboard(shortcutName: ClipboardDataOperation, tokens: Array<IToken>) {
const tokensTexts = tokens.filter(token => token.selected).map(token => token.text).join("\r\n");

Expand All @@ -953,8 +990,8 @@ class Tokenizer extends UI5Element {
* @protected
*/
scrollToStart() {
if (this._scrollEnablement.scrollContainer) {
this._scrollEnablement.scrollTo(0, 0);
if (this._scrollEnablement?.scrollContainer) {
this._scrollEnablement?.scrollTo(0, 0);
}
}

Expand All @@ -965,8 +1002,8 @@ class Tokenizer extends UI5Element {
*/
scrollToEnd() {
const expandedTokenizerScrollWidth = this.contentDom && (this.effectiveDir !== "rtl" ? this.contentDom.scrollWidth : -this.contentDom.scrollWidth);
if (this._scrollEnablement.scrollContainer) {
this._scrollEnablement.scrollTo(expandedTokenizerScrollWidth, 0, 5, 10);
if (this._scrollEnablement?.scrollContainer) {
this._scrollEnablement?.scrollTo(expandedTokenizerScrollWidth, 0, 5, 10);
}
}

Expand All @@ -984,9 +1021,9 @@ class Tokenizer extends UI5Element {
const tokenContainerRect = this.contentDom.getBoundingClientRect();

if (tokenRect.left < tokenContainerRect.left) {
this._scrollEnablement.scrollTo(this.contentDom.scrollLeft - (tokenContainerRect.left - tokenRect.left + 5), 0);
this._scrollEnablement?.scrollTo(this.contentDom.scrollLeft - (tokenContainerRect.left - tokenRect.left + 5), 0);
} else if (tokenRect.right > tokenContainerRect.right) {
this._scrollEnablement.scrollTo(this.contentDom.scrollLeft + (tokenRect.right - tokenContainerRect.right + 5), 0);
this._scrollEnablement?.scrollTo(this.contentDom.scrollLeft + (tokenRect.right - tokenContainerRect.right + 5), 0);
}
}

Expand Down
39 changes: 39 additions & 0 deletions packages/main/src/themes/Tokenizer.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,27 @@
height: 2.25rem;
}

:host([multi-line]) {
height: auto;

.ui5-tokenizer--content {
flex-wrap: wrap;
padding: .25rem;
box-sizing: border-box;
row-gap: .5rem;
column-gap: .25rem;
overflow-y: auto;
overflow-x: hidden;
}

::slotted(ui5-token) {
margin: 0;
white-space: nowrap;
text-overflow: ellipsis;
max-width: 100%;
}
}

:host([disabled]) {
opacity: 40%;
pointer-events: none;
Expand Down Expand Up @@ -77,3 +98,21 @@
.ui5-tokenizer-more-text:active {
text-decoration: none;
}

.ui5-tokenizer--clear-all {
color: var(--sapLinkColor);
font-family: var(--sapFontFamily);
font-size: var(--sapFontSize);
cursor: pointer;
outline: none;
}

.ui5-tokenizer--clear-all:hover {
color: var(--sapLink_Hover_Color);
text-decoration: var(--_ui5_link_hover_text_decoration);
}

.ui5-tokenizer--clear-all:active {
color: var(--sapLink_Active_Color);
text-decoration: var(--_ui5_link_active_text_decoration);
}
107 changes: 107 additions & 0 deletions packages/main/test/pages/Tokenizer-multi-line.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<!DOCTYPE html>
<html>

<head>
<meta charset="utf-8">

<title>Tokenizer</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
<meta charset="utf-8">

<script data-ui5-config type="application/json">
{
"language": "EN"
}
</script>
<script src="%VITE_BUNDLE_PATH%" type="module"></script>
<link rel="stylesheet" type="text/css" href="./styles/Tokenizer.css">
</head>

<body>
<div class="wrapper">
<h1 class="sample-container-title">Multi Line</h1>
<ui5-tokenizer multi-line style="width: 320px;">
<ui5-token text="Andora"></ui5-token>
<ui5-token text="Bulgaria"></ui5-token>
<ui5-token text="Canada"></ui5-token>
<ui5-token text="Denmark"></ui5-token>
<ui5-token text="Estonia"></ui5-token>
<ui5-token text="Finland"></ui5-token>
<ui5-token text="Germany"></ui5-token>
<ui5-token text="Hungary"></ui5-token>
<ui5-token text="Ireland"></ui5-token>
<ui5-token text="Japan"></ui5-token>
<ui5-token text="Korea"></ui5-token>
<ui5-token text="Latvia"></ui5-token>
</ui5-tokenizer>

<h1 class="sample-container-title">Multi Line with long token</h1>
<ui5-tokenizer multi-line style="width: 320px;">
<ui5-token text="Andora"></ui5-token>
<ui5-token text="Bulgaria"></ui5-token>
<ui5-token text="Canada"></ui5-token>
<ui5-token text="Denmark"></ui5-token>
<ui5-token text="Mexico Mexico Mexico Mexico Mexico Mexico Mexico"></ui5-token>
<ui5-token text="Estonia"></ui5-token>
<ui5-token text="Finland"></ui5-token>
<ui5-token text="Germany"></ui5-token>
<ui5-token text="Hungary"></ui5-token>
<ui5-token text="Ireland"></ui5-token>
<ui5-token text="Japan"></ui5-token>
<ui5-token text="Korea"></ui5-token>
<ui5-token text="Latvia"></ui5-token>
<ui5-token text="Mexico Mexico Mexico Mexico Mexico Mexico Mexico"></ui5-token>
</ui5-tokenizer>

<h1 class="sample-container-title">Multi Line with long token and restricted height</h1>
<ui5-tokenizer multi-line style="height: 100px; width: 320px;">
<ui5-token text="Andora"></ui5-token>
<ui5-token text="Bulgaria"></ui5-token>
<ui5-token text="Canada"></ui5-token>
<ui5-token text="Denmark"></ui5-token>
<ui5-token text="Estonia"></ui5-token>
<ui5-token text="Finland"></ui5-token>
<ui5-token text="Germany"></ui5-token>
<ui5-token text="Hungary"></ui5-token>
<ui5-token text="Ireland"></ui5-token>
<ui5-token text="Japan"></ui5-token>
<ui5-token text="Korea"></ui5-token>
<ui5-token text="Latvia"></ui5-token>
<ui5-token text="Mexico Mexico Mexico Mexico Mexico Mexico Mexico"></ui5-token>
</ui5-tokenizer>

<h1 class="sample-container-title">Multi Line with clear all</h1>
<ui5-tokenizer id='clear-all' show-clear-all multi-line style="width: 320px;">
<ui5-token text="Andora"></ui5-token>
<ui5-token text="Bulgaria"></ui5-token>
<ui5-token text="Canada"></ui5-token>
<ui5-token text="Denmark"></ui5-token>
<ui5-token text="Estonia"></ui5-token>
<ui5-token text="Finland"></ui5-token>
<ui5-token text="Germany"></ui5-token>
<ui5-token text="Hungary"></ui5-token>
<ui5-token text="Ireland"></ui5-token>
<ui5-token text="Japan"></ui5-token>
<ui5-token text="Korea"></ui5-token>
<ui5-token text="Latvia"></ui5-token>
</ui5-tokenizer>


<h1 class="sample-container-title">Multi Line with clear all</h1>
<ui5-tokenizer show-clear-all multi-line style="width: 320px;">
<ui5-token text="Andora"></ui5-token>
<ui5-token text="Bulgaria"></ui5-token>
</ui5-tokenizer>
</div>


<script>
const clearAllTokenizer = document.getElementById('clear-all');

clearAllTokenizer.addEventListener('token-delete', (e) => {
clearAllTokenizer.innerHTML = '';
});
</script>
</body>

</html>