Interface UiInputProps

Hierarchy

  • Omit<PBUiInput, "font" | "textAlign" | "fontSize">
    • UiInputProps

Properties

clearOnSubmit? color? disabled font? fontSize? multiLine? placeholder placeholderColor? textAlign? value?

Methods

onChange? onSubmit?

Properties

Optional clearOnSubmit

clearOnSubmit?: boolean

default=true; when false, the input value is preserved after pressing Enter

Optional color

color?: PBColor4

default=(0.0,0.0,0.0,1.0)

disabled

disabled: boolean

Optional font

font?: UiFontType

Optional fontSize

fontSize?: ScaleUnit

Optional multiLine

multiLine?: boolean

default=false; when true, the input accepts newlines and behaves as a textarea

placeholder

placeholder: string

Optional placeholderColor

placeholderColor?: PBColor4

default=(0.3,0.3,0.3,1.0)

Optional textAlign

textAlign?: TextAlignType

Optional value

value?: string

Methods

Optional onChange

  • function to be called on value change

    Parameters

    • value: string

    Returns void

Optional onSubmit

  • function to be called on text field submit

    Parameters

    • value: string

    Returns void

Settings

Member Visibility

Theme