Skip to content

feat: add breadcrumb component #5424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

feat: add breadcrumb component #5424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3abe49d
feat: add DBBreadcrumb component with documentation and examples for …
sarahbrng Nov 7, 2025
7027bea
feat: enhance DBBreadcrumb with vertical centering and className sup…
sarahbrng Nov 7, 2025
d2a2684
feat: add separator prop to DBBreadcrumb component with support for c…
sarahbrng Nov 7, 2025
346b8c1
style(breadcrumb): apply stylelint --fix to breadcrumb.scss
sarahbrng Nov 7, 2025
eef67c0
fix: correct import path for Breadcrumb component in navigation-items.ts
sarahbrng Nov 7, 2025
a1fa7a5
fix: update import path for breadcrumb styles in HTML documentation
sarahbrng Nov 7, 2025
6ea38b3
fix: update import statement for breadcrumb styles in HTML documentation
sarahbrng Nov 7, 2025
95622a2
auto update snapshots (#5426)
github-actions[bot] Nov 7, 2025
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
Binary file added ...pshots__/breadcrumb/component/chromium/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...apshots__/breadcrumb/component/firefox/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...s__/breadcrumb/component/mobile-chrome/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...DBBreadcrumb-should-match-screenshot-1/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions ...hContrast/should-have-same-aria-snapshot/DBBreadcrumb-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- main:
- heading "DBBreadcrumb" [level=1]
- link "Size"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- link "Separator"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: /
- link "Category"
- listitem: / Current Page
Binary file added ...DBBreadcrumb-should-match-screenshot-1/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions .../chromium/should-have-same-aria-snapshot/DBBreadcrumb-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- main:
- heading "DBBreadcrumb" [level=1]
- link "Size"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- link "Separator"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: /
- link "Category"
- listitem: / Current Page
Binary file added ...DBBreadcrumb-should-match-screenshot-1/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions ...e/firefox/should-have-same-aria-snapshot/DBBreadcrumb-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- main:
- heading "DBBreadcrumb" [level=1]
- link "Size"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- link "Separator"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: /
- link "Category"
- listitem: / Current Page
Binary file added ...DBBreadcrumb-should-match-screenshot-1/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions ...le-chrome/should-have-same-aria-snapshot/DBBreadcrumb-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- main:
- heading "DBBreadcrumb" [level=1]
- link "Size"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- link "Separator"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: /
- link "Category"
- listitem: / Current Page
Binary file added ...DBBreadcrumb-should-match-screenshot-1/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions ...le-safari/should-have-same-aria-snapshot/DBBreadcrumb-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- main:
- heading "DBBreadcrumb" [level=1]
- link "Size"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- link "Separator"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: /
- link "Category"
- listitem: / Current Page
Binary file added ...DBBreadcrumb-should-match-screenshot-1/DBBreadcrumb-should-match-screenshot.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions ...se/webkit/should-have-same-aria-snapshot/DBBreadcrumb-should-have-same-aria-snapshot.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- main:
- heading "DBBreadcrumb" [level=1]
- link "Size"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- link "Separator"
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: ›
- link "Category"
- listitem: › Current Page
- navigation "breadcrumb":
- list:
- listitem:
- link "Home"
- listitem:
- text: /
- link "Category"
- listitem: / Current Page
3 changes: 3 additions & 0 deletions packages/components/scripts/post-build/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,9 @@ export const getComponents = (): Component[] => [
{
name: 'brand'
},
{
name: 'breadcrumb'
},
{
name: 'input',
overwrites: {
Expand Down
42 changes: 42 additions & 0 deletions packages/components/src/components/breadcrumb/agent/breadcrumb.agent.lite.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { DBBreadcrumb } from '../index';

export default function Breadcrumb() {
return (
<>
<h1>DBBreadcrumb Documentation Examples</h1>

<h2>1. Default Breadcrumb</h2>
<DBBreadcrumb>
<li>
<a href="#">Home</a>
</li>
<li>
<a href="#">Category</a>
</li>
<li aria-current="page">Current Page</li>
</DBBreadcrumb>

<h2>2. Long Breadcrumb Path</h2>
<DBBreadcrumb>
<li>
<a href="#">Home</a>
</li>
<li>
<a href="#">Category</a>
</li>
<li>
<a href="#">Subcategory</a>
</li>
<li>
<a href="#">Product Group</a>
</li>
<li aria-current="page">Current Product</li>
</DBBreadcrumb>

<h2>3. Single Item</h2>
<DBBreadcrumb>
<li aria-current="page">Current Page</li>
</DBBreadcrumb>
</>
);
}
35 changes: 35 additions & 0 deletions packages/components/src/components/breadcrumb/breadcrumb.lite.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import {
useDefaultProps,
useMetadata,
useRef,
useStore
} from '@builder.io/mitosis';
import { cls } from '../../utils';
import type { DBBreadcrumbProps, DBBreadcrumbState } from './model';

useMetadata({});

useDefaultProps<DBBreadcrumbProps>({
size: 'small',
separator: 'chevron'
});

export default function DBBreadcrumb(props: DBBreadcrumbProps) {
const _ref = useRef<HTMLElement | any>(null);

const state = useStore<DBBreadcrumbState>({});

return (
<nav
ref={_ref}
id={props.id}
class={cls('db-breadcrumb', props.className)}
data-size={props.size}
data-separator={props.separator}
aria-label="breadcrumb">
<ol class="db-breadcrumb-list" role="list">
{props.children}
</ol>
</nav>
);
}
Loading
Loading