Al ejecutar cualquiera de los dos comandos, también se instala la dependencia @auth0/universal-components-core
para utilidades compartidas y la integración de Auth0.
Las props requeridas son fundamentales para el funcionamiento del componente. OrganizationDetailsEdit no tiene props requeridas: carga automáticamente los detalles de la organización actual desde la API My Organization.
Las props de visualización controlan cómo se renderiza el componente sin afectar su comportamiento. Úsalas para ocultar secciones o habilitar el modo de solo lectura.
Propiedad
Tipo
Descripción
readOnly
boolean
Deshabilita todos los campos del formulario. Valor predeterminado: false
hideHeader
boolean
Oculta la sección de encabezado. Valor predeterminado: false
Las props de Action gestionan las interacciones del usuario y definen qué ocurre cuando los usuarios guardan o cancelan cambios. Usa los hooks de ciclo de vida (onBefore, onAfter) para integrarlos con el enrutamiento y los análisis de tu aplicación.
Propiedad
Tipo
Descripción
saveAction
ComponentAction<OrganizationPrivate>
Acción para guardar los cambios.
cancelAction
ComponentAction<OrganizationPrivate>
Acción para cancelar o descartar los cambios.
backButton
Object
Configuración del botón de retroceso.
saveActionType:ComponentAction<OrganizationPrivate>Controla el flujo de guardado cuando los usuarios envían cambios en la organización. Usa onAfter para redirigir al usuario tras un guardado exitoso.Propiedades:
disabled - Deshabilita el botón Guardar (p. ej., mientras hay otra operación en curso)
onBefore(data) - Se ejecuta antes de la operación de guardado. Devuelve false para evitar que se guarde (por ejemplo, para mostrar primero un cuadro de diálogo de confirmación).
onAfter(data) - Se ejecuta después de que la organización se haya guardado correctamente. Úselo para salir de la página o registrar el evento.
Ejemplo:
// Volver atrás después de guardarsaveAction={{ onAfter: () => navigate("/organization"),}}// Agregar confirmación antes de guardarsaveAction={{ onBefore: (org) => { return confirm(`Save changes to "${org.display_name}"?`); }, onAfter: () => navigate("/organization"),}}// Registrar analíticas al guardarsaveAction={{ onAfter: (org) => { analytics.track("Organization Updated", { name: org.name, displayName: org.display_name, }); navigate("/organization"); },}}
cancelActionType:ComponentAction<OrganizationPrivate>Controla el flujo de cancelación/descarte. Usa esta acción para gestionar los cambios descartados.Propiedades:
disabled - Deshabilita el botón Cancelar
onBefore(data) - Se ejecuta antes de cancelar. Devuelve false para evitar la cancelación (por ejemplo, para confirmar si se deben descartar los cambios sin guardar).
onAfter(data) - Se ejecuta después de confirmar la cancelación. Úsalo para salir del formulario.
backButtonType:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configura el botón de retroceso en el encabezado del componente. Úsalo para volver a la descripción general de tu organización o a la página anterior.Propiedades:
icon - componente de icono personalizado de Lucide (opcional; el valor predeterminado es ArrowLeft)
Las props de personalización te permiten adaptar el componente a tu marca, configuración regional y requisitos de validación sin modificar el código fuente.
Propiedad
Tipo
Descripción
schema
OrganizationDetailsEditSchemas
Reglas de validación de campos.
customMessages
Partial<OrganizationDetailsEditMessages>
Sobrescrituras de textos de i18n.
styling
ComponentStyling<OrganizationEditClasses>
Variables CSS y sobrescrituras de clases.
schemaEstablece reglas de validación personalizadas para los campos de detalles de la organización.
Campos del esquema disponibles
Todos los campos del esquema admiten: regex, errorMessage, minLength, maxLength, requireddetails.name - nombre interno de la organización
details.displayName - nombre visible de la organización
details.color - color de la marca (formato hexadecimal)
details.logoURL - URL del logotipo
<OrganizationDetailsEdit schema={{ details: { name: { minLength: 3, maxLength: 50, regex: /^[a-zA-Z0-9-_]+$/, errorMessage: "Name must be alphanumeric with hyphens/underscores", }, displayName: { required: true, maxLength: 100, }, color: { regex: /^#[0-9A-Fa-f]{6}$/, errorMessage: "Enter a valid hex color (e.g., #FF5500)", }, logoURL: { regex: /^https:\/\/.+/, errorMessage: "Logo URL must use HTTPS", }, }, }}/>
customMessagesPersonaliza todos los textos y traducciones. Todos los campos son opcionales y, si no se especifican, se usan los valores predeterminados.
El componente OrganizationDetailsEdit está compuesto por subcomponentes y hooks más pequeños. Puedes importarlos individualmente para crear flujos de trabajo de edición de organizaciones personalizados si usas shadcn.
Estos hooks proporcionan la lógica subyacente sin ninguna interfaz de usuario. Úsalos para crear interfaces completamente personalizadas y aprovechar la integración con la API de Auth0.
Hook
Descripción
useOrganizationDetailsEdit
Lógica de edición de organizaciones e integración con la API
Al ejecutar los comandos de npm o pnpm, se instala la dependencia @auth0/universal-components-core para las utilidades compartidas y la integración de Auth0.
Las props principales son fundamentales para el funcionamiento del componente. OrganizationDetailsEdit no tiene props obligatorias: carga automáticamente los detalles de la organización actual desde la API My Organization.
Las props de visualización controlan cómo se renderiza el componente sin afectar su comportamiento. Úsalas para ocultar secciones o habilitar el modo de solo lectura.
Propiedad
Tipo
Descripción
readOnly
boolean
Desactiva todos los campos del formulario. Valor predeterminado: false
hideHeader
boolean
Oculta la sección de encabezado. Valor predeterminado: false
Las props de Action gestionan las interacciones del usuario y definen qué ocurre cuando los usuarios guardan o cancelan cambios. Usa los hooks de ciclo de vida (onBefore, onAfter) para integrarte con el enrutamiento y los análisis de tu aplicación.
Propiedad
Tipo
Descripción
saveAction
ComponentAction<OrganizationPrivate>
Acción para guardar los cambios.
cancelAction
ComponentAction<OrganizationPrivate>
Acción para cancelar o descartar los cambios.
backButton
Object
Configuración del botón de retroceso.
saveActionType:ComponentAction<OrganizationPrivate>Controla el flujo de guardado cuando los usuarios envían cambios en la organización. Usa onAfter para navegar a otra página tras guardar correctamente.Propiedades:
disabled - Desactiva el botón Guardar (p. ej., mientras otra operación está en curso)
onBefore(data) - Se ejecuta antes de guardar. Devuelve false para evitar el guardado (por ejemplo, para mostrar primero un cuadro de diálogo de confirmación).
onAfter(data) - Se ejecuta después de que la organización se haya guardado correctamente. Úsalo para salir de esta pantalla o registrar el evento.
Patrones comunes:
// Navegar hacia atrás después de guardarsaveAction={{ onAfter: () => router.push("/organization"),}}// Agregar confirmación antes de guardarsaveAction={{ onBefore: (org) => { return confirm(`Save changes to "${org.display_name}"?`); }, onAfter: () => router.push("/organization"),}}// Registrar análisis al guardarsaveAction={{ onAfter: (org) => { analytics.track("Organization Updated", { name: org.name, displayName: org.display_name, }); router.push("/organization"); },}}
cancelActionType:ComponentAction<OrganizationPrivate>Controla el flujo de cancelación/descarte. Usa esta acción para gestionar los cambios descartados.Propiedades:
disabled - Deshabilita el botón Cancelar
onBefore(data) - Se ejecuta antes de la acción de cancelar. Devuelve false para impedir la cancelación (por ejemplo, para confirmar que quieres descartar cambios no guardados).
onAfter(data) - Se ejecuta después de que se confirme la cancelación. Úselo para salir del formulario.
backButtonType:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configura el botón de retroceso en el encabezado del componente. Úsalo para volver a la descripción general de tu organización o a la página anterior.Propiedades:
icon - componente de icono personalizado de Lucide (opcional; el valor predeterminado es ArrowLeft)
Las props de personalización te permiten adaptar el componente a tu marca, configuración regional y requisitos de validación sin modificar el código fuente.
Propiedad
Tipo
Descripción
schema
OrganizationDetailsEditSchemas
Reglas de validación de campos.
customMessages
Partial<OrganizationDetailsEditMessages>
Sobrescrituras de texto para i18n.
styling
ComponentStyling<OrganizationEditClasses>
Variables CSS y sobrescrituras de clases.
schemaEstablece reglas de validación personalizadas para los campos de detalles de la organización.
Campos disponibles del esquema
Todos los campos del esquema admiten: regex, errorMessage, minLength, maxLength, requireddetails.name - Nombre interno de la organización
details.displayName - Nombre visible de la organización
details.color - Color de la marca (formato hexadecimal)
details.logoURL - URL del logotipo
<OrganizationDetailsEdit schema={{ details: { name: { minLength: 3, maxLength: 50, regex: /^[a-zA-Z0-9-_]+$/, errorMessage: "Name must be alphanumeric with hyphens/underscores", }, displayName: { required: true, maxLength: 100, }, color: { regex: /^#[0-9A-Fa-f]{6}$/, errorMessage: "Enter a valid hex color (e.g., #FF5500)", }, logoURL: { regex: /^https:\/\/.+/, errorMessage: "Logo URL must use HTTPS", }, }, }}/>
customMessagesPersonaliza todos los textos y traducciones. Todos los campos son opcionales y, si no se especifican, se usan los valores predeterminados.
El componente OrganizationDetailsEdit está compuesto por subcomponentes y hooks más pequeños. Puedes importarlos individualmente para crear flujos de trabajo de edición de organizaciones personalizados.
Estos hooks proporcionan la lógica subyacente sin ninguna interfaz de usuario. Úsalos para crear interfaces completamente personalizadas aprovechando la integración con la API de Auth0.
Hook
Descripción
useOrganizationDetailsEdit
Lógica de edición de organizaciones e integración con la API
Al ejecutar el comando shadcn, también se instala la dependencia @auth0/universal-components-core
para utilidades compartidas y la integración con Auth0.
Las props principales son fundamentales para el funcionamiento del componente. OrganizationDetailsEdit no tiene props obligatorias: carga automáticamente los detalles de la organización actual desde la API My Organization.
Las props de visualización controlan cómo se renderiza el componente sin afectar su comportamiento. Úsalas para ocultar secciones o habilitar el modo de solo lectura.
Propiedad
Tipo
Descripción
readOnly
boolean
Desactiva todos los campos del formulario. Valor predeterminado: false
hideHeader
boolean
Oculta la sección del encabezado. Valor predeterminado: false
Las props de Action gestionan las interacciones del usuario y definen qué ocurre cuando los usuarios guardan o cancelan cambios. Usa los hooks de ciclo de vida (onBefore, onAfter) para integrarlos con el enrutamiento y los análisis de tu aplicación.
Propiedad
Tipo
Descripción
saveAction
ComponentAction<OrganizationPrivate>
Acción para guardar los cambios.
cancelAction
ComponentAction<OrganizationPrivate>
Acción para cancelar o descartar los cambios.
backButton
Object
Configuración del botón Atrás.
saveActionType:ComponentAction<OrganizationPrivate>Controla el flujo de guardado cuando los usuarios envían cambios en la organización. Usa onAfter para redirigir al usuario tras un guardado exitoso.Propiedades:
disabled - Deshabilita el botón Guardar (por ejemplo, mientras hay otra operación en curso)
onBefore(data) - Se ejecuta antes de guardar. Devuelve false para impedir el guardado (por ejemplo, para mostrar primero un cuadro de diálogo de confirmación).
onAfter(data) - Se ejecuta después de que la organización se haya guardado correctamente. Úselo para navegar a otra página o registrar el evento.
Patrones comunes:
// Navegar hacia atrás después de guardarsaveAction={{ onAfter: () => navigate("/organization"),}}// Agregar confirmación antes de guardarsaveAction={{ onBefore: (org) => { return confirm(`Save changes to "${org.display_name}"?`); }, onAfter: () => navigate("/organization"),}}// Registrar analíticas al guardarsaveAction={{ onAfter: (org) => { analytics.track("Organization Updated", { name: org.name, displayName: org.display_name, }); navigate("/organization"); },}}
cancelActionType:ComponentAction<OrganizationPrivate>Controla el flujo de cancelación/descarte. Usa esta acción para gestionar los cambios descartados.Propiedades:
disabled - Deshabilita el botón Cancelar
onBefore(data) - Se ejecuta antes de la acción de cancelar. Devuelve false para evitar la cancelación (por ejemplo, para confirmar si se deben descartar los cambios no guardados).
onAfter(data) - Se ejecuta después de confirmar la cancelación. Úselo para salir del Form.
backButtonType:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configura el botón de retroceso en el encabezado del componente. Úsalo para volver a la descripción general de tu organización o a la página anterior.Propiedades:
icon - Componente de icono personalizado de Lucide (opcional; el valor predeterminado es ArrowLeft)
Las props de personalización te permiten adaptar el componente a tu marca, configuración regional y requisitos de validación sin modificar el código fuente.
Propiedad
Tipo
Descripción
schema
OrganizationDetailsEditSchemas
Reglas de validación de los campos.
customMessages
Partial<OrganizationDetailsEditMessages>
Sobrescrituras de texto para i18n.
styling
ComponentStyling<OrganizationEditClasses>
Variables CSS y sobrescrituras de clases.
schemaEstablece reglas de validación personalizadas para los campos de detalles de la organización.
Campos de esquema disponibles
Todos los campos del esquema admiten: regex, errorMessage, minLength, maxLength, requireddetails.name - nombre interno de la organización
details.displayName - nombre visible de la organización
details.color - color de la marca (formato hexadecimal)
details.logoURL - URL del logotipo
<OrganizationDetailsEdit schema={{ details: { name: { minLength: 3, maxLength: 50, regex: /^[a-zA-Z0-9-_]+$/, errorMessage: "Name must be alphanumeric with hyphens/underscores", }, displayName: { required: true, maxLength: 100, }, color: { regex: /^#[0-9A-Fa-f]{6}$/, errorMessage: "Enter a valid hex color (e.g., #FF5500)", }, logoURL: { regex: /^https:\/\/.+/, errorMessage: "Logo URL must use HTTPS", }, }, }}/>
customMessagesPersonaliza todos los textos y traducciones. Todos los campos son opcionales y, si no se especifican, se usan los valores predeterminados.
El componente OrganizationDetailsEdit está compuesto por subcomponentes y hooks más pequeños. Puedes importarlos individualmente para crear flujos de trabajo de edición de organizaciones personalizados si usas shadcn.
Estos hooks proporcionan la lógica subyacente sin ninguna interfaz de usuario. Úsalos para crear interfaces completamente personalizadas aprovechando la integración con la API de Auth0.
Hook
Descripción
useOrganizationDetailsEdit
Lógica para obtener y editar los datos de la organización