Breadcrumb
Jerarquía de navegación clara. Mantener usuarios orientados.
Instalación
Copia y pega el siguiente código en tu proyecto.
1import * as React from 'react';2import { cn } from '../lib/cn';3import { assignRef } from '../lib/overlay';45type IconProps = React.SVGProps<SVGSVGElement> & {6 size?: number | string;7};89function ChevronRightIcon({ size = 24, strokeWidth = 1.5, ...props }: IconProps) {10 return (11 <svg12 xmlns="http://www.w3.org/2000/svg"13 width={size}14 height={size}15 viewBox="0 0 24 24"16 fill="none"17 stroke="currentColor"18 strokeWidth={strokeWidth}19 strokeLinecap="round"20 strokeLinejoin="round"21 aria-hidden="true"22 {...props}23 >24 <path d="m9 6 6 6-6 6" />25 </svg>26 );27}2829function MoreHorizontalIcon({ size = 24, strokeWidth = 1.5, ...props }: IconProps) {30 return (31 <svg32 xmlns="http://www.w3.org/2000/svg"33 width={size}34 height={size}35 viewBox="0 0 24 24"36 fill="none"37 stroke="currentColor"38 strokeWidth={strokeWidth}39 strokeLinecap="round"40 strokeLinejoin="round"41 aria-hidden="true"42 {...props}43 >44 <circle cx="5" cy="12" r="1" />45 <circle cx="12" cy="12" r="1" />46 <circle cx="19" cy="12" r="1" />47 </svg>48 );49}5051type SlotProps = Record<string, unknown> & {52 className?: string;53 style?: React.CSSProperties;54};5556function mergeSlotProps(slotProps: SlotProps, childProps: SlotProps): SlotProps {57 const merged: SlotProps = { ...slotProps, ...childProps };58 for (const key of Object.keys(slotProps)) {59 const slotValue = slotProps[key];60 const childValue = childProps[key];61 if (62 /^on[A-Z]/.test(key) &&63 typeof slotValue === 'function' &&64 typeof childValue === 'function'65 ) {66 merged[key] = (...args: unknown[]) => {67 childValue(...args);68 slotValue(...args);69 };70 }71 }72 if (slotProps.style || childProps.style) {73 merged.style = { ...slotProps.style, ...childProps.style };74 }75 merged.className = cn(slotProps.className, childProps.className);76 return merged;77}7879const BreadcrumbRoot = ({80 className,81 ref,82 ...props83}: React.HTMLAttributes<HTMLElement> & { ref?: React.Ref<HTMLElement> }) => {84 return <nav ref={ref} aria-label="breadcrumb" className={className} {...props} />;85};8687const BreadcrumbList = ({88 className,89 ref,90 ...props91}: React.OlHTMLAttributes<HTMLOListElement> & { ref?: React.Ref<HTMLOListElement> }) => {92 return (93 <ol94 ref={ref}95 className={cn(96 'text-muted-foreground flex flex-wrap items-center gap-1.5 text-sm wrap-break-word sm:gap-2.5',97 className,98 )}99 {...props}100 />101 );102};103104const BreadcrumbItem = ({105 className,106 ref,107 ...props108}: React.LiHTMLAttributes<HTMLLIElement> & { ref?: React.Ref<HTMLLIElement> }) => {109 return <li ref={ref} className={cn('inline-flex items-center gap-1.5', className)} {...props} />;110};111112type BreadcrumbLinkProps = React.AnchorHTMLAttributes<HTMLAnchorElement> & {113 children: React.ReactNode;114};115116const BreadcrumbLink = ({117 className,118 children,119 ref,120 ...props121}: BreadcrumbLinkProps & { ref?: React.Ref<HTMLAnchorElement> }) => {122 const isLinkComponent =123 React.isValidElement(children) &&124 (typeof children.type === 'function' || typeof children.type === 'object');125126 if (isLinkComponent) {127 const childProps = children.props as SlotProps & { ref?: React.Ref<HTMLAnchorElement> };128 const childRef = childProps.ref;129 return React.cloneElement(children as React.ReactElement<SlotProps>, {130 ...mergeSlotProps(131 {132 ...props,133 className: cn(134 'hover:text-foreground focus-visible:ring-ring rounded-sm transition-colors focus-visible:ring-2 focus-visible:outline-none',135 className,136 ),137 },138 childProps,139 ),140 ref:141 ref || childRef142 ? (node: HTMLAnchorElement | null) => {143 assignRef(ref, node);144 assignRef(childRef, node);145 }146 : undefined,147 });148 }149150 return (151 <a152 ref={ref}153 className={cn(154 'hover:text-foreground focus-visible:ring-ring rounded-sm transition-colors focus-visible:ring-2 focus-visible:outline-none',155 className,156 )}157 {...props}158 >159 {children}160 </a>161 );162};163164const BreadcrumbPage = ({165 className,166 ref,167 ...props168}: React.HTMLAttributes<HTMLSpanElement> & { ref?: React.Ref<HTMLSpanElement> }) => {169 return (170 <span171 ref={ref}172 aria-current="page"173 className={cn('text-foreground font-normal', className)}174 {...props}175 />176 );177};178179const BreadcrumbSeparator = ({180 children,181 className,182 ref,183 ...props184}: React.LiHTMLAttributes<HTMLLIElement> & { ref?: React.Ref<HTMLLIElement> }) => {185 return (186 <li187 ref={ref}188 role="presentation"189 aria-hidden="true"190 className={cn('[&>svg]:size-3.5', className)}191 {...props}192 >193 {children ?? <ChevronRightIcon size={14} className="size-3.5" />}194 </li>195 );196};197198type BreadcrumbEllipsisProps = React.HTMLAttributes<HTMLSpanElement> & {199 label?: string;200};201202const BreadcrumbEllipsis = ({203 className,204 label = 'More',205 ref,206 ...props207}: BreadcrumbEllipsisProps & { ref?: React.Ref<HTMLSpanElement> }) => {208 return (209 <span ref={ref} className={cn('flex size-9 items-center justify-center', className)} {...props}>210 <MoreHorizontalIcon className="size-4" size={16} />211 <span className="sr-only">{label}</span>212 </span>213 );214};215216const Breadcrumb = Object.assign(BreadcrumbRoot, {217 List: BreadcrumbList,218 Item: BreadcrumbItem,219 Link: BreadcrumbLink,220 Page: BreadcrumbPage,221 Separator: BreadcrumbSeparator,222 Ellipsis: BreadcrumbEllipsis,223});224225export { Breadcrumb };226export type { BreadcrumbEllipsisProps, BreadcrumbLinkProps };
Actualiza las rutas de importación para que coincidan con la estructura de tu proyecto.
Anatomía
1import { Breadcrumb } from '@/components/breadcrumb';
1<Breadcrumb>2 <Breadcrumb.List>3 <Breadcrumb.Item>4 <Breadcrumb.Link href="/">Inicio</Breadcrumb.Link>5 </Breadcrumb.Item>6 <Breadcrumb.Separator />7 <Breadcrumb.Item>8 <Breadcrumb.Link href="/docs">Documentación</Breadcrumb.Link>9 </Breadcrumb.Item>10 <Breadcrumb.Separator />11 <Breadcrumb.Item>12 <Breadcrumb.Page>Breadcrumb</Breadcrumb.Page>13 </Breadcrumb.Item>14 </Breadcrumb.List>15</Breadcrumb>
Composición
Usa la siguiente composición para construir un
Breadcrumb:Breadcrumb└── Breadcrumb.List├── Breadcrumb.Item│ └── Breadcrumb.Link├── Breadcrumb.Separator└── Breadcrumb.Item└── Breadcrumb.Page
Variantes
Contraído (Collapsed)
1'use client';23import { Breadcrumb } from '@/components/breadcrumb';4import { DropdownMenu } from '@/components/dropdown-menu';56export function Collapsed() {7 return (8 <Breadcrumb>9 <Breadcrumb.List>10 <Breadcrumb.Item>11 <Breadcrumb.Link href="/dashboard">Dashboard</Breadcrumb.Link>12 </Breadcrumb.Item>13 <Breadcrumb.Separator />14 <Breadcrumb.Item>15 <DropdownMenu>16 <DropdownMenu.Trigger className="focus-visible:ring-ring flex items-center gap-1 focus-visible:ring-2 focus-visible:outline-none">17 <Breadcrumb.Ellipsis className="h-4 w-4" />18 <span className="sr-only">Show 2 hidden levels</span>19 </DropdownMenu.Trigger>20 <DropdownMenu.Content align="start">21 <DropdownMenu.Item>Projects</DropdownMenu.Item>22 <DropdownMenu.Item>storefront-api</DropdownMenu.Item>23 </DropdownMenu.Content>24 </DropdownMenu>25 </Breadcrumb.Item>26 <Breadcrumb.Separator />27 <Breadcrumb.Item>28 <Breadcrumb.Link href="/dashboard/projects/storefront-api/deployments">29 Deployments30 </Breadcrumb.Link>31 </Breadcrumb.Item>32 <Breadcrumb.Separator />33 <Breadcrumb.Item>34 <Breadcrumb.Page>dpl_9fk2ax</Breadcrumb.Page>35 </Breadcrumb.Item>36 </Breadcrumb.List>37 </Breadcrumb>38 );39}
Separador personalizado
1import { Fragment } from 'react';23import { Breadcrumb } from '@/components/breadcrumb';45const crumbs = [6 { label: 'acme-studio', href: '/acme-studio' },7 { label: 'storefront-api', href: '/acme-studio/storefront-api' },8 { label: 'Settings', href: '/acme-studio/storefront-api/settings' },9 { label: 'Environment Variables', href: null },10] as const;1112export function CustomSeparator() {13 return (14 <Breadcrumb>15 <Breadcrumb.List>16 {crumbs.map((crumb, index) => (17 <Fragment key={crumb.label}>18 <Breadcrumb.Item>19 {crumb.href ? (20 <Breadcrumb.Link href={crumb.href}>{crumb.label}</Breadcrumb.Link>21 ) : (22 <Breadcrumb.Page>{crumb.label}</Breadcrumb.Page>23 )}24 </Breadcrumb.Item>25 {index < crumbs.length - 1 && (26 <Breadcrumb.Separator>27 <span aria-hidden="true">/</span>28 </Breadcrumb.Separator>29 )}30 </Fragment>31 ))}32 </Breadcrumb.List>33 </Breadcrumb>34 );35}
Referencia de API
Breadcrumb
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
className | string | - | Clases CSS adicionales |
Breadcrumb.List
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
className | string | - | Clases CSS adicionales |
Breadcrumb.Item
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
className | string | - | Clases CSS adicionales |
Breadcrumb.Link
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
href | string | - | URL a la que navegar |
className | string | - | Clases CSS adicionales |
Breadcrumb.Page
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
className | string | - | Clases CSS adicionales |
Breadcrumb.Separator
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
children | ReactNode | Icono de flecha | Elemento separador personalizado |
className | string | - | Clases CSS adicionales |
Breadcrumb.Ellipsis
| Prop | Tipo | Por defecto | Descripción |
|---|---|---|---|
label | string | "More" | Texto que escuchan los lectores de pantalla para los ítems ocultos |
className | string | - | Clases CSS adicionales |
¿Encontraste algo que mejorar?
¿Notaste un error, tipografía o detalle faltante en esta página? Ayúdanos a mejorar la documentación abriendo un issue en GitHub.