@atlaskit/input v8.0.9

Input

YOU SHOULD ALMOST DEFINITELY NOT BE USING THIS COMPONENT DIRECTLY. THE COMPONENT IS DEPRECATED AND NOT MAINTAINED ANYMORE

USE @atlaskit/textfield INSTEAD

SingleLineTextInput

A text input component with extremely basic styling that supports read/edit modes.

Designed for use within other components, e.g. for the read/edit views required by ak-inline-edit, or within table cells.

Note: In addition the props described below, all other props passed to this component will be forwarded to the underlying HTML 'input'. This allows change handlers, placeholders, etc, to be attached to it.

Kind: global variable

• Properties

• SingleLineTextInput

  • .value : string
  • .style : object
  • .isInitiallySelected : boolean
  • .isEditing : boolean
  • .onConfirm : function
  • .onKeyDown : function

SingleLineTextInput.value : string

The value of the input field.

Kind: static property of SingleLineTextInput

SingleLineTextInput.style : object

Custom styles that will be applied to the read and edit views.

Typical use would be to specify a custom font size.

Kind: static property of SingleLineTextInput

SingleLineTextInput.isInitiallySelected : boolean

Whether the input text will initially be selected/highlighted.

Kind: static property of SingleLineTextInput Default: false

SingleLineTextInput.isEditing : boolean

Whether the component is in edit mode or read mode.

Kind: static property of SingleLineTextInput

SingleLineTextInput.onConfirm : function

Called when the user confirms input by pressing the enter key

Kind: static property of SingleLineTextInput

SingleLineTextInput.onKeyDown : function

Regular onKeyDown handler passed to the input

Kind: static property of SingleLineTextInput