Skip to content
Cojeev UI

Portal Field

Backgrounds

An organically warped luminous halo with a soft chromatic fringe behind real content.

React · copy into your project · light and dark themes

Try it

Loading preview…

Take it with you

Copy the example, API and usage notes for your editor or AI assistant.

Add to your project

Terminal
npx shadcn@latest add https://luv-jeri.github.io/cojeev-ui/r/portal-field.json

The command includes the component’s shared dependencies. Your project keeps editable source files.

Include the complete example

This example also composes button. Install its parts together:

Terminal
npx shadcn@latest add https://luv-jeri.github.io/cojeev-ui/r/button.json https://luv-jeri.github.io/cojeev-ui/r/portal-field.json

Using portal field

  • Compose real content as children; keep essential controls above the decorative field.

  • Choose balanced, warm or cool Cojeev accents and keep a visible pause control for continuous movement.

API

Compose the exported parts below. The prop types are read from the React source during the registry build.

Native element or underlying primitive props are inherited where declared, including accessible labels, event handlers and refs.

PortalFieldProps

PropTypeRequired
tone"balanced"|"warm"|"cool"No
speednumberNo
intensitynumberNo
distortionnumberNo
pausedbooleanNo
interactivebooleanNo
size"sm"|"default"|"lg"No

Accessibility

  • The canvas and static SVG are decorative and hidden from assistive technology; children retain native semantics.

  • Reduced motion, shared motion/flow off, hidden tabs and offscreen stages stop animation. Local pointer response never captures the native cursor or touch scroll.

  • A deterministic static organic halo remains when WebGL is unavailable or lost.

States and appearance

playingpausedstilloffscreenfallbacklost

For conditional content, keep a MotionPresence boundary around keyed MotionSurface children. The shared entrance and exit states work with native primitives and respect your motion preference.

Try pointer and keyboard interaction, and switch the appearance control in the navigation to compare light and dark mode. Motion respects reduced motion preferences.