jbmui

PaperTape

  • UI Bits
  • adjustable

Strip of paper fed out by length, with printed marks, checkpoint markers, and attachments on one coordinate system.

revisar
12 de 30 rutas

Install

npx shadcn@latest add @jbm/paper-tape

Needs the @jbm entry in components.json; see Install once.

Also installs @jbm/tokens, @jbm/paper, @jbm/tape-marker.

Docs

Usage

Tape with a checkpoint
import { PaperTape, paperAt } from "@/jbm/ui/paper-tape"<PaperTape length={700} window={320} markers={[{ id: "review", at: 520, label: "revisar" }]} />// paperAt(700, 520) === 180: marks and attachments share this origin.
Feed from a Remotion timeline
import { PaperTape } from "@/jbm/ui/paper-tape"import { useProgress } from "@/jbm/motion/hooks" // install @jbm/motion-hooks separately// Render inside a Remotion <Composition> or <Player>: hooks run in the component body.export function FeedingTape() {  const feed = useProgress(0.2, 1000, 4)  return <PaperTape length={feed} window={280} direction="vertical" markers={[{ id: "stop", at: 520 }]} />}

API

Stage px
Declared at the documented defaults
Landscape
400 by 198
Vertical
400 by 198
Basis

Horizontal default: width = window (400), height = thickness + 150 (48 + 150); the strip sits 48px from the top to leave room for markers and labels. direction="vertical" gives width thickness + 180 (228) by height window (400). maxWidth is 100% of the container. Stage orientation does not change the box.

PaperTapecomponent

A card strip with an ink edge and paper shadow that grows from the source as length increases. Paired ink dashes are printed every 72 paper px, and markers and attachments ride on the same paper coordinates, so feeding the tape moves them together. Only marks, markers, and attachments inside the visible window render; the viewport clips at its bounds.

PropTypeDefaultDescription
lengthnumberrequiredPaper fed out so far, in stage px. Increase it to feed the tape; negative or non-finite values count as 0.
windownumber400Visible run in stage px; also the component's width (horizontal) or height (vertical).
thicknessnumber48Strip thickness in stage px; minimum 16.
direction"horizontal" | "vertical""horizontal"horizontal feeds along x; vertical feeds along y and turns markers 90°.
markers{ id: string; at: number; label?: string }[][]Checkpoint TapeMarkers placed at paper coordinate at (0 = start of the paper). id must be unique within the tape; label shows above the marker.
attachmentsTapeAttachment[][]Arbitrary React content pinned at paper coordinate at, below the strip (horizontal) or beside it (vertical). IDs must be unique across markers and attachments.
styleCSSPropertiesnoneInline styles merged last onto the outer viewport, e.g. width or overflow.

paperAtfunction

Converts a paper coordinate to its screen distance from the tape's origin; markers, attachments, and printed marks all use it.

ParamTypeDefaultDescription
lengthnumberrequiredPaper fed out so far, as passed to PaperTape.
coordinatenumberrequiredPosition on the paper, measured from the start of the paper.

Returns Screen offset in stage px: length − coordinate (length clamped to ≥ 0). Values within the window are visible.

QA checks

  • Drag Feed from 0 to 1: the strip grows from zero, printed dashes, the marker, and the note move together, and nothing appears before its coordinate is fed out.
  • Toggle Vertical tape: markers rotate 90° and attachments sit beside the strip; check both directions at narrow widths.
  • Toggle Checkpoint marker: the tape and note do not move.
  • Try a very long length: only the visible dashes render and content past the window is clipped at the edge.