component

Signpost

A wooden post-and-plank signboard carrying a name in the world's display font; the post sits behind the board so the text reads clean.

⌖ Explore the library in 3D →

Add it

npx @runek/cli add signpost

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

Use it

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

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

Props

export interface SignpostProps extends WorldComponentProps {
  /**
   * The name shown on the board. A plain string, **not** `children`: a world renderer overrides a
   * node's `children` prop with its nested nodes, so text authored in JSON must be a named prop to
   * survive. Empty by default — `<Signpost />` is a blank board.
   */
  name?: string
  /** Post height, in units. */
  height?: number
  /** Board width, in units. */
  width?: number
  /** Post + board wood color; defaults to the palette's `wood`. */
  color?: string
  /** Name color; defaults to the palette's `sand` (legible on the wood). */
  textColor?: string
  /** Name cap height, in units. */
  size?: number
}

Registry manifest

Browse the whole catalog in the gallery →.