Charcoal UI

Lanyard

A conference badge hanging from a lanyard as a 2D pendulum: a short Verlet chain for the strap, so dragging the badge swings and whips it and it settles under gravity. No physics engine, no three.js.

  • Category: Display
  • Licence: Charcoal UI Pro
  • Built with: React 19, Tailwind CSS 4, Motion
  • Dependencies: motion, clsx, tailwind-merge

Examples

Lanyard

API reference

PropTypeDefaultDescription
namestring—
rolestring—
avatarstring—
eventstring"Charcoal Conf"
strapColorstring"var(--ember)"
gravitynumber1
lengthnumber170Strap length in px.
classNamestring—

About Lanyard

Lanyard hangs a conference badge from a strap as a 2D pendulum: drag the badge and the strap swings and whips, then settles under gravity. No physics engine, no three.js.

Lanyard is a display component for React 19, styled with Tailwind CSS 4 and animated with Motion. It drops into Next.js, Vite, Remix or Astro through the shadcn CLI as a single file you own.

When to use Lanyard

  • Conference and event sites.
  • Developer portfolios.
  • Team pages.
  • Ticket confirmation pages.

How it works

The strap is a short Verlet chain with distance constraints, drawn as an SVG path through its points. gravity and strapColor are props.

Interactive parts are buttons or links with accessible names, decorative layers are hidden from assistive tech, and everything is reachable by keyboard. With prefers-reduced-motion on, it holds still or settles instantly instead of animating.

Customizing Lanyard

Every prop is documented in the API reference above with its type and default. The ones you will reach for first are listed here.

The Customize panel next to the preview lets you change name, role, strapColor, gravity live, and the Code tab updates to match, so the snippet you copy already carries your values.

  • name (string).
  • role (string).
  • avatar (string).
  • event (string, default "Charcoal Conf").
  • strapColor (string, default "var(--ember)").
  • gravity (number, default 1).

Goes well with Lanyard

These display pieces share its tokens and motion language, so they sit together on one page without clashing.

  • Tilt Card: A 3D tilt card for React that leans toward the pointer with a moving glare
  • Spotlight Card: A React spotlight card: an accent glow follows the pointer across card and border
  • Sortable List: A drag-to-reorder React list with lifted shadows and keyboard sorting
  • Card Stack: A swipeable React card stack where the next card rises to meet you
  • Image Compare: A React before and after image comparison slider you can drag anywhere

Install Lanyard

npx shadcn@latest add @charcoal/lanyard

Lanyard is part of Charcoal UI Pro. One seat unlocks all 300 Pro components, 107 landing-page sections and 100 full templates, for every personal and client project, with updates included. Add the @charcoal registry once with your access token, then the command above copies lanyard.tsx into components/ui and installs clsx, tailwind-merge.

You own the file you install: no runtime package, no lock-in, nothing to keep in sync. Change it however your product needs.

See Charcoal UI Pro pricing · Pro setup

Frequently asked questions

Does lanyard need a physics library?
No. The strap is a short Verlet chain written in the file, so there is no three.js and no physics engine to install.
How do I install Lanyard?
Lanyard is part of Charcoal UI Pro. Add the @charcoal registry to components.json with your access token, then run npx shadcn@latest add @charcoal/lanyard. It copies lanyard.tsx into components/ui and installs motion, clsx, tailwind-merge.
Is Lanyard free for commercial use?
Lanyard needs a Charcoal UI Pro seat, monthly or a one-time lifetime price. A seat covers unlimited personal and commercial projects, including client work, and every future Pro component.
Does Lanyard work with Next.js?
Yes. It is a client component for React 19 styled with Tailwind CSS 4, so it works in the Next.js App Router and Pages Router, Vite, Remix and Astro.
Can an AI coding agent install Lanyard?
Yes. Connect the Charcoal UI MCP server (https://charcoalui.com/mcp) to Claude Code, Cursor or any MCP client; get_component returns Lanyard's props and get_install_command returns the exact command.

Lanyard as Markdown · llms.txt