Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Input<SS>

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

context

context: IInputContext

elementRef

elementRef: RefObject<HTMLInputElement & HTMLTextAreaElement> = React.createRef<HTMLInputElement & HTMLTextAreaElement>()

Readonly props

props: Readonly<IInputProps> & Readonly<{ children?: ReactNode }>

refs

refs: {}

Type declaration

  • [key: string]: ReactInstance

Static contextType

contextType: Context<IInputContext> = InputContext

Static displayName

displayName: string = "ZentInput"

Accessors

input

  • get input(): HTMLInputElement & HTMLTextAreaElement

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IInputProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IInputProps>, nextState: Readonly<IInputState>, nextContext: any): void

clearInput

  • clearInput(evt: MouseEvent<HTMLElement, MouseEvent>): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

Optional componentDidUpdate

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IInputProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IInputProps>, nextState: Readonly<IInputState>, nextContext: any): void

focus

  • focus(): void

forceUpdate

  • forceUpdate(callback?: () => void): void
  • Parameters

    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

onBlur

  • onBlur(evt: FocusEvent<HTMLInputElement & HTMLTextAreaElement>): void

onFocus

  • onFocus(evt: FocusEvent<HTMLInputElement & HTMLTextAreaElement>): void

onKeyDown

  • onKeyDown(e: KeyboardEvent<HTMLInputElement> | KeyboardEvent<HTMLTextAreaElement>): void

render

  • render(): Element

renderImpl

renderInput

select

  • select(selectionStart?: number, selectionEnd?: number): void

setState

  • setState<K>(state: ((prevState: Readonly<IInputState>, props: Readonly<IInputProps>) => S | {}) | (S | {}), callback?: () => void): void
  • Type parameters

    Parameters

    • state: ((prevState: Readonly<IInputState>, props: Readonly<IInputProps>) => S | {}) | (S | {})
    • Optional callback: () => void
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IInputProps>, nextState: Readonly<IInputState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

Object literals

state

state: object

hasFocus

hasFocus: boolean = false

Static defaultProps

defaultProps: object

size

size: string = "normal"

type

type: string = "text"

Generated using TypeDoc