Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .storybook/withDarkMode.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ export const withDarkMode: Decorator = (Story) => {

// Use useLayoutEffect to apply changes BEFORE paint (prevents flicker)
useLayoutEffect(() => {
// Set background colors (the addon handles the 'dark' class automatically)
// Set background colors before applying the wrapper-level dark class below.
const bg = isDark ? '#060C13' : '#f4f5f7';
document.documentElement.style.background = bg;
document.body.style.background = bg;
}, [isDark]);

return (
<div
className='flex flex-row justify-center items-center w-full transition-colors duration-300 p-12'
className={`flex flex-row justify-center items-center w-full transition-colors duration-300 p-12 ${isDark ? 'dark' : ''}`}
style={{
Comment thread
egdev6 marked this conversation as resolved.
minHeight: 'fit-content',
background: isDark
Expand Down
119 changes: 119 additions & 0 deletions src/components/molecules/breadcrumb/Breadcrumb.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
import type { Meta, StoryObj } from '@storybook/react';
import { DynamicIcon } from 'lucide-react/dynamic.js';
import Breadcrumb from './Breadcrumb';
import type { BreadcrumbItem } from './types';

/**
* ## Description
* Breadcrumb displays the current navigation path and keeps the current page non-interactive.
* Link hover stays on each item, while collapsed items use an accessible trigger.
*/
const meta: Meta<typeof Breadcrumb> = {
title: 'Molecules/Breadcrumb',
component: Breadcrumb,
parameters: {
docs: {
autodocs: true
}
},
tags: ['autodocs']
};

export default meta;

type Story = StoryObj<typeof Breadcrumb>;

const items: BreadcrumbItem[] = [
{ title: 'Home', href: '/' },
{ title: 'Components', href: '/components' },
{ title: 'Breadcrumb', href: '/components/breadcrumb' }
];

const itemsWithContent: BreadcrumbItem[] = [
{ title: 'Home', href: '/', startContent: 'house' },
{ title: 'Library', href: '/library', endContent: 'chevron-right' },
{
title: 'Documentation',
href: '/docs',
startContent: <DynamicIcon name='folder-open' size={14} aria-hidden='true' />,
endContent: <DynamicIcon name='external-link' size={14} aria-hidden='true' />
},
{ title: 'Breadcrumb' }
];

const collapsedItems: BreadcrumbItem[] = [
{ title: 'Home', href: '/' },
{ title: 'Library', href: '/library' },
{ title: 'Components', href: '/components' },
{ title: 'Navigation', href: '/components/navigation' },
{ title: 'Breadcrumb' }
];

/**
* Default breadcrumb with the transparent, borderless container style.
*/
export const Default: Story = {
args: {
items
}
};

/**
* Size variants for the breadcrumb container and current item.
*/
export const Sizes: Story = {
render: () => (
<div className='flex w-fit flex-col gap-3'>
<Breadcrumb items={items} size='sm' />
<Breadcrumb items={items} size='md' />
<Breadcrumb items={items} size='lg' />
</div>
)
};

/**
* Available visual variants for the breadcrumb container.
*/
export const Variants: Story = {
render: () => (
<div className='flex w-fit flex-col gap-3'>
<Breadcrumb items={items} variant='regular' />
<Breadcrumb items={items} variant='bordered' />
<Breadcrumb items={items} variant='underlined' />
<Breadcrumb items={items} variant='line' />
</div>
)
};

/**
* Start and end content stay inside the same clickable breadcrumb item.
*/
export const WithItemContent: Story = {
render: () => (
<Breadcrumb
items={itemsWithContent}
separator={<DynamicIcon name='chevron-right' size={14} aria-hidden='true' />}
/>
)
};

/**
* The last item stays non-interactive even when link styles are customized.
*/
export const CurrentItem: Story = {
render: () => <Breadcrumb items={items} />
};

/**
* Collapsed items use an accessible trigger with tooltip support.
*/
export const Collapsed: Story = {
args: {
items: collapsedItems,
maxItems: 3,
itemsBeforeCollapse: 1,
itemsAfterCollapse: 1,
separator: <DynamicIcon name='chevron-right' size={14} aria-hidden='true' />,
showTooltip: true
}
};
168 changes: 168 additions & 0 deletions src/components/molecules/breadcrumb/Breadcrumb.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
import { render, renderHook, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { describe, expect, it, vi } from 'vitest';

vi.mock('lucide-react/dynamic.js', () => ({
// biome-ignore lint/style/useNamingConvention: must match library export name
DynamicIcon: ({ name, size }: { name: string; size: number }) => (
<svg data-name={name} data-size={String(size)} data-testid='breadcrumb-icon' />
)
}));

import Breadcrumb from './Breadcrumb';
import { Breadcrumb as BreadcrumbFromIndex } from './index';
import type { BreadcrumbItem } from './types';
import { breadcrumbBase } from './types';
import { useBreadcrumb } from './useBreadcrumb';

const items: BreadcrumbItem[] = [
{ title: 'Home', href: '#home' },
{ title: 'Components', href: '#components' },
{ title: 'Navigation', href: '#components-navigation' },
{ title: 'Breadcrumb' }
];

describe('useBreadcrumb — logic', () => {
it('does not collapse when the collapsed trigger would exceed maxItems', () => {
const { result } = renderHook(() =>
useBreadcrumb({
items,
maxItems: 3,
itemsBeforeCollapse: 2,
itemsAfterCollapse: 1
})
);

expect(result.current.processedItems).toHaveLength(items.length);
expect(result.current.processedItems.every((entry) => entry.type === 'item')).toBe(true);
});

it('tracks original indexes across collapsed entries', () => {
const { result } = renderHook(() =>
useBreadcrumb({
items,
maxItems: 3,
itemsBeforeCollapse: 1,
itemsAfterCollapse: 1
})
);

expect(result.current.processedItems).toMatchObject([
{ type: 'item', originalIndex: 0 },
{ type: 'collapsed', hiddenItemIndexes: [1, 2] },
{ type: 'item', originalIndex: 3, isLast: true }
]);
});

it('does not duplicate trailing items when itemsAfterCollapse is zero', () => {
const { result } = renderHook(() =>
useBreadcrumb({
items,
maxItems: 3,
itemsBeforeCollapse: 1,
itemsAfterCollapse: 0
})
);

expect(result.current.processedItems).toMatchObject([
{ type: 'item', originalIndex: 0 },
{ type: 'collapsed', hiddenItemIndexes: [1, 2, 3], isLast: true }
]);
});
});

describe('Breadcrumb — component behavior', () => {
it('is exported from the molecule barrel', () => {
expect(BreadcrumbFromIndex).toBe(Breadcrumb);
});

it('marks the last item as the current page and keeps it non-interactive', () => {
render(<Breadcrumb items={items} />);

expect(screen.getByText('Breadcrumb').closest('[aria-current="page"]')).toBeInTheDocument();
expect(screen.queryByRole('link', { name: 'Breadcrumb' })).not.toBeInTheDocument();
});

it('calls onItemClick with the original index for visible links', async () => {
const user = userEvent.setup();
const handleItemClick = vi.fn();

render(<Breadcrumb items={items} onItemClick={handleItemClick} />);

await user.click(screen.getByRole('link', { name: 'Components' }));

expect(handleItemClick).toHaveBeenCalledWith(items[1], 1);
});

it('calls onItemClick with the original index for hidden collapsed links', async () => {
const user = userEvent.setup();
const handleItemClick = vi.fn();
const duplicatedItems: BreadcrumbItem[] = [
{ title: 'Home', href: '#home' },
{ title: 'Docs', href: '#docs' },
{ title: 'Docs', href: '#docs-api' },
{ title: 'API', href: '#api' },
{ title: 'Current' }
];

render(
<Breadcrumb
items={duplicatedItems}
maxItems={3}
itemsBeforeCollapse={1}
itemsAfterCollapse={1}
onItemClick={handleItemClick}
/>
);

await user.click(screen.getByRole('button', { name: 'Show 3 hidden breadcrumb items' }));

const hiddenLink = screen.getByRole('link', { name: 'API' });
expect(hiddenLink).toHaveClass('min-w-0');
await user.click(hiddenLink);

expect(handleItemClick).toHaveBeenCalledWith(duplicatedItems[3], 3);
});

it('renders string separators as text instead of icon names', () => {
render(<Breadcrumb items={items} separator='→' />);

expect(screen.getAllByText('→')).toHaveLength(3);
expect(screen.queryByTestId('breadcrumb-icon')).not.toBeInTheDocument();
});

it('wraps a custom collapsed element with accessible trigger behavior', async () => {
const user = userEvent.setup();
const handleCollapsedClick = vi.fn();

render(
<Breadcrumb
items={items}
maxItems={3}
itemsBeforeCollapse={1}
itemsAfterCollapse={1}
collapsedElement={<span>More</span>}
onCollapsedClick={handleCollapsedClick}
/>
);

const trigger = screen.getByRole('button', { name: 'Show 2 hidden breadcrumb items' });
await user.click(trigger);

expect(handleCollapsedClick).toHaveBeenCalledWith([items[1], items[2]]);
expect(document.getElementById(trigger.getAttribute('aria-controls') ?? '')).toBeInTheDocument();
});

it('allows breadcrumb labels to shrink before truncating', () => {
render(<Breadcrumb items={items} />);

expect(screen.getByRole('link', { name: 'Components' })).toHaveClass('min-w-0', 'max-w-full');
expect(screen.getByText('Breadcrumb').closest('li')).toHaveClass('min-w-0');
});

it('uses the established design-system classes for sizing and important rounded variants', () => {
expect(breadcrumbBase({ size: 'xs' })).toContain('fs-xs');
expect(breadcrumbBase({ size: 'md' })).toContain('fs-base');
expect(breadcrumbBase({ variant: 'underlined' })).toContain('rounded-none!');
});
});
Loading
Loading