Patterns

Built-in pattern names: email, phone, ssn, credit-card, ip. Use them in <RedactAuto patterns={[...]}> or in the provider’s autoDetect.

Built-in

Name detection is intentionally not included. Generic name matching in free text is high-noise, so use manual <Redact> wrapping for names or targeted customPatterns for known, domain-specific formats.

Custom patterns

Pass RegExp with the global flag to customPatterns on the provider or to <RedactAuto customPatterns={[/ACME-\d{6}/g]}>.

Programmatic API

import { patterns, getPatterns, createPattern, matchCreditCard } from 'react-redact';

// Get configs for names
const configs = getPatterns(['email', 'phone']);

// Custom pattern
const custom = createPattern(/ACME-\d{6}/g, 'acme-id');

// Credit-card uses Luhn; matchCreditCard(text) returns only valid matches
const matches = matchCreditCard('Card: 4111 1111 1111 1111');