Skip to content

UI: Use custom HTML elements for the UI Tag Input #11715

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
lscharmer wants to merge 1 commit into
base: release_11
Choose a base branch
from
+54 −25
Open

UI: Use custom HTML elements for the UI Tag Input #11715

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
2 changes: 1 addition & 1 deletion components/ILIAS/UI/resources/js/Input/Field/dist/input.factory.min.js
View file
Open in desktop

Large diffs are not rendered by default.

29 changes: 23 additions & 6 deletions components/ILIAS/UI/resources/js/Input/Field/src/Tag/tag.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,31 +119,31 @@ function buildSettings(inputId, config) {
},
templates: {
wrapper(input, _s) {
return `<div class="${_s.classNames.namespace} ${_s.mode ? `${_s.classNames[`${_s.mode}Mode`]}` : ''} ${input.className}"
return `<ui-tags-input class="${_s.classNames.namespace} ${_s.mode ? `${_s.classNames[`${_s.mode}Mode`]}` : ''} ${input.className}"
${_s.readonly ? 'readonly' : ''}
${_s.disabled ? 'disabled' : ''}
${_s.required ? 'required' : ''}
${_s.mode === 'select' ? "spellcheck='false'" : ''}
tabIndex="-1">
${this.settings.templates.input.call(this)}
\u200B
</div>`;
</ui-tags-input>`;
},
tag(tagData) {
return `<div contenteditable='false'
return `<ui-tag-input contenteditable='false'
spellcheck="false" class='tagify__tag'
value="${tagData.value}"
tabindex="0">
<span title='remove tag' class='tagify__tag__removeBtn'></span>
<div>
<span class='tagify__tag-text'>${tagData.display}</span>
</div>
</div>`;
</ui-tag-input>`;
},
dropdownItem(tagData) {
return `<div class='tagify__dropdown__item' tagifySuggestionIdx="${tagData.tagifySuggestionIdx}" value="${tagData.value}">
return `<ui-tag-dropdown-item class='tagify__dropdown__item' tagifySuggestionIdx="${tagData.tagifySuggestionIdx}" value="${tagData.value}">
<span>${tagData.display}</span>
</div>`;
</ui-tag-dropdown-item>`;
},
},
};
Expand Down Expand Up @@ -198,6 +198,20 @@ function retrieveAutocomplete(
);
}

function registerTags(customElements, HTMLElement)
{
if (customElements.get('ui-tags-input')) {
return;
}
class UITagsInput extends HTMLElement {}
class UITagInput extends HTMLElement {}
class UITagDropdown extends HTMLElement {}

customElements.define('ui-tags-input', UITagsInput);
customElements.define('ui-tag-input', UITagInput);
customElements.define('ui-tag-dropdown-item', UITagDropdown);
}

/**
* @param {Tagify} Tagify
* @param {HTMLElement} input
Expand All @@ -208,12 +222,15 @@ function retrieveAutocomplete(
*/
export default function init(
Tagify,
customElements,
HTMLElement,
input,
config,
value,
autocompleteEndpoint,
autocompleteToken,
) {
registerTags(customElements, HTMLElement);
const instance = new Tagify(
input,
buildSettings(input.id, config),
Expand Down
2 changes: 1 addition & 1 deletion components/ILIAS/UI/resources/js/Input/Field/src/input.factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ il.UI.Input = il.UI.Input || {};
);
Input.tagInput = Input.tag || {};
Input.tagInput.init = (input, config, value, autocompleteEndpoint, autocompleteToken) => tag(
Tagify, input, config, value, autocompleteEndpoint, autocompleteToken);
Tagify, window.customElements, window.HTMLElement, input, config, value, autocompleteEndpoint, autocompleteToken);
}(il.UI.Input));
35 changes: 19 additions & 16 deletions components/ILIAS/UI/tests/Client/Input/Field/Tag.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,11 @@ describe('Tag Input Field', () => {
};
const urlBuilderTokenMock = {};

const customElementsMock = {get: () => false, define: () => {}};
const HTMLElementMock = function(){};

it('should call the provided async endpoint.', () => {
init(tagifyMock, inputMock, pseudoConfig, [], urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, [], urlBuilderMock, urlBuilderTokenMock);

assert.strict.equal(tagifyInstanceMock.on.mock.callCount(), 1);
assert.strict.equal(tagifyInstanceMock.on.mock.calls[0].arguments[0], 'input');
Expand Down Expand Up @@ -131,7 +134,7 @@ describe('Tag Input Field', () => {
});

it('should build correct settings.', () => {
init(tagifyMock, inputMock, pseudoConfig, [], urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, [], urlBuilderMock, urlBuilderTokenMock);

assert.strict.equal(tagifyInstanceMock.settings.whitelist, pseudoConfig.options);
assert.strict.equal(tagifyInstanceMock.settings.enforceWhitelist, !pseudoConfig.userInput);
Expand All @@ -148,7 +151,7 @@ describe('Tag Input Field', () => {
it('should apply label relation to editable input.', () => {
mock.reset();
labelMock.id = '';
init(tagifyMock, inputMock, pseudoConfig, [], urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, [], urlBuilderMock, urlBuilderTokenMock);

assert.ok(editableInputMock.setAttribute.mock.callCount() > 0);
const latestCall = editableInputMock.setAttribute.mock.calls[
Expand All @@ -174,7 +177,7 @@ describe('Tag Input Field', () => {
{value: '<sieben, acht>'},
{value: '<test>'},
];
init(tagifyMock, inputMock, pseudoConfig, userInput, urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, userInput, urlBuilderMock, urlBuilderTokenMock);

userInput.forEach((v) => {
const display = v.value;
Expand All @@ -185,9 +188,9 @@ describe('Tag Input Field', () => {
mock.reset();
});

it('should wrapp in div with attributes.', () => {
it('should wrap in ui-tags-input with attributes.', () => {
const tagData = {value: 'test', display: 'test', tagifySuggestionIdx: 'test'};
init(tagifyMock, inputMock, pseudoConfig, tagData, urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, tagData, urlBuilderMock, urlBuilderTokenMock);

const input = {className: 'test'};

Expand All @@ -197,8 +200,8 @@ describe('Tag Input Field', () => {
];

const result = [
`<div class="all_false test" tabIndex="-1">\u200B</div>`.replace(/ /g, ''),
`<div class="all_true strict_mode test" readonly disabled required tabIndex="-1">\u200B</div>`.replace(/ /g, ''),
`<ui-tags-input class="all_false test" tabIndex="-1">\u200B</ui-tags-input>`.replace(/ /g, ''),
`<ui-tags-input class="all_true strict_mode test" readonly disabled required tabIndex="-1">\u200B</ui-tags-input>`.replace(/ /g, ''),
];

config.forEach(
Expand All @@ -223,35 +226,35 @@ describe('Tag Input Field', () => {
mock.reset();
});

it('should build correct tags as divs.', () => {
it('should build correct tags as ui-tag-input.', () => {
const tagData = {value: 'test', display: 'test', tagifySuggestionIdx: 'test'};
init(tagifyMock, inputMock, pseudoConfig, tagData, urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, tagData, urlBuilderMock, urlBuilderTokenMock);

assert.strict.equal(
tagifyInstanceMock.settings.templates.tag(tagData),
`<div contenteditable='false'
`<ui-tag-input contenteditable='false'
spellcheck="false" class='tagify__tag'
value="${tagData.value}"
tabindex="0">
<span title='remove tag' class='tagify__tag__removeBtn'></span>
<div>
<span class='tagify__tag-text'>${tagData.display}</span>
</div>
</div>`
</ui-tag-input>`
);

mock.reset();
});

it('should build correct dropdowns as divs.', () => {
it('should build correct dropdowns as ui-tag-dropdown-item.', () => {
const tagData = {value: 'test', display: 'test', tagifySuggestionIdx: 'test'};
init(tagifyMock, inputMock, pseudoConfig, tagData, urlBuilderMock, urlBuilderTokenMock);
init(tagifyMock, customElementsMock, HTMLElementMock, inputMock, pseudoConfig, tagData, urlBuilderMock, urlBuilderTokenMock);

assert.strict.equal(
tagifyInstanceMock.settings.templates.dropdownItem(tagData),
`<div class='tagify__dropdown__item' tagifySuggestionIdx="${tagData.tagifySuggestionIdx}" value="${tagData.value}">
`<ui-tag-dropdown-item class='tagify__dropdown__item' tagifySuggestionIdx="${tagData.tagifySuggestionIdx}" value="${tagData.value}">
<span>${tagData.display}</span>
</div>`
</ui-tag-dropdown-item>`
);

mock.reset();
Expand Down
7 changes: 6 additions & 1 deletion templates/default/070-components/UI-framework/Input/_ui-component_tag.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,9 @@ $il-input-tag-color-disabled: #EEEEEE;
--tag-remove-btn-bg--hover: #{$il-input-tag-color-bg};
--tag-hide-transition: .0s;
line-height: $il-line-height-base;
}
}

ui-tag-dropdown-item
{
display: block;
}
4 changes: 4 additions & 0 deletions templates/default/delos.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8252,6 +8252,10 @@ button .minimize, button .close {
line-height: 1.428571429;
}

ui-tag-dropdown-item {
display: block;
}

.c-field-password__revelation-glyph {
float: right;
margin-top: -26px;
Expand Down
Loading