@okhi/react-native-okcollect
Options
All
  • Public
  • Public/Protected
  • All
Menu

The OkHiLocationManager exposes props that you can use to customise it's functionality and appearance.

Hierarchy

  • OkHiLocationManagerProps

Index

Properties

Properties

Optional config

config: undefined | { appBar?: undefined | { visible?: undefined | false | true }; streetView?: undefined | false | true }

Optional: An object that'll be used to customise the functionality of the Location Manager. This object dictates whether you want some features on or off.

launch

launch: boolean

Required: A boolean flag that determines whether or not to show the Location Manager.

Optional loader

loader: JSX.Element

Optional: A custom JSX.Element that'll be used as a loading indicator.

onCloseRequest

onCloseRequest: () => any

Required: A callback that'll be invoked whenever a user taps on the close button.

Type declaration

    • (): any

    • Returns any

onError

onError: (error: OkHiException) => any

Required: A callback that'll be invoked whenever an error occurs during the address creation process.

Type declaration

    • (error: OkHiException): any

    • Parameters

      • error: OkHiException

      Returns any

onSuccess

onSuccess: (response: OkCollectSuccessResponse) => any

Required: A callback that'll be invoked with an OkCollectSuccessResponse once an accurate OkHi address has been successfully created.

Type declaration

Optional style

style: ViewStyle

Optional: Used to customise the appearance of the Container that wraps the location manager.

Optional theme

theme: undefined | { appBar?: undefined | { backgroundColor?: undefined | string; logo?: undefined | string }; colors?: undefined | { primary?: undefined | string } }

Optional: An object that'll be used to customise the appearance of the Location Manager to better match your branding requirements.

user

user: OkHiUser

Required: A defined OkHiUser object, with a mandatory "phone" key property.

Legend

  • Property

Generated using TypeDoc