Required props are fundamental to the component’s operation. OrganizationDetailsEdit has no required props—it automatically loads the current organization’s details from the My Organization API.
Action props handle user interactions and define what happens when users save or cancel changes. Use lifecycle hooks (onBefore, onAfter) to integrate with your application’s routing and analytics.
Prop
Type
Description
saveAction
ComponentAction<OrganizationPrivate>
Save changes action.
cancelAction
ComponentAction<OrganizationPrivate>
Cancel/discard changes action.
backButton
Object
Back button configuration.
saveActionType:ComponentAction<OrganizationPrivate>Controls the save flow when users submit organization changes. Use onAfter to navigate away after successful save.Properties:
disabled—Disable the save button (for example, while another operation is in progress)
onBefore(data)—Runs before the save operation. Return false to prevent saving (for example, to show a confirmation dialog first).
onAfter(data)—Runs after the organization is successfully saved. Use this to navigate away or track the event.
Example:
// Navigate back after savingsaveAction={{ onAfter: () => navigate("/organization"),}}// Add confirmation before savingsaveAction={{ onBefore: (org) => { return confirm(`Save changes to "${org.display_name}"?`); }, onAfter: () => navigate("/organization"),}}// Track analytics on savesaveAction={{ onAfter: (org) => { analytics.track("Organization Updated", { name: org.name, displayName: org.display_name, }); navigate("/organization"); },}}
cancelActionType:ComponentAction<OrganizationPrivate>Controls the cancel/discard flow. Use this action to manage discarded changes.Properties:
disabled—Disable the cancel button
onBefore(data)—Runs before the cancel action. Return false to prevent cancellation (for example, to confirm discarding unsaved changes).
onAfter(data)—Runs after the cancel is confirmed. Use this to navigate away from the form.
backButtonType:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configures the back button in the component header. Use this to navigate back to your organization overview or the previous page.Properties:
icon—Custom Lucide icon component (optional, defaults to ArrowLeft)
Customization props let you adapt the component to your brand, locale, and validation requirements without modifying source code.
Prop
Type
Description
schema
OrganizationDetailsEditSchemas
Field validation rules.
customMessages
Partial<OrganizationDetailsEditMessages>
i18n text overrides.
styling
ComponentStyling<OrganizationEditClasses>
CSS variables and class overrides.
schemaSet custom validation rules for organization detail fields.
Available Schema Fields
All schema fields support: regex, errorMessage, minLength, maxLength, requireddetails.name—Organization internal name
details.displayName—Organization display name
details.color—Brand color (hex format)
details.logoURL—Logo URL
<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", }, }, }}/>
customMessagesCustomize all text and translations. All fields are optional and use defaults if not provided.
The OrganizationDetailsEdit component is composed of smaller subcomponents and hooks. You can import them individually to build custom organization editing workflows if you use shadcn.
Core props are fundamental to the component’s operation. OrganizationDetailsEdit has no required props—it automatically loads the current organization’s details from the My Organization API.
Action props handle user interactions and define what happens when users save or cancel changes. Use lifecycle hooks (onBefore, onAfter) to integrate with your application’s routing and analytics.
Prop
Type
Description
saveAction
ComponentAction<OrganizationPrivate>
Save changes action.
cancelAction
ComponentAction<OrganizationPrivate>
Cancel/discard changes action.
backButton
Object
Back button configuration.
saveActionType:ComponentAction<OrganizationPrivate>Controls the save flow when users submit organization changes. Use onAfter to navigate away after successful save.Properties:
disabled—Disable the save button (for example, while another operation is in progress)
onBefore(data)—Runs before the save operation. Return false to prevent saving (for example, to show a confirmation dialog first).
onAfter(data)—Runs after the organization is successfully saved. Use this to navigate away or track the event.
Common Patterns:
// Navigate back after savingsaveAction={{ onAfter: () => router.push("/organization"),}}// Add confirmation before savingsaveAction={{ onBefore: (org) => { return confirm(`Save changes to "${org.display_name}"?`); }, onAfter: () => router.push("/organization"),}}// Track analytics on savesaveAction={{ onAfter: (org) => { analytics.track("Organization Updated", { name: org.name, displayName: org.display_name, }); router.push("/organization"); },}}
cancelActionType:ComponentAction<OrganizationPrivate>Controls the cancel/discard flow. Use this action to manage discarded changes.Properties:
disabled—Disable the cancel button
onBefore(data)—Runs before the cancel action. Return false to prevent cancellation (for example, to confirm discarding unsaved changes).
onAfter(data)—Runs after the cancel is confirmed. Use this to navigate away from the form.
backButtonType:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configures the back button in the component header. Use this to navigate back to your organization overview or the previous page.Properties:
icon—Custom Lucide icon component (optional, defaults to ArrowLeft)
Customization props let you adapt the component to your brand, locale, and validation requirements without modifying source code.
Prop
Type
Description
schema
OrganizationDetailsEditSchemas
Field validation rules.
customMessages
Partial<OrganizationDetailsEditMessages>
i18n text overrides.
styling
ComponentStyling<OrganizationEditClasses>
CSS variables and class overrides.
schemaSet custom validation rules for organization detail fields.
Available Schema Fields
All schema fields support: regex, errorMessage, minLength, maxLength, requireddetails.name—Organization internal name
details.displayName—Organization display name
details.color—Brand color (hex format)
details.logoURL—Logo URL
<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", }, }, }}/>
customMessagesCustomize all text and translations. All fields are optional and use defaults if not provided.
The OrganizationDetailsEdit component is composed of smaller subcomponents and hooks. You can import them individually to build custom organization editing workflows.
Core props are fundamental to the component’s operation. OrganizationDetailsEdit has no required props—it automatically loads the current organization’s details from the My Organization API.
Action props handle user interactions and define what happens when users save or cancel changes. Use lifecycle hooks (onBefore, onAfter) to integrate with your application’s routing and analytics.
Prop
Type
Description
saveAction
ComponentAction<OrganizationPrivate>
Save changes action.
cancelAction
ComponentAction<OrganizationPrivate>
Cancel/discard changes action.
backButton
Object
Back button configuration.
saveActionType:ComponentAction<OrganizationPrivate>Controls the save flow when users submit organization changes. Use onAfter to navigate away after successful save.Properties:
disabled—Disable the save button (for example, while another operation is in progress)
onBefore(data)—Runs before the save operation. Return false to prevent saving (for example, to show a confirmation dialog first).
onAfter(data)—Runs after the organization is successfully saved. Use this to navigate away or track the event.
Common Patterns:
// Navigate back after savingsaveAction={{ onAfter: () => navigate("/organization"),}}// Add confirmation before savingsaveAction={{ onBefore: (org) => { return confirm(`Save changes to "${org.display_name}"?`); }, onAfter: () => navigate("/organization"),}}// Track analytics on savesaveAction={{ onAfter: (org) => { analytics.track("Organization Updated", { name: org.name, displayName: org.display_name, }); navigate("/organization"); },}}
cancelActionType:ComponentAction<OrganizationPrivate>Controls the cancel/discard flow. Use this action to manage discarded changes.Properties:
disabled—Disable the cancel button
onBefore(data)—Runs before the cancel action. Return false to prevent cancellation (for example, to confirm discarding unsaved changes).
onAfter(data)—Runs after the cancel is confirmed. Use this to navigate away from the form.
backButtonType:{ icon?: LucideIcon; onClick: (e: MouseEvent) => void }Configures the back button in the component header. Use this to navigate back to your organization overview or the previous page.Properties:
icon—Custom Lucide icon component (optional, defaults to ArrowLeft)
Customization props let you adapt the component to your brand, locale, and validation requirements without modifying source code.
Prop
Type
Description
schema
OrganizationDetailsEditSchemas
Field validation rules.
customMessages
Partial<OrganizationDetailsEditMessages>
i18n text overrides.
styling
ComponentStyling<OrganizationEditClasses>
CSS variables and class overrides.
schemaSet custom validation rules for organization detail fields.
Available Schema Fields
All schema fields support: regex, errorMessage, minLength, maxLength, requireddetails.name—Organization internal name
details.displayName—Organization display name
details.color—Brand color (hex format)
details.logoURL—Logo URL
<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", }, }, }}/>
customMessagesCustomize all text and translations. All fields are optional and use defaults if not provided.
The OrganizationDetailsEdit component is composed of smaller subcomponents and hooks. You can import them individually to build custom organization editing workflows if you use shadcn.