Glass Pane

The primitive every component is made of. Put anything on a pane of glass.

Now boarding

Gate 21 · Flight LU 108 to Lisbon

Installation#

GlassPane comes with every component, as part of the glass engine. To install it on its own:

npx shadcn@latest add @liquikit/glass

Usage#

import { GlassPane } from "@/components/liquikit/glass"
<GlassPane radius={28}>
  <div className="p-5">Now boarding</div>
</GlassPane>

The pane sizes itself to its content and redraws its lens when that size changes.

Examples#

Variants and tint#

regular glass is frosted with a tinted body, for text that must stay readable. clear glass has almost no body, so the refraction shows most. tint and tintOpacity colour the body.

Regular

Clear

Tinted

Always bending#

Glass bends the page only while you use it, and rests as frosted glass with baked light. Set refraction="always" to keep a pane bending, such as a single card over a photo. Keep it to a few pieces: each one carries a filter while it is on screen.

<GlassPane radius={28} refraction="always">
  <div className="p-5">Now boarding</div>
</GlassPane>

Glass Scope#

The glass bends the content of the scope around it rather than the page as a whole. Wrap the area in a GlassScope, pass the background as backdrop, and put the content inside as children.

import { GlassScope } from "@/components/liquikit/glass"
<GlassScope
  backdrop={<img src="/photo.jpg" alt="" className="size-full object-cover" />}
  className="p-8"
>
  <GlassPane radius={28}>
    <div className="p-5">Now boarding</div>
  </GlassPane>
</GlassScope>

API Reference#

GlassPane

PropTypeDefault
radiusnumber | "capsule"

Corner radius in pixels, or capsule for fully round ends.

"capsule"
variant"regular" | "clear"

regular is frosted with a tinted body. clear is nearly transparent, so the refraction shows most.

"regular"
tintstring

Colour of the body. Defaults to white in light and a dark grey in dark.

—
tintOpacitynumber

Opacity of the body, from 0 to 1. Overrides the variant.

—
lensPartial<LensProfile>

Overrides for the lens profile, such as thickness, bevel, ior and magnification.

—
theme"light" | "dark"

Light or dark glass. Falls back to the nearest GlassThemeProvider, then light.

—
refraction"interactive" | "always"

When the glass bends the page. interactive bends it while the component is pressed, dragged or focused, always bends it all the time.

"interactive"
pressMotionValue<number>

A motion value from 0 to 1. At 1 the pane swells and brightens, as if pressed.

—
liquidnumber

How far the glass squashes and stretches as it moves. 0 keeps it rigid.

0.6
frostMotionValue<number>

A motion value from 0 to 1 that fades the frost and the body, leaving clear glass.

—
shapeGlassPaneShape

Motion values for the lens's centre, size and radius, when it should move inside the pane.

—
reachGlassPaneReach

Extra room around the pane the lens may grow into, per side.

—
childrenReactNode

The content.

—

GlassScope

PropTypeDefault
backdropReactNode

The background of this area, drawn behind the content. Glass in the scope bends a copy of it.

—
refractionGlassScopeRefraction

What glass in the scope bends. content runs the lens filter on the scope's own content, so a control bends its real track and a pane whatever is under it, in every browser; the filter covers the whole scope, so it suits a scope around a few components. backdrop bends a lens-sized copy of the backdrop under each lens instead, which costs the same however large the scope is, and bends nothing else.

"content"
bleednumber

With content, how far past the scope's edge a lens is still bent, in pixels. A control at the edge then bends to its outline rather than stopping at the scope's box.

40
childrenReactNode

The content.

—

GlassThemeProvider

PropTypeDefault
theme*"light" | "dark"

The theme for every glass component inside it.

—
childrenReactNode

The content.

—