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

feat(breadcrumb): sm size #18665

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

feat(breadcrumb): sm size #18665

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
0f02c2e
feat(breadcrumb): sm size
ariellalgilmore Feb 21, 2025
ba6704d
fix(push): error
ariellalgilmore Feb 24, 2025
df83a65
fix(comments): update
ariellalgilmore Feb 24, 2025
3addda2
fix(breadcrumb): story revert
ariellalgilmore Feb 24, 2025
6574597
Merge branch 'main' into feat/breadcrumb-sm
Gururajj77 Feb 25, 2025
aea1deb
Update packages/react/src/components/Breadcrumb/__tests__/Breadcrumb-…
ariellalgilmore Feb 25, 2025
5c4bccb
fix(breadcrumb): tests
ariellalgilmore Feb 26, 2025
acce2eb
Merge branch 'main' into feat/breadcrumb-sm
ariellalgilmore Feb 26, 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
16 changes: 16 additions & 0 deletions e2e/components/Breadcrumb/Breadcrumb-test.e2e.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,22 @@ test.describe('breadcrumb', () => {
theme,
});
});

test('breadcrumb size sm with overflow menu @vrt', async ({ page }) => {
await visitStory(page, {
component: 'breadcrumb',
story: 'breadcrumb-with-overflow-menu',
theme,
args: {
size: 'sm',
},
});
await snapshot(page, {
component: 'breadcrumb',
story: 'breadcrumb-with-overflow-menu',
theme,
});
});
});
});
});
9 changes: 9 additions & 0 deletions packages/react/__tests__/__snapshots__/PublicAPI-test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,15 @@ Map {
"noTrailingSlash": Object {
"type": "bool",
},
"size": Object {
"args": Array [
Array [
"sm",
"md",
],
],
"type": "oneOf",
},
},
"render": [Function],
},
Expand Down
10 changes: 9 additions & 1 deletion packages/react/src/components/Breadcrumb/Breadcrumb.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ const sharedArgTypes = {
disable: true,
},
},
size: {
options: ['sm', 'md'],
control: { type: 'select' },
},
};

export const Default = (args) => (
Expand All @@ -50,14 +54,18 @@ Default.argTypes = {
...sharedArgTypes,
};

Default.argTypes = {
...sharedArgTypes,
};

export const BreadcrumbWithOverflowMenu = (args) => (
<Breadcrumb noTrailingSlash {...args}>
<BreadcrumbItem>
<a href="/#">Breadcrumb 1</a>
</BreadcrumbItem>
<BreadcrumbItem href="#">Breadcrumb 2</BreadcrumbItem>
<BreadcrumbItem data-floating-menu-container>
<OverflowMenu aria-label="Overflow menu in a breadcrumb">
<OverflowMenu align="bottom" aria-label="Overflow menu in a breadcrumb">
<OverflowMenuItem itemText="Breadcrumb 3" />
<OverflowMenuItem itemText="Breadcrumb 4" />
</OverflowMenu>
Expand Down
13 changes: 13 additions & 0 deletions packages/react/src/components/Breadcrumb/Breadcrumb.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ export interface BreadcrumbProps extends React.HTMLAttributes<HTMLElement> {
* Optional prop to omit the trailing slash for the breadcrumbs
*/
noTrailingSlash?: boolean;

/**
* Specify the size of the Breadcrumb. Currently
* supports the following: `sm` & `md` (default: 'md')
*/
size?: 'sm' | 'md';
}

const Breadcrumb: ForwardRefReturn<HTMLElement, BreadcrumbProps> =
Expand All @@ -35,6 +41,7 @@ const Breadcrumb: ForwardRefReturn<HTMLElement, BreadcrumbProps> =
children,
className: customClassNameNav,
noTrailingSlash,
size,
...rest
}: PropsWithChildren<BreadcrumbProps>,
ref: React.Ref<HTMLElement>
Expand All @@ -43,6 +50,7 @@ const Breadcrumb: ForwardRefReturn<HTMLElement, BreadcrumbProps> =
const className = cx({
[`${prefix}--breadcrumb`]: true,
[`${prefix}--breadcrumb--no-trailing-slash`]: noTrailingSlash,
[`${prefix}--breadcrumb--sm`]: size === 'sm',
});

return (
Expand Down Expand Up @@ -77,6 +85,11 @@ Breadcrumb.propTypes = {
* Optional prop to omit the trailing slash for the breadcrumbs
*/
noTrailingSlash: PropTypes.bool,

/**
* Specify the size of the Breadcrumb. Currently supports the following:
*/
size: PropTypes.oneOf(['sm', 'md']),
};

export default Breadcrumb;
6 changes: 6 additions & 0 deletions packages/react/src/components/Breadcrumb/__tests__/Breadcrumb-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ describe('Breadcrumb', () => {
);
});

it('should respect size prop', () => {
render(<Breadcrumb size="sm" />);

expect(screen.getByRole('list')).toHaveClass(`${prefix}--breadcrumb--sm`);
});

it('should accept a `className` for outermost DOM node', () => {
const { container } = render(<Breadcrumb className="test" />);

Expand Down
26 changes: 25 additions & 1 deletion packages/styles/scss/components/breadcrumb/_breadcrumb.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,25 @@
}
}

.#{$prefix}--breadcrumb--sm {
@include type-style('label-01');
}

.#{$prefix}--breadcrumb .#{$prefix}--link {
font: inherit;
}

.#{$prefix}--breadcrumb-item {
position: relative;
display: flex;
align-items: center;
margin-inline-end: $spacing-03;
}

.#{$prefix}--breadcrumb--sm .#{$prefix}--breadcrumb-item {
margin-inline-end: $spacing-02;
}
Comment on lines +48 to +50
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and the other size-related styling is fine as-is but just as a heads up we'll eventually want this component to take advantage of the contextual layout tokens, #13923


.#{$prefix}--breadcrumb-item .#{$prefix}--link:visited {
color: $link-primary;

Expand All @@ -51,6 +63,10 @@
margin-inline-start: $spacing-03;
}

.#{$prefix}--breadcrumb--sm .#{$prefix}--breadcrumb-item::after {
margin-inline-start: $spacing-02;
}

.#{$prefix}--breadcrumb--no-trailing-slash
.#{$prefix}--breadcrumb-item:last-child::after {
content: '';
Expand Down Expand Up @@ -107,6 +123,12 @@
}
}

.#{$prefix}--breadcrumb--sm
.#{$prefix}--breadcrumb-item
.#{$prefix}--overflow-menu {
inline-size: $spacing-05;
}

.#{$prefix}--breadcrumb-item .#{$prefix}--overflow-menu:hover::after {
opacity: 1;
}
Expand All @@ -117,7 +139,9 @@
box-shadow: none;
}

.#{$prefix}--breadcrumb-item .#{$prefix}--overflow-menu__icon {
.#{$prefix}--breadcrumb-item
.#{$prefix}--overflow-menu
.#{$prefix}--overflow-menu__icon {
position: relative;
fill: $link-primary;
transform: translateY(4px);
Expand Down
1 change: 1 addition & 0 deletions packages/styles/scss/components/tooltip/_tooltip.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ $tooltip-padding-inline: custom-property.get-var(

padding: convert.to-rem(8px) convert.to-rem(16px);
max-inline-size: convert.to-rem(176px);
text-wrap: auto;
}
}

Expand Down
17 changes: 17 additions & 0 deletions packages/web-components/src/components/breadcrumb/breadcrumb.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ $css--plex: true !default;
}
}

:host(#{$prefix}-breadcrumb[size='sm']) ::slotted(#{$prefix}-breadcrumb-item) {
margin-inline-end: $spacing-02;

&::after {
margin-inline-start: $spacing-02;
}
}

:host(#{$prefix}-breadcrumb-overflow-menu) {
position: relative;
block-size: rem(18px);
Expand Down Expand Up @@ -70,6 +78,11 @@ $css--plex: true !default;
}
}

:host(#{$prefix}-breadcrumb-item[size='sm'])
::slotted(#{$prefix}-breadcrumb-overflow-menu) {
inline-size: $spacing-05;
}

:host(#{$prefix}-breadcrumb-overflow-menu[open]) {
background: transparent;
box-shadow: none;
Expand All @@ -93,6 +106,10 @@ $css--plex: true !default;
:host(#{$prefix}-breadcrumb-link) {
outline: none;

.#{$prefix}--link {
font: inherit;
}

// Re-define the ruleset so this wins over `.#{$prefix}--link:visited`, etc.
.#{$prefix}--link--disabled {
color: $text-disabled;
Expand Down
74 changes: 47 additions & 27 deletions packages/web-components/src/components/breadcrumb/breadcrumb.stories.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@ import './breadcrumb';
import './breadcrumb-item';
import './breadcrumb-link';
import './breadcrumb-overflow-menu';
import '../overflow-menu/overflow-menu-body';
import '../overflow-menu/index';
import './breadcrumb-skeleton';
import { BREADCRUMB_SIZE } from './defs';

const sizes = {
[`Small size (${BREADCRUMB_SIZE.SMALL})`]: BREADCRUMB_SIZE.SMALL,
[`Medium size (${BREADCRUMB_SIZE.MEDIUM})`]: BREADCRUMB_SIZE.MEDIUM,
};
const args = {
ariaLabel: '',
classes: '',
Expand All @@ -37,6 +42,11 @@ const argTypes = {
description:
'Optional prop to omit the trailing slash for the breadcrumbs.',
},
size: {
control: 'select',
description: 'Specify the size of the Accordion.',
options: sizes,
},
};

export const Default = {
Expand All @@ -61,30 +71,39 @@ export const Default = {
};

export const BreadcrumbWithOverflowMenu = {
render: () => html`
<cds-breadcrumb>
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 1</cds-breadcrumb-link>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 2</cds-breadcrumb-link>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-overflow-menu>
<cds-overflow-menu-body>
<cds-overflow-menu-item>Breadcrumb 3</cds-overflow-menu-item>
<cds-overflow-menu-item>Breadcrumb 4</cds-overflow-menu-item>
</cds-overflow-menu-body>
</cds-breadcrumb-overflow-menu>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 5</cds-breadcrumb-link>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-link>Breadcrumb 6</cds-breadcrumb-link>
</cds-breadcrumb-item>
</cds-breadcrumb>
`,
args,
argTypes,
render: (args) => {
const { ariaLabel, classes, noTrailingSlash, size } = args ?? {};
return html`
<cds-breadcrumb
?no-trailing-slash="${noTrailingSlash}"
class="${classes}"
aria-label="${ariaLabel}"
size="${size}">
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 1</cds-breadcrumb-link>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 2</cds-breadcrumb-link>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-overflow-menu>
<cds-overflow-menu-body>
<cds-overflow-menu-item>Breadcrumb 3</cds-overflow-menu-item>
<cds-overflow-menu-item>Breadcrumb 4</cds-overflow-menu-item>
</cds-overflow-menu-body>
</cds-breadcrumb-overflow-menu>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 5</cds-breadcrumb-link>
</cds-breadcrumb-item>
<cds-breadcrumb-item>
<cds-breadcrumb-link>Breadcrumb 6</cds-breadcrumb-link>
</cds-breadcrumb-item>
</cds-breadcrumb>
`;
},
};

export const Skeleton = {
Expand All @@ -97,12 +116,13 @@ export const Playground = {
args,
argTypes,
render: (args) => {
const { ariaLabel, classes, noTrailingSlash } = args ?? {};
const { ariaLabel, classes, noTrailingSlash, size } = args ?? {};
return html`
<cds-breadcrumb
?no-trailing-slash="${noTrailingSlash}"
class="${classes}"
aria-label="${ariaLabel}">
aria-label="${ariaLabel}"
size="${size}">
<cds-breadcrumb-item>
<cds-breadcrumb-link href="/#">Breadcrumb 1</cds-breadcrumb-link>
</cds-breadcrumb-item>
Expand Down
25 changes: 24 additions & 1 deletion packages/web-components/src/components/breadcrumb/breadcrumb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { classMap } from 'lit/directives/class-map.js';
import { LitElement, html } from 'lit';
import { property } from 'lit/decorators.js';
import { prefix } from '../../globals/settings';
import { BREADCRUMB_SIZE } from './defs';
import styles from './breadcrumb.scss?lit';
import { carbonElement as customElement } from '../../globals/decorators/carbon-element';

Expand All @@ -27,6 +28,27 @@ class CDSBreadcrumb extends LitElement {
@property({ type: Boolean, reflect: true, attribute: 'no-trailing-slash' })
noTrailingSlash = false;

/**
* Specify the size of the Breadcrumb. Currently
* supports the following: `sm` & `md` (default: 'md')
*/
@property()
size = BREADCRUMB_SIZE.MEDIUM;

/**
* Handles `slotchange` event.
*/
private _handleSlotChange({ target }: Event) {
const items = (target as HTMLSlotElement)
.assignedNodes()
.filter(
(node) => node.nodeType !== Node.TEXT_NODE || node!.textContent!.trim()
);
items.forEach((item) => {
(item as HTMLElement).setAttribute('size', this.size);
});
}

connectedCallback() {
if (!this.hasAttribute('role')) {
this.setAttribute('role', 'navigation');
Expand All @@ -38,10 +60,11 @@ class CDSBreadcrumb extends LitElement {
const classes = classMap({
[`${prefix}--breadcrumb`]: true,
[`${prefix}--breadcrumb--no-trailing-slash`]: this.noTrailingSlash,
[`${prefix}--breadcrumb--sm`]: this.size === BREADCRUMB_SIZE.SMALL,
});
return html`
<ol class="${classes}">
<slot></slot>
<slot @slotchange="${this._handleSlotChange}"></slot>
</ol>
`;
}
Expand Down
Loading
Loading