Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InputBoxProperties

Hierarchy

Index

Properties

Optional CSSStyles

CSSStyles: CssStyles

Matches the CSS style key and its available values.

Optional ariaHidden

ariaHidden: boolean

Corresponds to the aria-hidden accessibility attribute for this component

Optional ariaLabel

ariaLabel: string

Corresponds to the aria-label accessibility attribute for this component

Optional ariaLive

ariaLive: string

Optional ariaRole

ariaRole: string

Corresponds to the role accessibility attribute for this component

Optional ariaSelected

ariaSelected: boolean

Corresponds to the aria-selected accessibility attribute for this component

Optional columns

columns: number

Optional display

display: DisplayType

Corresponds to the display CSS property for the element

Optional enabled

enabled: boolean

Whether the component is enabled in the DOM

Optional height

height: string | number

Optional inputType

Optional max

max: number

The maximum value allowed for the input. Only valid for number inputs.

Optional min

min: number

The minimum value allowed for the input. Only valid for number inputs.

Optional multiline

multiline: boolean

Optional placeHolder

placeHolder: string

Optional position

position: PositionType

The position CSS property. Empty by default. This is particularly useful if laying out components inside a FlexContainer and the size of the component is meant to be a fixed size. In this case the position must be set to 'absolute', with the parent FlexContainer having 'relative' position. Without this the component will fail to correctly size itself

Optional readOnly

readOnly: boolean

Whether the input box is marked with the 'readonly' attribute

Optional required

required: boolean

Optional rows

rows: number

Optional stopEnterPropagation

stopEnterPropagation: boolean

Whether to stop key event propagation when enter is pressed in the input box. Leaving this as false means the event will propagate up to any parents that have handlers (such as validate on Dialogs)

Optional title

title: string

This title will show when hovered over

Optional validationErrorMessage

validationErrorMessage: string

The error message to show when custom validation fails. Note that built-in validations (such as min/max values) will use the default error messages for those validations as appropriate.

Optional value

value: string

Optional width

width: string | number

Generated using TypeDoc