Skip to main content
OrganizationDetailsEdit コンポーネントは、組織の詳細を編集するための統合インターフェースを提供します。

設定の要件

Auth0 Configuration が必要です—tenant で My Organization API が設定されていることを確認してください。設定ガイドを表示 →

インストール

どちらのコマンドを実行しても、共有ユーティリティとAuth0連携に必要な@auth0/universal-components-core 依存パッケージもインストールされます。

はじめに

プロップス

必須のプロップス

必須プロップスはコンポーネントの動作に不可欠です。OrganizationDetailsEdit に必須プロップスはなく、現在の organization の詳細は My Organization API から自動的に読み込まれます。

表示関連のプロップス

表示用のプロップスは、コンポーネントの動作に影響を与えることなく、その表示方法を制御します。セクションを非表示にしたり、読み取り専用モードを有効にしたりする際に使用します。
プロパティ説明
readOnlybooleanすべてのフォーム入力を無効にします。デフォルト: false
hideHeaderbooleanヘッダーセクションを非表示にします。デフォルト: false

Action のプロップス

Actionのプロップスはユーザー操作を処理し、ユーザーが変更を保存またはキャンセルしたときの動作を定義します。ライフサイクルフック (onBeforeonAfter) を使用すると、アプリケーションのルーティングや分析と連携できます。
プロパティ説明
saveActionComponentAction<OrganizationPrivate>変更を保存するアクション。
cancelActionComponentAction<OrganizationPrivate>変更をキャンセルまたは破棄するアクション。
backButtonObject戻るボタンの設定。
saveAction型: ComponentAction<OrganizationPrivate>ユーザーが organization の変更を送信した際の保存フローを制御します。保存の成功後に別の画面へ遷移させるには onAfter を使用します。プロパティ:
  • disabled—保存ボタンを無効にします (たとえば、別の操作の実行中) 。
  • onBefore(data)—保存処理の前に実行されます。保存を中止するにはfalseを返します (たとえば、先に確認ダイアログを表示する場合) 。
  • onAfter(data)—organizationが正常に保存された後に実行されます。画面遷移やイベントの追跡に使用します。
例:

cancelAction型: ComponentAction<OrganizationPrivate>キャンセル/破棄のフローを制御します。破棄された変更の管理には、このアクションを使用します。プロパティ:
  • disabled—キャンセルボタンを無効にします
  • onBefore(data)—キャンセル操作の前に実行されます。キャンセルを中止するには false を返します (例:未保存の変更を破棄する前に確認する場合) 。
  • onAfter(data)—キャンセルが確定した後に実行されます。Form から移動する際に使用します。
例:

backButton型: { icon?: LucideIcon; onClick: (e: MouseEvent) => void }コンポーネントヘッダー内の戻るボタンを設定します。organizationの概要ページや前のページに戻る導線として使用します。プロパティ:
  • icon—カスタム Lucide アイコンコンポーネント (任意。デフォルトは ArrowLeft)
  • onClick—ナビゲーション用のクリックハンドラー
例:

カスタマイズ用プロップス

カスタマイズ用のプロップスを使えば、ソースコードを変更せずに、ブランド、ロケール、バリデーションの要件に合わせてコンポーネントを調整できます。
プロパティ説明
schemaOrganizationDetailsEditSchemasフィールドのバリデーションルール。
customMessagesPartial<OrganizationDetailsEditMessages>i18nテキストのオーバーライド。
stylingComponentStyling<OrganizationEditClasses>CSS変数とクラスのオーバーライド。
スキーマorganizationの詳細フィールドにカスタムのバリデーションルールを設定します。
すべての schema フィールドでサポート: regex, errorMessage, minLength, maxLength, requireddetails.name—組織の内部名 details.displayName—組織の表示名 details.color—ブランドカラー (16進数形式) details.logoURL—ロゴ URL

customMessagesすべてのテキストと翻訳をカスタマイズできます。すべてのフィールドは任意で、指定しない場合はデフォルト値が使用されます。
header—コンポーネントヘッダー
  • title, description, back_button_text
form—フォームのフィールド
  • fields.namelabel, placeholder, helper_text, error
  • fields.display_namelabel, placeholder, helper_text, error
  • fields.colorlabel, placeholder, helper_text, error
  • fields.logo_urllabel, placeholder, helper_text, error
actions—ボタンのラベル
  • save_button_text, cancel_button_text
notifications—APIレスポンス
  • save_success, save_error, general_error

スタイリングCSS変数とクラスのオーバーライドで外観をカスタマイズできます。テーマに応じたスタイリングにも対応しています。
変数—CSS カスタムプロパティ
  • common—すべてのテーマに適用
  • light—ライトテーマにのみ適用
  • dark—ダークテーマにのみ適用
クラス—コンポーネントクラスのオーバーライド
  • OrganizationDetailsEdit-header
  • OrganizationDetailsEdit-form
  • OrganizationDetailsEdit-actions

高度なカスタマイズ

OrganizationDetailsEdit コンポーネントは、より小さなサブコンポーネントとフックで構成されています。shadcn を使用している場合は、これらを個別に import して、独自の organization 編集ワークフローを構築できます。

利用可能なサブコンポーネント

高度なユースケースでは、個々のサブコンポーネントをインポートして、独自のorganization編集インターフェースを構築できます。
コンポーネント説明
OrganizationFormすべてのフィールドを含むメインのフォームコンポーネント
ColorPickerFieldブランドカラーを選択するフィールド
LogoUploadFieldプレビュー付きのロゴ URL 入力フィールド

利用可能なHooks

これらのフックは、UIを持たない基盤ロジックのみを提供します。Auth0 APIとの連携を活用しつつ、完全に独自のインターフェースを構築したい場合にご利用ください。
Hook説明
useOrganizationDetailsEdit組織の編集ロジックと API 連携