Options
All
  • Public
  • Public/Protected
  • All
Menu

NativeMethods provides methods to access the underlying native component directly. This can be useful in cases when you want to focus a view or measure its on-screen dimensions, for example. The methods described here are available on most of the default components provided by React Native. Note, however, that they are not available on composite components that aren't directly backed by a native view. This will generally include most components that you define in your own app. For more information, see Direct Manipulation.

see

https://github.com/facebook/react-native/blob/master/Libraries/Renderer/shims/ReactNativeTypes.js#L87

Hierarchy

  • NativeMethods

Index

Properties

refs: {}

Type declaration

Methods

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

    Returns void

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

    Returns void

  • 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.

    Parameters

    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

  • setNativeProps(nativeProps: object): void
  • 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

Generated using TypeDoc