SDK reference
React
FaceCardProvider and useFaceCard.
npm install @facecard/sdkFaceCardProvider
Wrap the part of your app that uses face sign-in.
import { FaceCardProvider } from '@facecard/sdk/react';
export function Root({ children }: { children: React.ReactNode }) {
return <FaceCardProvider publishableKey="fc_pk_live_xxx">{children}</FaceCardProvider>;
}| Prop | Type | Description |
|---|---|---|
publishableKey | string | Your fc_pk_live_... key. |
useFaceCard
Returns the browser client from the nearest provider, with enroll and signIn. See Browser client.
import { useFaceCard } from '@facecard/sdk/react';
import { FaceCardError } from '@facecard/sdk';
export function SignIn({ onToken }: { onToken: (token: string) => void }) {
const fc = useFaceCard();
return (
<button
onClick={async () => {
try {
const { token } = await fc.signIn();
onToken(token);
} catch (err) {
if (err instanceof FaceCardError && err.code === 'no_match') alert('Try again');
else throw err;
}
}}
>
Sign in with your face
</button>
);
}Call useFaceCard only inside a FaceCardProvider.