Hierarchy (view full)

Constructors

  • Parameters

    Returns TextInput

  • Parameters

    Returns TextInput

    Deprecated

    See

    React Docs

Properties

cancelAnimationFrame: ((handle) => void)

Type declaration

    • (handle): void
    • Parameters

      • handle: number

      Returns void

clear: (() => void)

Removes all text from the input.

Type declaration

    • (): void
    • Returns void

clearImmediate: {
    (handle): void;
    (immediateId): void;
}

Type declaration

    • (handle): void
    • Parameters

      • handle: number

      Returns void

    • (immediateId): void
    • Cancels an Immediate object created by setImmediate().

      Parameters

      Returns void

      Since

      v0.9.1

clearInterval: {
    (handle): void;
    (intervalId): void;
}

Type declaration

    • (handle): void
    • Copyright (c) Meta Platforms, Inc. and affiliates.

      This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

      Parameters

      • handle: number

      Returns void

      Format

    • (intervalId): void
    • Cancels a Timeout object created by setInterval().

      Parameters

      • intervalId: undefined | string | number | Timeout

      Returns void

      Since

      v0.0.1

clearTimeout: {
    (handle): void;
    (timeoutId): void;
}

Type declaration

    • (handle): void
    • Parameters

      • handle: number

      Returns void

    • (timeoutId): void
    • Cancels a Timeout object created by setTimeout().

      Parameters

      • timeoutId: undefined | string | number | Timeout

      Returns void

      Since

      v0.0.1

context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

Example

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

React Docs

isFocused: (() => boolean)

Returns if the input is currently focused.

Type declaration

    • (): boolean
    • Returns boolean

refs: {
    [key: string]: Component<any, any>;
} & {
    [key: string]: ReactInstance;
}

Type declaration

Type declaration

Deprecated

See

Legacy React Docs

requestAnimationFrame: ((callback) => number)

Type declaration

    • (callback): number
    • Parameters

      • callback: ((time) => void)
          • (time): void
          • Parameters

            • time: number

            Returns void

      Returns number

setImmediate: typeof setImmediate
setInterval: typeof setInterval
setSelection: ((start, end) => void)

Sets the start and end positions of text selection.

Type declaration

    • (start, end): void
    • Parameters

      • start: number
      • end: number

      Returns void

setTimeout: typeof setTimeout
state: Readonly<{}>

Type declaration

    Access the current focus state.

    contextType?: Context<any>

    If set, this.context will be set at runtime to the current value of the given Context.

    Example

    type MyContext = number
    const Ctx = React.createContext<MyContext>(0)

    class Foo extends React.Component {
    static contextType = Ctx
    context!: React.ContextType<typeof Ctx>
    render () {
    return <>My context's value: {this.context}</>;
    }
    }

    See

    https://react.dev/reference/react/Component#static-contexttype

    Methods

    • Removes focus from an input or view. This is the opposite of focus().

      Returns void

    • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

      Parameters

      Returns void

    • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

      Returns void

    • 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

    • 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

    • Requests focus for the given input or view. The exact behavior triggered will depend on the platform and type of view.

      Returns void

    • Parameters

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

      Returns void

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

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

      Parameters

      Returns any

    • Determines the location on screen, width, and height of the given view and returns the values via an async callback. If successful, the callback will be called with the following arguments:

      • x
      • y
      • width
      • height
      • pageX
      • pageY

      Note that these measurements are not available until after the rendering has been completed in native. If you need the measurements as soon as possible, consider using the onLayout prop instead.

      Parameters

      Returns void

    • Determines the location of the given view in the window and returns the values via an async callback. If the React root view is embedded in another native view, this will give you the absolute coordinates. If successful, the callback will be called with the following arguments:

      • x
      • y
      • width
      • height

      Note that these measurements are not available until after the rendering has been completed in native.

      Returns void

    • Like measure(), but measures the view relative an ancestor, specified as relativeToNativeComponentRef. This means that the returned x, y are relative to the origin x, y of the ancestor view. Can also be called with a relativeNativeNodeHandle but is deprecated.

      Parameters

      Returns void

    • Returns ReactNode

    • This function sends props straight to native. They will not participate in future diff process - this means that if you do not include them in the next render, they will remain active (see Direct Manipulation).

      Parameters

      • nativeProps: object

      Returns void

    • Type Parameters

      • K extends never

      Parameters

      • state: null | {} | ((prevState, props) => null | {} | Pick<{}, K>) | Pick<{}, K>
      • Optional callback: (() => void)
          • (): void
          • Returns void

      Returns void

    • 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