Input SAP SE Allows the user to enter and edit text or numeric values in one line. <h3>Overview</h3> You can enable the autocomplete suggestion feature and the value help option to easily enter a valid value. <h3>Guidelines</h3> <ul> <li> Always provide a meaningful label for any input field </li> <li> Limit the length of the input field. This will visually emphasize the constraints for the field. </li> <li> Do not use the <code>placeholder</code> property as a label.</li> <li> Use the <code>description</code> property only for small fields with no placeholders (i.e. for currencies).</li> </ul> <h3>Structure</h3> The controls inherits from {@link sap.m.InputBase} which controls the core properties like: <ul> <li> editable / read-only </li> <li> enabled / disabled</li> <li> placeholder</li> <li> text direction</li> <li> value states</li> </ul> To aid the user during input, you can enable value help (<code>showValueHelp</code>) or autocomplete (<code>showSuggestion</code>). <strong>Value help</strong> will open a new dialog where you can refine your input. <strong>Autocomplete</strong> has three types of suggestions: <ul> <li> Single value - a list of suggestions of type <code>sap.ui.core.Item</code> or <code>sap.ui.core.ListItem</code> </li> <li> Two values - a list of two suggestions (ID and description) of type <code>sap.ui.core.Item</code> or <code>sap.ui.core.ListItem</code> </li> <li> Tabular suggestions of type <code>sap.m.ColumnListItem</code> </li> </ul> The suggestions are stored in two aggregations <code>suggestionItems</code> (for single and double values) and <code>suggestionRows</code> (for tabular values). <h3>Usage</h3> <b>When to use:</b> Use the control for short inputs like emails, phones, passwords, fields for assisted value selection. <b>When not to use:</b> Don't use the control for long texts, dates, designated search fields, fields for multiple selection. <h3>Known Limitations</h3> If <code>showValueHelp</code> or if <code>showSuggestion</code> is <code>true</code>, the native browser autofill will not fire a change event. sap.m/InputBase HTML type of the internal <code>input</code> tag (e.g. Text, Number, Email, Phone). The particular effect of this property differs depending on the browser and the current language settings, especially for the type Number.<br> This parameter is intended to be used with touch devices that use different soft keyboard layouts depending on the given input type.<br> Only the default value <code>sap.m.InputType.Text</code> may be used in combination with data model formats. <code>sap.ui.model</code> defines extended formats that are mostly incompatible with normal HTML representations for numbers and dates. Maximum number of characters. Value '0' means the feature is switched off. This parameter is not compatible with the input type <code>sap.m.InputType.Number</code>. If the input type is set to <code>Number</code>, the <code>maxLength</code> value is ignored. Only used if type=date and no datepicker is available. The data is displayed and the user input is parsed according to this format. <b>Note:</b> The value property is always of the form RFC 3339 (YYYY-MM-dd). <code>sap.m.DatePicker</code>, <code>sap.m.TimePicker</code> or <code>sap.m.DateTimePicker</code> should be used for date/time inputs and formating. If set to true, a value help indicator will be displayed inside the control. When clicked the event "valueHelpRequest" will be fired. If this is set to true, suggest event is fired when user types in the input. Changing the suggestItems aggregation in suggest event listener will show suggestions within a popup. When runs on phone, input will first open a dialog where the input and suggestions are shown. When runs on a tablet, the suggestions are shown in a popup next to the input. If set to true, direct text input is disabled and the control will trigger the event "valueHelpRequest" for all user interactions. The properties "showValueHelp", "editable", and "enabled" must be set to true, otherwise the property will have no effect Defines whether to filter the provided suggestions before showing them to the user. If set, the value of this parameter will control the horizontal size of the suggestion list to display more data. This allows suggestion lists to be wider than the input field if there is enough space available. By default, the suggestion list is always as wide as the input field. <b>Note:</b> The value will be ignored if the actual width of the input field is larger than the specified parameter value. Minimum length of the entered text in input before suggest event is fired. The default value is 1 which means the suggest event is fired after user types in input. <b>Note:</b> When it's set to 0, suggest event is fired when input with no text gets focus. In this case no suggestion popup will open. For tabular suggestions, this flag will show/hide the button at the end of the suggestion table that triggers the event "valueHelpRequest" when pressed. The default value is true. <b>Note:</b> If suggestions are not tabular or no suggestions are used, the button will not be displayed and this flag is without effect. The description is a text after the input field, e.g. units of measurement, currencies. This property only takes effect if the description property is set. It controls the distribution of space between the input field and the description text. The default value is 50% leaving the other 50% for the description. Indicates when the value gets updated with the user changes: At each keystroke (true) or first when the user presses enter or tabs out (false). Defines the key of the selected item. <b>Note:</b> If duplicate keys exist, the first item matching the key is used. Defines the display text format mode. Defines the display text formatter function. Defines the validation callback function called when a suggestion row gets selected. Specifies whether the suggestions highlighting is enabled. Specifies whether autocomplete is enabled. Works only if "showSuggestion" property is set to true. Fired when the value of the input is changed by user interaction - each keystroke, delete, paste, etc. <b>Note:</b> Browsing autocomplete suggestions does not fires the event. The new value of the input. Indicate that ESC key triggered the event. The value of the input before pressing ESC key. When the value help indicator is clicked, this event will be fired. The event parameter is set to true, when the button at the end of the suggestion table is clicked, otherwise false. It can be used to determine whether the "value help" trigger or the "show all items" trigger has been pressed. This event is fired when user types in the input and showSuggestion is set to true. Changing the suggestItems aggregation will show the suggestions within a popup. The current value which has been typed in the input. The suggestion list is passed to this event for convenience. If you use list-based or tabular suggestions, fill the suggestionList with the items you want to suggest. Otherwise, directly add the suggestions to the "suggestionItems" aggregation of the input control. This event is fired when suggestionItem shown in suggestion popup are selected. This event is only fired when showSuggestion is set to true and there are suggestionItems shown in the suggestion popup. This is the item selected in the suggestion popup for one and two-value suggestions. For tabular suggestions, this value will not be set. This is the row selected in the tabular suggestion popup represented as a ColumnListItem. For one and two-value suggestions, this value will not be set. <b>Note:</b> The row result function to select a result value for the string is already executed at this time. To pick different value for the input field or to do follow up steps after the item has been selected. This event is fired when user presses the <code>Enter</code> key on the input. <b>Notes:</b> <ul> <li>The event is fired independent of whether there was a change before or not. If a change was performed, the event is fired after the change event.</li> <li>The event is also fired when an item of the select list is selected via <code>Enter</code>.</li> <li>The event is only fired on an input which allows text input (<code>editable</code>, <code>enabled</code> and not <code>valueHelpOnly</code>).</li> </ul> The new value of the input. Defines the items displayed in the suggestion popup. Changing this aggregation (by calling <code>addSuggestionItem</code>, <code>insertSuggestionItem</code>, <code>removeSuggestionItem</code>, <code>removeAllSuggestionItems</code>, or <code>destroySuggestionItems</code>) after <code>Input</code> is rendered opens/closes the suggestion popup. To display suggestions with two text values, add <code>sap.ui.core.ListItem</code> as <code>SuggestionItems</code> (since 1.21.1). For the selected <code>ListItem</code>, only the first value is returned to the input field. <b>Note:</b> Only <code>text</code> and <code>additionalText</code> property values of the item are displayed. For example, if an <code>icon</code> is set, it is ignored. To display more information per item (including icons), you can use the <code>suggestionRows</code> aggregation. The suggestionColumns and suggestionRows are for tabular input suggestions. This aggregation allows for binding the table columns; for more details see the aggregation "suggestionRows". The suggestionColumns and suggestionRows are for tabular input suggestions. This aggregation allows for binding the table cells. The items of this aggregation are to be bound directly or to set in the suggest event method. <b>Note:</b> If this aggregation is filled, the aggregation suggestionItems will be ignored. The suggestion popup (can be a Dialog or Popover); aggregation needed to also propagate the model and bindings to the content of the popover The icon on the right side of the Input Sets or retrieves the selected item from the suggestionItems. Sets or retrieves the selected row from the suggestionRows. Sets a custom filter function for suggestions. The default is to check whether the first item text begins with the typed value. For one and two-value suggestions this callback function will operate on sap.ui.core.Item types, for tabular suggestions the function will operate on sap.m.ColumnListItem types. The filter function is called when displaying suggestion items and has two input parameters: the first one is the string that is currently typed in the input field and the second one is the item that is being filtered. Returning true will add this item to the popup, returning false will not display it. Sets a custom result filter function for tabular suggestions to select the text that is passed to the input field. Default is to check whether the first cell with a "text" property begins with the typed value. For one value and two-value suggestions this callback function is not called. The result function is called with one parameter: the sap.m.ColumnListItem that is selected. The function must return a result string that will be displayed as the input field's value.