component

Dock

A plank jetty on pilings reaching out over water; walkable deck colliders, side stringers, and seaward mooring posts.

⌖ Explore the library in 3D →

Add it

npx @runek/cli add dock

Pulls @react-three/rapier@^2.2.0, @runek/core@^0.13.0.

Use it

import { Dock } from './runek/Dock'

<Dock position={[0, 0, 0]} />

Props

export interface DockProps extends WorldComponentProps {
  /** How far the jetty reaches out from the shore (local +Z), in units. */
  length?: number
  /** Walkway width (local X), in units. */
  width?: number
  /** How deep the pilings sink below the deck surface, in units. */
  depth?: number
  /** Deck color; defaults to the world palette's `wood`. */
  color?: string
}

Registry manifest

Browse the whole catalog in the gallery →.