Skip to content

Search field: Added aria-label and name to search input for accessibility (closes #21938) #21962

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

Merged
leekelleher merged 4 commits into from
Mar 3, 2026
Merged

Search field: Added aria-label and name to search input for accessibility (closes #21938) #21962

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5814bdb
Add aria-label and name to search input for accessibility
andreaslborg Feb 27, 2026
ad7e6c0
Merge branch 'main' into v17/bugfix/21938-search-wcag-accessibility
emmagarland Mar 3, 2026
cd743ca
Reused localized label
leekelleher Mar 3, 2026
8ec0e72
Tidy-up/linting
leekelleher Mar 3, 2026
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
45 changes: 27 additions & 18 deletions src/Umbraco.Web.UI.Client/src/packages/core/search/search-modal/search-modal.element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
import type { UmbSearchProvider, UmbSearchResultItemModel } from '../types.js';
import { UMB_BACKOFFICE_CONTEXT } from '../../../../apps/backoffice/backoffice.context.js';
import type { ManifestSearchResultItem } from '../extensions/types.js';
import type { UmbGlobalSearchApi } from '../global-search/types.js';
import type { UmbSearchProvider, UmbSearchResultItemModel } from '../types.js';
import {
css,
customElement,
html,
nothing,
repeat,
customElement,
property,
query,
repeat,
state,
property,
when,
} from '@umbraco-cms/backoffice/external/lit';
import { UmbExtensionsManifestInitializer, createExtensionApi } from '@umbraco-cms/backoffice/extension-api';
import { createExtensionApiByAlias, umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registry';
import { UmbExtensionsManifestInitializer, createExtensionApi } from '@umbraco-cms/backoffice/extension-api';
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
import { UmbTextStyles } from '@umbraco-cms/backoffice/style';
import type { UmbModalContext } from '@umbraco-cms/backoffice/modal';

import '../search-result/search-result-item.element.js';
import { UMB_BACKOFFICE_CONTEXT } from '../../../../apps/backoffice/backoffice.context.js';

type GlobalSearchers = {
name: string;
Expand All @@ -31,6 +32,7 @@ type GlobalSearchers = {
export class UmbSearchModalElement extends UmbLitElement {
@query('#input-wrapper-fake-cursor')
private _inputFakeCursor!: HTMLElement;

@query('input')
private _input!: HTMLInputElement;

Expand All @@ -55,7 +57,9 @@ export class UmbSearchModalElement extends UmbLitElement {
#searchItemNavIndex = 0;

#searchRequestNumber = 0;

#inputTimer?: NodeJS.Timeout;

#inputTimerAmount = 300;

#currentSectionAlias?: string;
Expand Down Expand Up @@ -331,6 +335,7 @@ export class UmbSearchModalElement extends UmbLitElement {
}

override render() {
const inputLabel = this.localize.term('placeholders_search');
return html`
<div id="top">
<div id="search-icon">
Expand All @@ -343,9 +348,11 @@ export class UmbSearchModalElement extends UmbLitElement {
<div id="input-wrapper">
<div id="input-wrapper-fake-cursor" aria-hidden="true"></div>
<input
name="search-input"
type="text"
autocomplete="off"
placeholder=${this.localize.term('placeholders_search')}
placeholder=${inputLabel}
aria-label=${inputLabel}
value=${this._search}
@input=${this.#onSearchChange}
@blur=${() => this.#setShowFakeCursor(true)}
Expand Down Expand Up @@ -404,7 +411,7 @@ export class UmbSearchModalElement extends UmbLitElement {
<a
class="search-item"
data-item-index=${index}
href=${item.href}
href=${item.href ?? '#'}
@click=${this.#closeModal}
@keydown=${this.#closeModal}>
<umb-extension-slot
Expand All @@ -422,17 +429,19 @@ export class UmbSearchModalElement extends UmbLitElement {
}

#renderNavigationTips() {
return html`<div id="navigation-tips">
<div class="navigation-tips-key" style="grid-column: span 2;">Tab</div>
<span>${this.localize.term('globalSearch_navigateSearchProviders')}</span>
<div class="navigation-tips-key">
<uui-icon name="icon-arrow-up"></uui-icon>
</div>
<div class="navigation-tips-key">
<uui-icon name="icon-arrow-down"></uui-icon>
return html`
<div id="navigation-tips">
<div class="navigation-tips-key" style="grid-column: span 2;">Tab</div>
<span>${this.localize.term('globalSearch_navigateSearchProviders')}</span>
<div class="navigation-tips-key">
<uui-icon name="icon-arrow-up"></uui-icon>
</div>
<div class="navigation-tips-key">
<uui-icon name="icon-arrow-down"></uui-icon>
</div>
<span>${this.localize.term('globalSearch_navigateSearchResults')}</span>
</div>
<span>${this.localize.term('globalSearch_navigateSearchResults')}</span>
</div>`;
`;
}

static override styles = [
Expand Down
Loading