---
title: Portal
description: "`Portal` is a component that renders elements outside of the current `DOM` hierarchy."
links:
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/portal
---

```tsx
<>
  <Text>元の世界</Text>
  <Portal>
    <Text>ナツキ・スバル</Text>
  </Portal>
</>
```

## Usage

```tsx
import { Portal } from "@yamada-ui/react"
```

```tsx
import { Portal } from "@/components/ui"
```

```tsx
import { Portal } from "@workspaces/ui"
```

```tsx
<Portal />
```

### Change the destination

To change the destination, set the `ref` of the destination to `containerRef`. By default, it transfers to the end of `document.body`.

```tsx
const containerRef = useRef<HTMLDivElement>(null)

return (
  <VStack>
    <Text>元の世界</Text>
    <Portal containerRef={containerRef}>
      <Text>ナツキ・スバル</Text>
    </Portal>
    <Box ref={containerRef} p="md" bg="bg.contrast" color="fg.contrast">
      <Text>エミリアたん</Text>
    </Box>
  </VStack>
)
```

### Disable portaling

To disable forwarding, set `disabled` to `true`.

```tsx
<>
  <Text>元の世界</Text>
  <Portal disabled>
    <Text>ナツキ・スバル</Text>
  </Portal>
</>
```

## Props

| Prop           | Default | Type                             | Description                                                      |
| -------------- | ------- | -------------------------------- | ---------------------------------------------------------------- |
| `containerRef` | -       | `RefObject<HTMLElement \| null>` | The `ref` to the component where the portal will be attached to. |
| `disabled`     | -       | `boolean`                        | If `true`, the forwarding will be disabled.                      |