| null | undefined,\n value: T,\n): void | (() => void);\n```\n\nSets both a function and object React ref.\n\nReturns a callback ref cleanup function when one is provided.\n\n\n\n#### `isValidElementWithRef`\n\n```ts\nfunction isValidElementWithRef }>(\n element: unknown,\n): element is ReactElement
& { ref?: Ref };\n```\n\nChecks if an element is a valid React element with a ref.\n\n\n\n#### `getRefProperty`\n\n```ts\nfunction getRefProperty(element: unknown): Ref | undefined;\n```\n\nGets the ref property from a React element.\n\n\n\n#### `mergeProps`\n\n```ts\nfunction mergeProps>(base: T, overrides: T): T;\n```\n\nMerges two sets of props.\n\n\n\n### System utilities\n\nHelpers for creating and composing Ariakit React components.\n\n#### `forwardRef`\n\n```ts\nfunction forwardRef>(render: T): T;\n```\n\nThe same as `React.forwardRef` but passes the `ref` as a prop and returns a component with the same generic type.\n\nProps holding `undefined` are dropped, so passing one behaves the same as omitting it and the component keeps the value it computes for itself.\n\n\n\n#### `memo`\n\n```ts\nfunction memo>(\n Component: T,\n propsAreEqual?: (\n prevProps: Readonly>,\n nextProps: Readonly>,\n ) => boolean,\n): T;\n```\n\nThe same as `React.memo` but returns a component with the same generic type.\n\n\n\n#### `createElement`\n\n```ts\nfunction createElement(\n Type: React.ElementType,\n props: Props,\n): React.ReactElement>;\n```\n\nCreates a React element that supports the `render` and `wrapElement` props.\n\n\n\n#### `createHook`\n\n```ts\nfunction createHook<\n T extends React.ElementType,\n P extends AnyObject = EmptyObject,\n>(useProps: (props: Props) => HTMLProps): Hook;\n```\n\nCreates a component hook that accepts props and returns props so they can be passed to a React element.\n\n\n\n#### `createStoreContext`\n\n```ts\ntype StoreProvider = React.ComponentType<{\n value: T | undefined;\n children?: React.ReactNode;\n}>;\n\nfunction createStoreContext(\n providers: StoreProvider[] = [],\n scopedProviders: StoreProvider[] = [],\n): {\n context: React.Context;\n scopedContext: React.Context;\n useContext: () => T | undefined;\n useScopedContext: (onlyScoped?: boolean) => T | undefined;\n useProviderContext: () => T | undefined;\n ContextProvider: (\n props: React.ComponentPropsWithoutRef>,\n ) => React.JSX.Element;\n ScopedContextProvider: (\n props: React.ComponentPropsWithoutRef>,\n ) => React.JSX.Element;\n};\n```\n\nCreates an Ariakit store context with hooks and provider components.\n\n\n\n### Type utilities\n\nShared types for Ariakit React components.\n\n#### `RenderProp`\n\n```ts\ntype RenderProp & { ref?: React.Ref }> = (\n props: P,\n) => React.ReactNode;\n```\n\nRender prop type.\n\nExample:\n\n```ts\nconst children: RenderProp = (props) => ;\n```\n\n\n\n#### `WrapElement`\n\n```ts\ntype WrapElement = (element: React.ReactElement) => React.ReactElement;\n```\n\nThe `wrapElement` prop.\n\n\n\n#### `Options`\n\n```ts\ninterface Options {\n wrapElement?: WrapElement;\n /**\n * Allows the component to be rendered as a different HTML element or React\n * component. The value can be a React element or a function that takes in the\n * original component props and gives back a React element with the props\n * merged.\n *\n * Some Ariakit components detect the type of the underlying element when they\n * mount. If the render element's type may change while the component is\n * mounted, pass a\n * [`key`](https://react.dev/learn/preserving-and-resetting-state) prop that\n * changes with the element type so React remounts the component with the new\n * element. Remounting resets uncontrolled state, so keep the relevant state\n // ... 11 more lines\n * for more details.\n */\n render?: RenderProp | React.ReactElement;\n}\n```\n\nCustom props including the `render` prop.\n\n\n\n#### `HTMLProps`\n\n```ts\ntype HTMLProps<\n T extends React.ElementType,\n P extends AnyObject = EmptyObject,\n> = Omit, keyof P> & {\n [index: `data-${string}`]: unknown;\n};\n```\n\nHTML props based on the element type, excluding custom props.\n\nExample:\n\n```ts\ntype ButtonHTMLProps = HTMLProps<\"button\", { custom?: boolean }>;\n```\n\n\n\n#### `Props`\n\n```ts\ntype Props = P &\n HTMLProps;\n```\n\nProps based on the element type, including custom props.\n\n\n\n#### `Hook`\n\n```ts\ntype Hook = <\n ElementType extends React.ElementType = T,\n>(\n props?: Props,\n) => HTMLProps;\n```\n\nA component hook that supports the `render` prop and returns HTML props based on the element type.\n\nExample:\n\n```ts\ntype UseButton = Hook<\"button\", { custom?: boolean }>;\n```\n\n\n\n\n","readmeFilename":""}