Slot

Merges its props onto its immediate child.

Features

Can be used to support your own `asChild` prop.

Anatomy

Import the component.

import { Slot } from "radix-ui";

export default () => (
	<Slot.Root>
		<div>Hello</div>
	</Slot.Root>
);

Basic example

Use to create your own asChild API.

When your component has a single children element:

// your-button.jsx
import * as React from "react";
import { Slot } from "radix-ui";

function Button({ asChild, ...props }) {
	const Comp = asChild ? Slot.Root : "button";
	return <Comp {...props} />;
}

Use Slottable when your component has multiple children to pass the props to the correct element:

// your-button.jsx
import * as React from "react";
import { Slot } from "radix-ui";

function Button({ asChild, children, leftElement, rightElement, ...props }) {
	const Comp = asChild ? Slot.Root : "button";
	return (
		<Comp {...props}>
			{leftElement}
			<Slot.Slottable>{children}</Slot.Slottable>
			{rightElement}
		</Comp>
	);
}

Wrapping the slotted element

Pass the child to Slottable via the child prop and provide a render function to wrap the slotted element in additional markup, while Slot still merges its props and refs onto the child.

// your-button.jsx
import * as React from "react";
import { Slot } from "radix-ui";

function Button({ asChild, children, ...props }) {
	const Comp = asChild ? Slot.Root : "button";
	return (
		<Comp {...props}>
			<Slot.Slottable child={children}>
				{(child) => <span className="ButtonInner">{child}</span>}
			</Slot.Slottable>
		</Comp>
	);
}

Usage

import { Button } from "./your-button";

export default () => (
	<Button asChild>
		<a href="/contact">Contact</a>
	</Button>
);

Event handlers

Any prop that starts with on (e.g., onClick) is considered an event handler.

When merging event handlers, Slot will create a new function where the child handler takes precedence over the slot handler.

If one of the event handlers relies on event.defaultPrevented make sure that the order is correct.

import { Slot } from "radix-ui";

export default () => (
	<Slot.Root
		onClick={(event) => {
			if (!event.defaultPrevented)
				console.log("Not logged because default is prevented.");
		}}
	>
		<button onClick={(event) => event.preventDefault()} />
	</Slot.Root>
);

Slot.createSlot returns a Slot component scoped to the name you pass, which is used in its error messages. It accepts type arguments to specify the element the slot renders and the props it accepts, so consumers get accurate types. Slot.SlotProps accepts the same type arguments.

import * as React from "react";
import { Slot } from "radix-ui";

type ButtonProps = React.ComponentPropsWithoutRef<"button"> & {
	variant?: "solid" | "ghost";
};

const ButtonSlot = Slot.createSlot<HTMLButtonElement, ButtonProps>(
	"Button.Slot",
);

PreviousPortal

NextVisually Hidden

Edit this page on GitHub.

Overview

Guides

Components

Utilities