Skip to content
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

✨ Breadcrumb: custom separator #3142

Merged
merged 5 commits into from
Nov 15, 2023
Merged

✨ Breadcrumb: custom separator #3142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dbde089
✨ added seperator prop
oddvernes Nov 8, 2023
4df7f4d
halve spacing margin for icons
oddvernes Nov 8, 2023
eada3f6
fix typo seperator -> separator
oddvernes Nov 8, 2023
f34ebc2
fix alignment
oddvernes Nov 8, 2023
e1bfc44
make svg inline spacing -9px
oddvernes Nov 15, 2023
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
6 changes: 6 additions & 0 deletions packages/eds-core-react/src/components/Breadcrumbs/Breadcrumbs.docs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ It might be a good idea to use `forceTooltip` on the `Breadcrumbs.Breadcrumb` wh

<Canvas of={ComponentStories.Wrapped} />

### Custom seperator

Seperator can be a character or an `Icon`.

<Canvas of={ComponentStories.CustomSeperator} />

### Third-party routing libraries

Use the `as` prop on `Breadcrumbs.Breadcrumb` to utilize third party routers such as react-router with `Breadcrumbs`
Expand Down
44 changes: 43 additions & 1 deletion packages/eds-core-react/src/components/Breadcrumbs/Breadcrumbs.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Breadcrumbs, BreadcrumbsProps, Checkbox } from '../..'
import { Breadcrumbs, BreadcrumbsProps, Checkbox, Icon } from '../..'
import { chevron_right } from '@equinor/eds-icons'
import { useState, ChangeEvent } from 'react'
import { action } from '@storybook/addon-actions'
import { StoryFn, Meta } from '@storybook/react'
Expand Down Expand Up @@ -155,3 +156,44 @@ export const Wrapped: StoryFn<BreadcrumbsProps> = () => {
</div>
)
}

export const CustomSeperator: StoryFn<BreadcrumbsProps> = () => {
return (
<div style={{ display: 'flex', flexDirection: 'column', gap: '16px' }}>
<Breadcrumbs separator={<Icon data={chevron_right}></Icon>}>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label One
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label Two
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
A really rally long label
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label Four
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label Five
</Breadcrumbs.Breadcrumb>
</Breadcrumbs>
<Breadcrumbs separator="\">
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label One
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label Two
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
A really rally long label
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label Four
</Breadcrumbs.Breadcrumb>
<Breadcrumbs.Breadcrumb href="#" onClick={handleClick}>
Label Five
</Breadcrumbs.Breadcrumb>
</Breadcrumbs>
</div>
)
}
16 changes: 13 additions & 3 deletions packages/eds-core-react/src/components/Breadcrumbs/Breadcrumbs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ const Separator = styled(Typography)`
${spacingsTemplate(spacings)}
display: block;
line-height: 1;
display: flex;
& > svg {
/* Reduce spacing when Icon is used to account for the built in spacing of icons */
margin-inline: -9px;
}
`

const Collapsed = styled(Typography)`
Expand All @@ -52,6 +57,8 @@ export type BreadcrumbsProps = {
* @default false
*/
collapse?: boolean
/** Custom separator can be a character or an Icon */
separator?: ReactNode
/** Will not wrap breadcrumbs when set to false, but will instead trunkate each breadcrumb when viewport narrows
* @default true
*/
Expand All @@ -61,7 +68,10 @@ export type BreadcrumbsProps = {
} & HTMLAttributes<HTMLElement>

export const Breadcrumbs = forwardRef<HTMLElement, BreadcrumbsProps>(
function Breadcrumbs({ children, collapse, wrap = true, ...rest }, ref) {
function Breadcrumbs(
{ children, collapse, wrap = true, separator = '/', ...rest },
ref,
) {
const props = {
...rest,
ref,
Expand Down Expand Up @@ -102,7 +112,7 @@ export const Breadcrumbs = forwardRef<HTMLElement, BreadcrumbsProps>(
</Collapsed>
</ListItem>
<li aria-hidden>
<Separator variant="body_short">/</Separator>
<Separator variant="body_short">{separator}</Separator>
</li>
</Fragment>,
allCrumbs[allCrumbs.length - 1],
Expand All @@ -115,7 +125,7 @@ export const Breadcrumbs = forwardRef<HTMLElement, BreadcrumbsProps>(
<ListItem>{child}</ListItem>
{index !== ReactChildren.toArray(children).length - 1 && (
<li aria-hidden>
<Separator variant="body_short">/</Separator>
<Separator variant="body_short">{separator}</Separator>
</li>
)}
</Fragment>
Expand Down
5 changes: 5 additions & 0 deletions packages/eds-core-react/src/components/Breadcrumbs/__snapshots__/Breadcrumbs.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ exports[`Breadcrumbs Matches snapshot 1`] = `
padding-right: 16px;
display: block;
line-height: 1;
display: flex;
}

.c4>svg {
margin-inline: -9px;
}

.c3 {
Expand Down