react-sensitive-hide

react-sensitive-hide

📦 npm package

A lightweight React component for hiding sensitive inline text (images comming soon) with blur, blackout, CAPTCHA, or age verification unlock mechanisms. Perfect for protecting sensitive information in user interfaces while maintaining a clean, accessible experience.

Keywords: react, npm-package, safety, sensitive, content-protection, hide-text, kid-safe, protect-text

🎮 Live Demo

Try it out live! - See all features in action with interactive examples.

✨ Features

• 🎯 Inline Text Hiding - Wrap sensitive text directly in paragraphs
• 🔒 Multiple Reveal Modes - Blur, blackout, or CAPTCHA-based unlocking
• ♿ Accessible - Full keyboard navigation and screen reader support
• 🎨 Customizable - Flexible styling and behavior options
• 📦 Lightweight - Zero heavy dependencies, tree-shakeable
• 🔧 TypeScript - Full type safety and IntelliSense support
• ⚡ React 18+ - Built with modern React features

📦 Installation

npm install react-sensitive-hide

yarn add react-sensitive-hide

pnpm add react-sensitive-hide

🚀 Quick Start

import { HideMe } from 'react-sensitive-hide';
import 'react-sensitive-hide/styles.css';

function App() {
  return (
    <p>
      Here is some public text. <HideMe>Hidden sensitive text</HideMe> continues here.
    </p>
  );
}

📖 Usage Examples

Basic Blur Mode (Default)

import { HideMe } from 'react-sensitive-hide';
import 'react-sensitive-hide/styles.css';

<p>
  Your password is <HideMe>super-secret-123</HideMe> and should be kept safe.
</p>;

Blackout Mode

<HideMe mode="blur" blackOut={true}>
  This text will be completely blacked out
</HideMe>

CAPTCHA Mode

<HideMe mode="captcha" captchaDifficulty="easy">
  This content requires solving a simple math problem to reveal
</HideMe>

Age Verification Mode

<HideMe mode="age-verification">This content requires age verification (18+ by default)</HideMe>

Age Verification with Custom Minimum Age

<HideMe mode="age-verification" minimumAge={21}>
  This content requires you to be 21 or older
</HideMe>

Custom Styling

<HideMe mode="blur" blurAmount={8} className="my-custom-class" style={{ borderRadius: '4px' }}>
  Custom styled hidden content
</HideMe>

🔧 API Reference

HideMeProps

Prop	Type	Default	Description
children	ReactNode	-	Required. The content to hide
mode	"blur" | "captcha" | "age-verification"	"blur"	Reveal mechanism
blackOut	boolean	false	Use blackout instead of blur
blurAmount	number	5	CSS blur value (0-20)
captchaDifficulty	"easy" | "medium" | "hard"	"easy"	Math problem complexity
minimumAge	number	18	Minimum age required for age verification
className	string	-	Additional CSS classes
style	CSSProperties	-	Inline styles

Mode Details

Blur Mode

• Default behavior - Text is blurred and can be revealed on click
• Accessibility - Screen readers announce "hidden content" with reveal instructions
• Keyboard - Focusable with Tab, reveal with Enter/Space

CAPTCHA Mode

• Math problems - Simple arithmetic (e.g., "5 + 2 = ?")
• Difficulty levels:
  • easy: Single digit addition/subtraction
  • medium: Two digit operations
  • hard: Three digit operations with mixed operators
• Accessibility - Full keyboard navigation and screen reader support

Age Verification Mode

• Age verification - Users must enter their date of birth to verify their age
• HTML5 date input - Clean, native date picker interface
• Configurable minimum age - Default is 18, can be customized via minimumAge prop
• No persistence - Verification is required every time the user tries to reveal content
• Validation:
  • Checks if the user meets the minimum age requirement
  • Validates that the date is not in the future
  • Shows clear error messages when validation fails
• Privacy - No data is stored or sent anywhere; all validation happens client-side
• Accessibility - Full keyboard navigation and screen reader support

🎨 Styling

Important: Don't forget to import the CSS file in your application:

import 'react-sensitive-hide/styles.css';

The component uses CSS custom properties for easy theming:

.hide-me {
  --hide-me-bg: #f5f5f5;
  --hide-me-text: #333;
  --hide-me-border: #ddd;
  --hide-me-hover-bg: #e0e0e0;
}

♿ Accessibility

• ARIA labels - Proper aria-hidden and aria-label attributes
• Keyboard navigation - Full Tab/Enter/Space support
• Screen readers - Clear announcements and instructions
• Focus management - Proper focus handling during reveal
• High contrast - Works with system high contrast modes

🧪 Testing

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

# Run linting
npm run lint

# Format code
npm run format

🛠️ Development

Prerequisites

• Node.js 18+
• npm/yarn/pnpm

Setup

# Clone the repository
git clone https://github.com/LyesWeb/react-sensitive-hide.git
cd react-sensitive-hide

# Install dependencies
npm install

# Start development server
npm run dev

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Code Style

• Follow the existing code style
• Use TypeScript for all new code
• Write tests for new features
• Update documentation as needed
• Follow conventional commit messages

🐛 Bug Reports

Found a bug? Please open an issue with:

• Clear description of the problem
• Steps to reproduce
• Expected vs actual behavior
• Browser/device information
• Code example (if applicable)

💡 Feature Requests

Have an idea? We'd love to hear it! Please open an issue with:

• Clear description of the feature
• Use case and motivation
• Proposed API (if applicable)
• Any mockups or examples

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.