# Shelf

> Wall shelf with planks.

## Add it

```bash
npx @runek/cli add shelf
```

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

## Use it

```tsx
import { Shelf } from './runek/Shelf'

<Shelf position={[0, 0, 0]} />
```

Or as a node in a world file ([worlds as data](https://runek.nullorder.org/docs/worlds-as-data.md)):

```json
{ "type": "Shelf", "props": { "position": [0, 0, 0] } }
```

## Props

| Prop | Type | Default | Description |
|---|---|---|---|
| `position` | `[x, y, z]` | `[0, 0, 0]` | Position [x, y, z] in units (1 unit = 1 m, Y-up). |
| `rotation` | `[x, y, z]` | `[0, 0, 0]` | Euler rotation [x, y, z] in radians. |
| `seed` | `number` |  | Accepted for the component contract; this component has no seeded variation yet. |
| `width` | `number` | `1` | Width, in units. |
| `height` | `number` | `1.8` | Height, in units. |
| `depth` | `number` | `0.3` | Depth, in units. |
| `shelves` | `number` | `4` |  |
| `color` | `color` | palette `wood` | Defaults to the world palette's `wood` slot. |

## Registry manifest

[https://runek.nullorder.org/r/components/shelf.json](https://runek.nullorder.org/r/components/shelf.json): Self-contained JSON: inlined source plus resolved dependencies, exactly what `runek add shelf` fetches.

Browse the whole catalog in the **[gallery →](https://runek.nullorder.org/gallery)**.