React Utils

PreviousNext

API reference for @udecode/react-utils.

Docs
platefile

Preview

Loading preview…
../../docs/api/react-utils.mdx
---
title: React Utils
description: API reference for @udecode/react-utils.
---

`@udecode/react-utils` contains utility functions for React.

## Components

### `<PortalBody>`

Renders a React component in the `document.body` using a portal.

### `<Text>`

Generic component for rendering a span.

### `<Box>`

Generic component for rendering a div.

## API

### `createPrimitiveComponent`

Creates a primitive component factory which utilizes hooks for managing state, props, and forwards references to child components.

<API name="createPrimitiveComponent">
<APIParameters>
  <APIItem name="element" type="React.ElementType">
    The base component or native HTML element.
  </APIItem>
</APIParameters>

<APIReturns type="Function">
  A function returning a primitive component with hooks for state and props management.
</APIReturns>
</API>

### `createPrimitiveElement`

Creates a component from an element type.

<API name="createPrimitiveElement">
<APIParameters>
  <APIItem name="element" type="React.ElementType">
    The native HTML element.
  </APIItem>
</APIParameters>

<APIReturns type="React.FC">
  A function component that renders the specified element.
</APIReturns>
</API>

### `createSlotComponent`

Creates a Slot component, which is useful when you want a component to behave as its child.

<API name="createSlotComponent">
<APIParameters>
  <APIItem name="element" type="React.ElementType">
    The base component or native HTML element.
  </APIItem>
</APIParameters>

<APIReturns type="Function">
  A function returning a Slot component.
</APIReturns>
</API>

### `withProviders`

A function that wraps a component in multiple providers.

<API name="withProviders">
<APIParameters>
  <APIItem name="providers" type="any[]">
    Providers with which to wrap the component. If there are any props that you want a provider to receive, simply pass an array.
  </APIItem>
  <APIItem name="WrappedComponent" type="FunctionComponent<T>">
    The component to be wrapped.
  </APIItem>
  <APIItem name="props" type="T">
    The props to be passed to the wrapped component.
  </APIItem>
</APIParameters>

<APIReturns type="FunctionComponent<T>">
  A new component that is wrapped by the specified providers.
</APIReturns>
</API>

Installation

npx shadcn@latest add @plate/api-react-utils-docs

Usage

Usage varies by registry entry. Refer to the registry docs or source files below for details.