Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

5.2 KB
Raw Blame
import { defineDoc } from '@app/features/ui-gallery/types';
import { For } from 'solid-js';
import { Button } from '../components/Button';
import { Layer } from '../components/Layer';
import { Panel } from '../components/Panel';

// #region demo:depths
function DepthsDemo() {
  return (
    <div class="grid w-full grid-cols-1 gap-4 md:grid-cols-3">
      <For each={[0, 1, 2, 3, 4] as const}>
        {(depth) => (
          <Panel depth={depth} class="min-h-28 bg-surface">
            <Panel.Header class="px-3">
              <span class="font-mono text-xs text-ink-subtle">
                depth={depth}
              </span>
            </Panel.Header>
            <Panel.Body class="p-3">
              <p class="text-sm text-ink-muted">Hello!</p>
            </Panel.Body>
          </Panel>
        )}
      </For>
    </div>
  );
}
// #endregion

// #region demo:nesting
function NestingDemo() {
  return (
    <Panel depth={0} class="w-full p-3 bg-surface">
      <p class="mb-2 font-mono text-xs text-ink-subtle">depth 0</p>
      <Panel depth={1} class="p-3 bg-surface">
        <p class="mb-2 font-mono text-xs text-ink-subtle">depth 1</p>
        <Panel depth={2} class="p-3 bg-surface">
          <p class="mb-2 font-mono text-xs text-ink-subtle">depth 2</p>
          <Panel depth={3} class="p-3 bg-surface">
            <p class="font-mono text-xs text-ink-subtle">depth 3</p>
          </Panel>
        </Panel>
      </Panel>
    </Panel>
  );
}
// #endregion

// #region demo:layer-tokens
function LayerTokensDemo() {
  return (
    <div class="grid w-full grid-cols-1 gap-4 md:grid-cols-3">
      <For each={[0, 1, 2] as const}>
        {(depth) => (
          <Panel depth={depth} class="p-3 bg-surface">
            <p class="mb-3 font-mono text-xs text-ink-subtle">depth={depth}</p>
            <div class="flex flex-col gap-2">
              <For each={[-2, -1, 0, 1, 2] as const}>
                {(offset) => (
                  <Layer offset={offset}>
                    <div class="rounded-sm bg-surface p-2 text-xs text-ink-muted">
                      Layer offset={offset > 0 ? `+${offset}` : offset}
                    </div>
                  </Layer>
                )}
              </For>
            </div>
          </Panel>
        )}
      </For>
    </div>
  );
}
// #endregion

// #region demo:controls-on-depth
function ControlsOnDepthDemo() {
  return (
    <div class="grid w-full grid-cols-1 gap-4 md:grid-cols-2">
      <For each={[1, 2, 3, 4] as const}>
        {(depth) => (
          <Panel depth={depth}>
            <Panel.Body class="flex flex-wrap gap-2 p-3">
              <Button variant="ghost">Ghost</Button>
              <Button variant="secondary">Outline</Button>
              <Button variant="primary">Primary</Button>
              <Button variant="danger">Danger</Button>
            </Panel.Body>
          </Panel>
        )}
      </For>
    </div>
  );
}
// #endregion

export default defineDoc({
  name: 'Surfaces & Depth',
  category: 'Foundations',
  description:
    'Depth, not a chosen color, is how backgrounds are set. A container declares its depth and everything inside reads `bg-surface` and `bg-inset` relative to it — so the same component looks right wherever it is nested.',
  exports: ['Layer', 'Surface'],
  import: "import { Layer, Panel, Surface } from '@ui';",
  demos: [
    {
      id: 'depths',
      title: 'The depth scale',
      description:
        'Depth 0 sits furthest back and 4 closest to the viewer. `Panel` and `Surface` take a `depth` prop; `Layer` marks a subtree without rendering a box.',
      render: DepthsDemo,
      fill: true,
      depth: 0,
    },
    {
      id: 'nesting',
      title: 'Nesting',
      description:
        'Each level steps forward, which is what makes nested containers legible without borders doing all the work.',
      render: NestingDemo,
      fill: true,
      depth: 0,
    },
    {
      id: 'layer-tokens',
      title: 'Layer-relative tokens',
      description:
        '`bg-inset` sits one step back and `bg-surface` is the layer itself. To move content forward, wrap it in `Layer offset={1}` and continue using `bg-surface`.',
      render: LayerTokensDemo,
      fill: true,
      depth: 0,
    },
    {
      id: 'controls-on-depth',
      title: 'Controls across depths',
      description:
        'Check any new component here. Contrast that only works at one depth is the most common design-system regression in the app.',
      render: ControlsOnDepthDemo,
      fill: true,
      depth: 0,
    },
  ],
  guidelines: {
    do: [
      'Set `depth` on the container and let children read `bg-surface`.',
      'Use `bg-inset` for wells (inputs and code blocks) and `Layer offset={1}` with `bg-surface` for raised items.',
      'Verify new components at several depths using the toolbar control.',
      'Float menus, popovers, editor panels, and floating toolbars on `menu-surface`; open dialogs with `Dialog`, which owns `elevated-surface`.',
    ],
    dont: [
      'Do not reference `bg-surface-2` and friends directly in a component; that pins it to one depth.',
      'Do not nest more than about three depth steps — past that the steps stop reading.',
      'Do not hand-build an overlay from `bg-menu`, `bg-surface`, a border, and a shadow, or reuse the retired `bg-menu-glass`.',
    ],
  },
});