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 suggestions support. It displays suggestions in a table format with multiple columns, allowing users to see more information about each suggestion before selecting it.

Similar to the OpenUI5 sap.m.Input with tabular suggestions, this component supports:

  • Multiple columns via suggestionColumns slot
  • Tabular rows via suggestionRows 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:

  • suggestionColumns: Table header cells defining the columns
  • suggestionRows: Table rows with cells containing the suggestion data

Note: Autocomplete (typeahead) matches only the first column of suggestion rows.

Keyboard Handling

The component inherits keyboard handling from ui5-input:

  • [Down] - Navigates to the next suggestion row
  • [Up] - Navigates to the previous suggestion row
  • [Enter] - Selects the focused suggestion row
  • [Escape] - Closes the suggestion popover

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 typeahead is disabled.
Typeboolean
Defaultfalse

open

DescriptionDefines whether the suggestions picker is open.
Typeboolean
Defaultfalse

placeholder

DescriptionDefines a short hint intended to aid 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.
Notes:
- The particular effect of this property differs depending on the browser and the current language settings, especially for type Number.
- The property is mostly intended to be used with 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

icon

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

suggestionColumns

DescriptionDefines the columns for the tabular suggestions. Use ui5-table-header-cell components to define the column headers.
Note: The columns define the structure of the suggestion table header. Each column can have properties like width, minWidth, importance (for popin), and popinText.
TypeArray<TableHeaderCell>

suggestionRows

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

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 by pressing Enter or on focusout.
TypeCustomEvent
BubblesYes
CancelableNo

input

DescriptionFired when the value of the component changes at 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.

Value State

The component supports different value states to indicate validation status.