Island

Installation#

# One-time setup (tokens + lib helpers)
npx koalaui-cli@latest init

# Activate your Pro license (once per machine)
npx koalaui-cli@latest login <key>

# Add this component (its dependencies come along)
npx koalaui-cli@latest add island

Usage#

Mount it once, in the layout, and drive view from the route. An island that each page renders for itself is a new island on every navigation, so it can only appear, never morph. Pin it yourself, the way you would any floating surface: fixed and centred, so it grows out from its middle, above env(safe-area-inset-bottom) on a phone.

Anatomy#

import {
  Island,
  IslandView,
  IslandSwap,
  IslandButton,
  IslandIcon,
  IslandSeparator,
  IslandTitle,
  IslandProgress,
} from "@/components/ui/island"

<Island view="…">
  <IslandView value="…">
    <IslandButton />
    <IslandIcon />
    <IslandSeparator />
    <IslandSwap view="…">
      <IslandView value="…">
        <IslandTitle />
      </IslandView>
      <IslandView value="…">
        <IslandProgress />
      </IslandView>
    </IslandSwap>
  </IslandView>
</Island>

Variants#

Floating is the default: the elevated popover surface, with the controls resting muted until one of them holds a state. Solid is the inverted slab, the closest thing to the hardware island and the one to reach for over a photograph, a video or a canvas. It flips foreground and background instead of hardcoding black, so it stays legible in all four themes.

Sizes#

size is the island's own density axis, not the page's comfortable/compact knob: a floating control bar that shrinks to form-compact becomes hard to hit. md is the original's 44px pill and lg the touch step. At every size, padding plus half a control is half the pill, so the round controls sit concentric in its ends.

Views#

Declare every state as an IslandView and name the one on screen with view. Only that view is mounted, plus, for one beat, the one leaving. The pill eases to the new width and height while the old contents blur out and the new ones blur in. A view is a row; give it flex-col and the pill grows into a card, its corner easing from half the height to the card's radius on the same clock. IslandIcon holds a status glyph at a control's size, and IslandProgress is the readout and bar for a task that is running.

Swap#

IslandSwap is a region of a view that changes on its own, with the same crossfade and a small morph of its own: the title that gives way to the progress readout once you scroll. Name a view no child answers to and the region empties and collapses to nothing, which is how a “back to top” grows into the pill past the fold and out of it again at the top.

Buttons and menus#

One glyph makes an IslandButton a circle, a word makes it a pill. pressed lights the chip for a toggle that is on, shortcut puts a keycap in the tooltip, and caret turns it into a menu trigger whose caret points at the menu while it is open. Open menus upward, away from the edge the island sits on, and keep the Tooltip outside the trigger so the menu keeps its own hold on the button.

API reference#

FAQ#