1.0.23 • Published 5 months ago

@dolu13/react-accessibility-config v1.0.23

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

React Accessibility Config

Une bibliothèque React pour gérer facilement les paramètres d'accessibilité dans vos applications web.

🚀 Fonctionnalités

  • Configuration des contrastes (défaut, renforcé, inversé)
  • Adaptation de la police pour la dyslexie (OpenDyslexic)
  • Ajustement de l'interlignage
  • Personnalisation de l'alignement
  • Interface utilisateur intuitive et accessible
  • Thème personnalisable
  • Support complet des tests
  • Application automatique des styles d'accessibilité

📦 Installation

npm install @dolu13/react-accessibility-config

🎯 Utilisation

import React, { useState } from 'react';
import { AccessibilityConfig } from '@dolu13/react-accessibility-config';
import '@dolu13/react-accessibility-config/styles';

function App() {
  const [isOpen, setIsOpen] = useState(false);
  const [settings, setSettings] = useState({
    contrast: 'default',
    font: 'default',
    lineHeight: 'default',
    alignment: 'left'
  });

  const handleSettingsChange = (newSettings) => {
    console.log('Nouveaux paramètres:', newSettings);
    setSettings(newSettings);
  };

  return (
    <div>
      <h1>Mon Application</h1>
      <p>Ceci est un exemple de texte pour tester les paramètres d'accessibilité.</p>
      <a href="#">Ceci est un lien</a>
      
      <AccessibilityConfig
        isOpen={isOpen}
        onToggle={() => setIsOpen(!isOpen)}
        position="top-right"
        theme="default"
        defaultSettings={settings}
        onSettingsChange={handleSettingsChange}
      />
    </div>
  );
}

⚙️ Props

PropTypePar défautDescription
isOpenbooleanfalseÉtat d'ouverture du panneau de configuration
onToggle() => voidRequisFonction appelée lors du clic sur le bouton
classNamestring''Classe CSS personnalisée
position'top-right' \| 'top-left' \| 'bottom-right' \| 'bottom-left''top-right'Position du bouton de configuration
theme'default' \| 'dark' \| 'light''default'Thème de l'interface
customStylesRecord<string, React.CSSProperties>{}Styles personnalisés
defaultSettingsAccessibilitySettings{}Paramètres par défaut
onSettingsChange(settings: AccessibilitySettings) => void() => {}Callback lors du changement des paramètres

📋 Types

interface AccessibilitySettings {
  contrast: 'default' | 'high' | 'inverted';
  font: 'default' | 'dyslexic';
  lineHeight: 'default' | 'increased';
  alignment: 'left' | 'right';
}

🎨 Personnalisation avancée

import { useState } from 'react';
import { AccessibilityConfig, useAccessibilityStyles } from '@dolu13/react-accessibility-config';

const App = () => {
  const [isOpen, setIsOpen] = useState(false);
  const [settings, setSettings] = useState({
    contrast: 'default',
    font: 'default',
    lineHeight: 'default',
    alignment: 'left'
  });
  useAccessibilityStyles(settings);



  const handleSettingsChange = (newSettings: any) => {
    setSettings(newSettings);
  };

  return (
    <div>

      <AccessibilityConfig
        isOpen={isOpen}
        onToggle={() => setIsOpen(!isOpen)}
        position="top-left"
        theme="default" 
        defaultSettings={settings}
        onSettingsChange={handleSettingsChange}
      />
    </div>
  );
};

export default App;

🧪 Tests

# Exécuter les tests
npm test

# Exécuter les tests avec couverture
npm run test:coverage

🛠️ Développement

# Installation des dépendances
npm install

# Démarrage du serveur de développement
npm run dev

# Construction du projet
npm run build

📝 Licence

MIT

👥 Auteur

Demol Ludovic ldemol@norsys.fr

🔗 Liens

1.0.23

5 months ago

1.0.22

5 months ago

1.0.21

5 months ago

1.0.20

5 months ago

1.0.19

5 months ago

1.0.17

5 months ago

1.0.16

5 months ago

1.0.15

5 months ago

1.0.14

5 months ago

1.0.13

5 months ago

1.0.12

5 months ago

1.0.11

5 months ago

1.0.10

5 months ago

1.0.9

5 months ago

1.0.8

5 months ago

1.0.7

5 months ago

1.0.6

5 months ago

1.0.5

5 months ago

1.0.4

5 months ago

1.0.3

5 months ago

1.0.2

5 months ago

1.0.1

5 months ago

1.0.0

5 months ago