Skip to main content
🔐

Biometrics

Security
View Docs

Authenticate users with Face ID, Touch ID, or fingerprint

faceidtouchidfingerprintauthenticationsecurity

Demo

Biometric Availability

👆

Checking...

Authenticate

Note: On native platforms, this uses Face ID (iOS), Touch ID (iOS/Mac), or fingerprint (Android). On web browsers, a simulated authentication prompt is shown for testing purposes.

Usage

import { useBiometrics } from '@classic-homes/native/svelte';
// or for React:
import { useBiometrics } from '@classic-homes/native/react';

API Reference

PropertyTypeDescription
isAvailableboolean | nullWhether biometrics are available on device
availabilityBiometricAvailability | nullDetailed availability info including biometry type
isLoadingbooleanWhether an operation is in progress
errorError | nullCurrent error if any
checkAvailability() => Promise<BiometricAvailability>Check biometric availability
authenticate(options?) => Promise<BiometricResult>Prompt for biometric authentication

Related Features