Skip to main content

InputTableSuggest

<ui5-input-table-suggest>
info

The following entity is available under an experimental flag and its API and behavior are subject to change.

The ui5-input-table-suggest component is an input field with tabular suggestion support. It displays suggestions in a table format with multiple columns, allowing users to see more information about each suggestion before selecting it.

This component supports:

  • Multiple columns via the headerRow slot
  • Tabular rows via the default (rows) slot
  • Automatic popin mode for responsive behavior

Usage

Use this component when:

  • Users need to see additional information in columns for each suggestion
  • A simple text-based suggestion list is not sufficient
  • You want to display data in a tabular format

Difference from ui5-input

This component uses its own tabular suggestion mechanism instead of the standard showSuggestions / suggestionItems from ui5-input. The tabular suggestions are defined via:

  • headerRow: Table header cells defining the columns
  • rows (default slot): Table rows with cells containing the suggestion data

Note: Autocomplete (typeahead) is base on the first column of suggestion rows only.

ES6 Module Import

import "@ui5/webcomponents/dist/InputTableSuggest.js";

Basic Sample

Properties

accessibleDescription

DescriptionDefines the accessible description of the component.
Typestring | undefined
Defaultundefined
Since2.9.0

accessibleDescriptionRef

DescriptionReceives ID (or many IDs) of the elements that describe the input.
Typestring | undefined
Defaultundefined
Since2.9.0

accessibleName

DescriptionDefines the accessible ARIA name of the component.
Typestring | undefined
Defaultundefined
Since1.0.0-rc.15

accessibleNameRef

DescriptionReceives ID (or many IDs) of the elements that label the input.
Typestring | undefined
Defaultundefined
Since1.0.0-rc.15

disabled

DescriptionDefines whether the component is in disabled state.
Note: A disabled component is completely noninteractive.
Typeboolean
Defaultfalse

maxlength

DescriptionSets the maximum number of characters available in the input field.
Note: This property is not compatible with the ui5-input type InputType.Number. If the ui5-input type is set to Number, the maxlength value is ignored.
Typenumber | undefined
Defaultundefined
Since1.0.0-rc.5

name

DescriptionDetermines the name by which the component will be identified upon submission in an HTML form.
Note: This property is only applicable within the context of an HTML Form element.
Typestring | undefined
Defaultundefined

noTypeahead

DescriptionDefines whether the typeahead feature is disabled.
Typeboolean
Defaultfalse

placeholder

DescriptionDefines a short hint intended to help the user with data entry when the component has no value.
Typestring | undefined
Defaultundefined

readonly

DescriptionDefines whether the component is read-only.
Note: A read-only component is not editable, but still provides visual feedback upon user interaction.
Typeboolean
Defaultfalse

required

DescriptionDefines whether the component is required.
Typeboolean
Defaultfalse
Since1.0.0-rc.3

showClearIcon

DescriptionDefines whether the clear icon of the input will be shown.
Typeboolean
Defaultfalse
Since1.2.0

showSuggestions

DescriptionDefines whether suggestions should be shown.
Typeboolean
Defaultfalse

type

DescriptionDefines the HTML type of the component.
Note:
- The particular effect of this property differs depending on the browser and the current language settings, especially for type Number.
- The property is mainly intended for touch devices that use different soft keyboard layouts depending on the given input type.
Type"Email" | "Number" | "Password" | "Search" | "Tel" | "Text" | "URL" (value descriptions in: InputType)
Default"Text"

value

DescriptionDefines the value of the component.
Note: The property is updated upon typing.
Typestring
Default""

valueState

DescriptionDefines the value state of the component.
Type"Critical" | "Information" | "Negative" | "None" | "Positive"
Default"None"

Slots

default

DescriptionDefines the rows for the tabular suggestions. Use the ui5-table-row component with ui5-table-cell children to define each suggestion row.
Note: The cells in each row should correspond to the columns defined in the headerRow.
TypeArray<ITableSuggestionRow>

headerRow

DescriptionDefines the columns for the tabular suggestions. Use a single ui5-table-header-row component with ui5-table-header-cell children to define the columns.
Note: This is a single-element slot. Provide exactly one ui5-table-header-row.
TypeArray<TableHeaderRow>

icon

DescriptionDefines the icon to be displayed in the component.
TypeArray<IIcon>

valueStateMessage

DescriptionDefines the value state message that will be displayed as pop up under the component. The value state message slot should contain only one root element.
Note: If not specified, a default text (in the respective language) will be displayed.
Note: The valueStateMessage would be displayed, when the component is in Information, Critical or Negative value state.
TypeArray<HTMLElement>
Since1.0.0-rc.6

Events

change

DescriptionFired when the input operation has finished, either by pressing Enter or on focusout.
TypeCustomEvent
BubblesYes
CancelableNo

input

DescriptionFired when the value of the component changes with each keystroke.
TypeCustomEvent
BubblesYes
CancelableYes - via preventDefault()

select

DescriptionFired when some text has been selected.
TypeCustomEvent
Since2.0.0
BubblesYes
CancelableNo

Methods

No methods available for this component.

CSS Parts

No CSS parts available for this component.

CSS Custom States

No CSS custom states available for this component.

More Samples

Custom Filtering

This sample demonstrates how to implement custom filtering logic for tabular suggestions. The application filters employees by name, department, or location as the user types. With more columns than the fixed-width input can fit, the lower-importance columns move into the popin area.

Rich Cells

This sample shows suggestion rows built from rich UI5 components (avatar, title, text, label, tag) while keeping the first column as plain text. The application highlights the matched substring in the plain-text column and filters rows by name as the user types.

Value State

The component supports different value states to indicate validation status.