Portal

Portal placeholder primitive for future framework-level mounts.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.

TSX

tsximport { Portal } from "@tavojs/ui/portal";

Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/portal.

When to use

Use it when

Use `Portal` as a structural placeholder for future runtime portal support

Choose something else when

Avoid Portal when using feedback components as primary page layout.

Examples

Portal example

TSX

tsximport { Portal } from "@tavojs/ui/portal";

export function PortalExample1() {
  return (
    <>
      <Portal />
    </>
  );
}

Common props and defaults

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`children`	`Child`	—	Configures children for this component.

Complete TypeScript API

Import from @tavojs/ui/portal. Published exports: Portal, PortalProps.

`PortalProps`

Property	Type	Required	Description
`children`	`Child`	No	Configures children for this component.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by Portal.
`id`	`string`	No	Inherited id attribute accepted by Portal.
`role`	`string`	No	Inherited role attribute accepted by Portal.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Portal.
`title`	`string`	No	Inherited title attribute accepted by Portal.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Portal.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Portal.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Portal.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Portal.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Portal.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Portal.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Portal.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Portal.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Portal.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid Portal when using feedback components as primary page layout.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Feedback components should announce status changes and manage focus only when the component owns that behavior.

Use Dialog, Sheet, or FocusTrap for modal workflows.
Use Toast or native live-region semantics for dynamic announcements.
Make dismiss and escape behavior clear for overlays.

Component status

Contract	Current value
Maturity	stable
Category	feedback
Component import	`@tavojs/ui/portal`
Explicit CSS import	`@tavojs/ui/css/portal`
Preview	Interactive preview available on this page