Skip to content

Portal

Renders children to a dedicated root outside the parent DOM tree. Used by every overlay primitive.

Foundation·Available inReactVueAngular·View as Markdown

Preview

tsx

Children below are rendered into a Portal attached to document.body. Open the element inspector to see them outside this section.

Switch the framework picker (top-right of the panel) to render the same demo live in React, Vue, or Angular — same class names, ARIA, and visual output across all three.

Installation

Sisyphos UI ships unified packages for React, Vue, and Angular. Pick the one that matches your stack — every framework exports the same component classes, ARIA semantics, and CSS tokens.

$ pnpm add @sisyphos-ui/react

Then import the bundled stylesheet once at app entry: import "@sisyphos-ui/react/styles.css";

Usage

Idiomatic usage in each supported framework
import { Portal } from "@sisyphos-ui/react";

export const Floating = () => (
  <Portal>
    <div className="floating">I render at document.body</div>
  </Portal>
);

API

Props table is being written. See the package README for the complete API surface.

The full API including refs, ARIA attributes, and HTML passthroughs lives in the package README on npm.

Need more?View on npm →
Was this page helpful?