Configuration requise
Configuration Auth0 requise – Assurez-vous que votre locataire est configuré avec l’
API My Organization. Afficher le guide de configuration
→
Installation
L’exécution de la commande shadcn installe également la dépendance @auth0/universal-components-core
pour les utilitaires partagés et l’intégration Auth0.
Démarrage rapide
Exemple d’intégration complète
Exemple d’intégration complète
Bien que cet exemple utilise une application à page unique (SPA) React, les configurations des propriétés (schéma, customMessages, style, etc.) s’appliquent également aux configurations Next.js et shadcn.
Propriétés
Propriétés essentielles
Les propriétés essentielles sont fondamentales pour le fonctionnement du composant.OrganizationDetailsEdit n’a pas de propriétés requises : il charge automatiquement les détails de l’organization actuelle à partir de l’API My Organization.
Propriétés d’affichage
Les propriétés d’affichage contrôlent la manière dont le composant s’affiche sans altérer son comportement. Veuillez les utiliser pour masquer des sections ou activer le mode lecture seule.| Propriété | Type | Description |
|---|---|---|
readOnly | boolean | Désactivez toutes les entrées de formulaire. Valeur par défaut : false |
hideHeader | boolean | Masquer la section d’en-tête. Valeur par défaut : false |
Propriétés d’action
Les propriétés d’action gèrent les interactions des utilisateurs et définissent ce qui se produit lorsque les utilisateurs enregistrent ou annulent des modifications. Veuillez utiliser les hooks de cycle de vie (onBefore, onAfter) pour intégrer le routage et l’analyse de votre application.
saveAction
Type :ComponentAction<OrganizationPrivate>
Contrôle le flux d’enregistrement lorsque les utilisateurs soumettent des modifications à l’organization. Utilisez onAfter pour quitter la page après un enregistrement réussi.
Propriétés :
disabled– Désactiver le bouton d’enregistrement (p. ex., lorsqu’une autre opération est en cours).onBefore(data)– S’exécute avant l’opération d’enregistrement. Renvoie « false » pour empêcher l’enregistrement (p. ex., pour afficher d’abord une boîte de dialogue de confirmation).onAfter(data)– S’exécute une fois l’organization enregistrée. À utiliser pour quitter la page ou suivre l’événement.
cancelAction
Type :ComponentAction<OrganizationPrivate>
Contrôle le flux d’annulation/suppression. Utilisez cette action pour gérer les modifications supprimées.
Propriétés :
disabled– Désactiver le bouton d’annulationonBefore(data)– S’exécute avant l’action d’annulation. Renvoie « false » pour empêcher l’annulation (p. ex., pour confirmer la suppression des modifications non enregistrées).onAfter(data)– S’exécute après la confirmation de l’annulation. À utiliser pour quitter le formulaire.
backButton
Type :{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }
Configure le bouton de retour dans l’en-tête du composant. À utiliser pour revenir à la vue d’ensemble de votre organization ou à la page précédente.
Propriétés :
icon– Composant icône Lucide personnalisé (facultatif, valeur par défaut : ArrowLeft)onClick– Gestionnaire de clic pour la navigation
Propriétés de personnalisation
Les propriétés de personnalisation vous permettent d’adapter le composant à votre marque, à votre région et à vos exigences de validation sans modifier le code source.schéma
Définir des règles de validation personnalisées pour les champs de détails de l’organization.Champs de schéma disponibles
Champs de schéma disponibles
Tous les champs du schéma prennent en charge :
regex, errorMessage, minLength, maxLength, requireddetails.name – Nom interne de l’organization
details.displayName – Nom d’affichage de l’organization
details.color – Couleur de la marque (format hexadécimal)
details.logoURL – URL du logocustomMessages
Personaliser tous les textes et toutes les traductions. Tous les champs sont facultatifs et utilisent les valeurs par défaut s’ils ne sont pas renseignés.Messages disponibles
Messages disponibles
en-tête – En-tête du composant
title,description,back_button_text
fields.name-label,placeholder,helper_text,errorfields.display_name-label,placeholder,helper_text,errorfields.color-label,placeholder,helper_text,errorfields.logo_url-label,placeholder,helper_text,error
save_button_text,cancel_button_text
save_success,save_error,general_error
style
Personnaliser l’apparence à l’aide de variables CSS et de surcharges de classe. Prend en charge les styles adaptés aux thèmes.Options de styles disponibles
Options de styles disponibles
Variables – Propriétés personnalisées CSS
–
common – Appliqué à tous les thèmes
– light – Thème clair uniquement
– dark – Thème sombre uniquementClasses – Surcharges de classes des composants– OrganizationDetailsEdit-header
– OrganizationDetailsEdit-form
– OrganizationDetailsEdit-actionsPersonnalisation avancée
Le composantOrganizationDetailsEdit est constitué de sous-composants et de hooks plus petits. Vous pouvez les importer individuellement pour créer des flux de production d’édition d’organization personnalisés si vous utilisez shadcn.
Sous-composants disponibles
Pour les cas d’utilisation avancés, vous pouvez importer des sous-composants individuels afin de créer des interfaces d’édition personnalisées pour votre organization.| Composant | Description |
|---|---|
OrganizationForm | Composant principal du formulaire avec tous les champs |
ColorPickerField | Champ de sélection de la couleur de la marque |
LogoUploadField | Saisie de l’URL du logo avec aperçu |
Hooks disponibles
Ces hooks fournissent la logique sous-jacente sans aucune interface utilisateur. Veuillez les utiliser pour créer des interfaces entièrement personnalisées tout en tirant parti de l’intégration de l’API Auth0.| Hook | Description |
|---|---|
useOrganizationDetailsEdit | Logique d’édition de l’organization et intégration de l’API |