Interface OkHiLocationManagerProps

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

Hierarchy

  • OkHiLocationManagerProps

Properties

config? launch loader? location? mode? onCloseRequest onError onSuccess style? theme? user

Properties

Optional config

config?: {
    addressTypes?: {
        home?: boolean;
        work?: boolean;
    };
    appBar?: {
        visible?: boolean;
    };
    streetView?: boolean;
    usageTypes?: UsageType;
}

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.

Type declaration

  • Optional addressTypes?: {
        home?: boolean;
        work?: boolean;
    }
    • Optional home?: boolean
    • Optional work?: boolean
  • Optional appBar?: {
        visible?: boolean;
    }
    • Optional visible?: boolean
  • Optional streetView?: boolean
  • Optional usageTypes?: UsageType

launch

launch: boolean

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

Optional loader

loader?: Element

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

Optional location

location?: {
    id: string;
}

Type declaration

  • id: string

Optional mode

mode?: "create" | "select"

Optional: Enable a user to either select an existing address, or force to create a new one

onCloseRequest

onCloseRequest: (() => any)

Type declaration

    • (): any

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

      Returns any

onError

onError: ((error: OkHiException) => any)

Type declaration

    • (error: OkHiException): any

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

      Parameters

      Returns any

onSuccess

onSuccess: ((response: OkCollectSuccessResponse) => any)

Type declaration

Optional style

style?: ViewStyle

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

Optional theme

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

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

Type declaration

  • Optional appBar?: {
        backgroundColor?: string;
        logo?: string;
    }
    • Optional backgroundColor?: string
    • Optional logo?: string
  • Optional colors?: {
        primary?: string;
    }
    • Optional primary?: string

user

user: OkHiUser

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

Settings

Member Visibility

Theme

Generated using TypeDoc