This page is part of archived documentation for openHAB 4.0. Go to the current stable version

# oh-input-item - Input List Item

Display an input field in a list

# Configuration

# List Item

General settings of the list item

# title Title TEXT

Title of the item

# subtitle Subtitle TEXT

Subtitle of the item

# after After TEXT

Text to display on the opposite side of the item (set either this or a badge)

# icon Icon TEXT

Use oh:iconName (openHAB icon), f7:iconName (Framework7 icon), material:iconName (Material icon) or iconify:iconSet:iconName (Iconify icon, requires being online if not in cache)

# iconColor Icon Color TEXT

Not applicable to openHAB icons

# iconUseState Icon depends on state BOOLEAN

Use the state of the Item to get a dynamic icon (enabled by default for Contact, Dimmer, Rollershutter & Switch Item types) (for openHAB icons only)

# Input

# name Name TEXT

Input name

# type Type TEXT

Type of input (see f7 input docs or datepicker)

# inputmode Input Mode TEXT

Type of data that might be entered (see MDN docs)

# placeholder Placeholder TEXT

Placeholder text

# sendButton Send button BOOLEAN

Display Send button to update the state with a command (needs a configured item)

# clearButton Clear button BOOLEAN

Display input clear button when applicable

# outline Outline BOOLEAN

Makes input outline

# required Required BOOLEAN

Display an error message if left empty

# validate Validate BOOLEAN

When enabled, input value will be validated based on input type

# validate-on-blur Validate on blur BOOLEAN

Only validate when focus moves away from input field

# item Item TEXT item

Link the input value to the state of this item

# useDisplayState Use Display State BOOLEAN

Use the formatted state as the value for the input control

# step Step DECIMAL

Step value when type set to number, any if left empty

# showTime Show time BOOLEAN

Display time when type set to datepicker

# defaultValue Default value TEXT

Default value when not found in item state or variable

# variable Variable TEXT

Name of the variable to set when the input changes

# variableKey Variable Key TEXT

Consider the variable value is an object and set the corresponding deep property within that object using a key syntax. Examples: user.name, user[0].address[1].street, [0], [0].label. The inner property and its parent hierarchy will be created if missing.