Skip to content

feat: update markup and documentation for breadcrumbs #66

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

Merged
merged 2 commits into from
Aug 28, 2024
Merged

feat: update markup and documentation for breadcrumbs #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85a0720
feat: update markup and documentation for breadcrumbs
EllenWiderstrand Aug 28, 2024
f7161bd
fix: use ol instead of ul
EllenWiderstrand Aug 28, 2024
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ registerBreadcrumbHelper()

// Add breadcrumbs to res.render
res.render(breadcrumbsPath: [{url: 'https://kth.se', label: 'KTH'}, ...], ...)

// Import the needed css from @kth/style
@use '@kth/style/scss/components/breadcrumbs.scss';
```

## Language Link Helper
Expand Down
12 changes: 6 additions & 6 deletions lib/handlebars/helpers/__snapshots__/breadcrumbs.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

exports[`getBreadcrumbsMarkup should generate breadcrumbs HTML for a valid path list in English 1`] = `
"
<nav id="breadcrumbs" aria-label="Breadcrumbs" class="col-12 col-md-9">
<ol class="breadcrumb">
<li class="breadcrumb-item"><a href="/">Kth</a></li><li class="breadcrumb-item"><a href="/test1">Test 1</a></li><li class="breadcrumb-item"><a href="/test2">Test 2</a></li>
<nav id="breadcrumbs" aria-label="Breadcrumbs" class="kth-breadcrumbs">
<ol class="kth-breadcrumbs__list">
<li><a href="/">Kth</a></li><li><a href="/test1">Test 1</a></li><li><a href="/test2">Test 2</a></li>
</ol>
</nav>
"
`;

exports[`getBreadcrumbsMarkup should generate breadcrumbs HTML for a valid path list in Swedish 1`] = `
"
<nav id="breadcrumbs" aria-label="Brödsmulor" class="col-12 col-md-9">
<ol class="breadcrumb">
<li class="breadcrumb-item"><a href="/">Kth</a></li><li class="breadcrumb-item"><a href="/test1">Test 1</a></li><li class="breadcrumb-item"><a href="/test2">Test 2</a></li>
<nav id="breadcrumbs" aria-label="Brödsmulor" class="kth-breadcrumbs">
<ol class="kth-breadcrumbs__list">
<li><a href="/">Kth</a></li><li><a href="/test1">Test 1</a></li><li><a href="/test2">Test 2</a></li>
</ol>
</nav>
"
Expand Down
6 changes: 3 additions & 3 deletions lib/handlebars/helpers/breadcrumbs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ function getBreadcrumbsMarkup(pathList, lang) {
const ariaLabel = /^sv/.test(lang) ? 'Brödsmulor' : 'Breadcrumbs'

const output = `
<nav id="breadcrumbs" aria-label="${ariaLabel}" class="col-12 col-md-9">
<ol class="breadcrumb">
${listItems.reduce((items, item) => items + `<li class="breadcrumb-item">${item}</li>`, '')}
<nav id="breadcrumbs" aria-label="${ariaLabel}" class="kth-breadcrumbs">
<ol class="kth-breadcrumbs__list">
${listItems.reduce((items, item) => items + `<li>${item}</li>`, '')}
</ol>
</nav>
`.replace(/,/g, '')
Expand Down