asafefe.dev

Menu Icon

New

A hamburger that folds into an X. The outer lines meet in the middle, then cross.

motion@soultel/use-reduced-motion-safe@soultel/use-icon-trigger
hover me

Installation

$ pnpm dlx shadcn@latest add @soultel/icon-menu

No namespace set up? npx shadcn@latest add https://asafefe.dev/r/icon-menu.json works too.

Manual installation
  1. 1. Install the dependencies.
    terminal1 lines
    npm install motion
  2. 2. Copy the source from the Code tab into components/icon-menu.tsx.

Usage

example.tsx12 lines
import { useState } from "react"
import { MenuIcon } from "@/components/icon-menu"

export function MenuToggle() {
  const [open, setOpen] = useState(false)

  return (
    <button onClick={() => setOpen(!open)} aria-expanded={open} aria-label="Menu">
      <MenuIcon open={open} />
    </button>
  )
}

Props

PropTypeDefaultDescription
openbooleanfalseShows the X.
sizenumber24Width and height in px.
strokeWidthnumber2Stroke width on the 24 by 24 grid.
animate"hover" | "always" | boolean"hover""hover" plays when the nearest button or link (or the icon) is hovered, focused or tapped. "always" loops. A boolean plays each time it turns true, so a parent can drive it.
labelstring-Accessible name. Without one the icon is aria-hidden.
classNamestring-Classes for the svg. Color comes from currentColor.