@clerk/shared
Version:
Internal package utils used by the Clerk SDKs
30 lines (29 loc) • 1.08 kB
TypeScript
import { UseOrganizationCreationDefaultsParams, UseOrganizationCreationDefaultsReturn } from "./useOrganizationCreationDefaults.types.js";
//#region src/react/hooks/useOrganizationCreationDefaults.d.ts
/**
* The `useOrganizationCreationDefaults()` hook retrieves the organization creation defaults for the current user.
*
* @example
* ### Basic usage
*
* ```tsx
* import { useOrganizationCreationDefaults } from '@clerk/clerk-react'
*
* export default function CreateOrganizationForm() {
* const { data, isLoading } = useOrganizationCreationDefaults()
*
* if (isLoading) return <div>Loading...</div>
*
* return (
* <form>
* <input defaultValue={data?.form.name} placeholder="Organization name" />
* <input defaultValue={data?.form.slug} placeholder="Slug" />
* <button type="submit">Create</button>
* </form>
* )
* }
* ```
*/
declare function useOrganizationCreationDefaults(params?: UseOrganizationCreationDefaultsParams): UseOrganizationCreationDefaultsReturn;
//#endregion
export { useOrganizationCreationDefaults };