PairingFlowProps

No behavioral description is attached to this declaration. The public signature, parameter and return types, and source location below document its published contract.

Kind: Interface
Package: @ovok/native

Import

import { PairingFlowProps } from '@ovok/native/ui';

TypeScript shape

interface PairingFlowProps extends OvokUiProps {
    storage: PairedDeviceStorage;
    storageKey?: string;
    getDeviceImage?: (device: RuntimeDevice) => string | undefined;
    onPaired?: (device: RuntimeDevice) => void;
    onPairingCode?: (code: string, device: RuntimeDevice) => Promise<void> | void;
    onError?: (error: Error, device?: RuntimeDevice) => void;
    renderHeader?: (state: PairingFlowRenderState) => React.ReactNode;
    renderEmpty?: (state: PairingFlowRenderState) => React.ReactNode;
    renderDevice?: (device: RuntimeDevice, actions: {
        pair: () => Promise<void>;
        forget: () => Promise<void>;
        status: PairingFlowStatus;
    }) => React.ReactNode;
    labels?: Record<string, string>;
    testID?: string;
}

This is a type-level export; it has no call parameters.

Public members

Member	Type	Details
storage	PairedDeviceStorage	—
storageKey	string	Optional. —
getDeviceImage	(device: RuntimeDevice) => string | undefined	Optional. —
onPaired	(device: RuntimeDevice) => void	Optional. —
onPairingCode	(code: string, device: RuntimeDevice) => Promise<void> | void	Optional. —
onError	(error: Error, device?: RuntimeDevice) => void	Optional. —
renderHeader	(state: PairingFlowRenderState) => React.ReactNode	Optional. —
renderEmpty	(state: PairingFlowRenderState) => React.ReactNode	Optional. —
renderDevice	(device: RuntimeDevice, actions: { pair: () => Promise<void>; forget: () => Promise<void>; status: PairingFlowStatus; }) => React.ReactNode	Optional. —
labels	Record<string, string>	Optional. Override visible copy, including keys from BluetoothErrorCode.
testID	string	Optional. —
theme	OvokThemeOverride	Optional. A partial theme is merged with the active react-native-paper theme.
slots	Partial<OvokUiSlots>	Optional. Replace individual primitives without forking an SDK component.

Learn the workflow

Continue with Ui And Data for the workflow context and examples.

Source

View the declaration in the SDK source.