Skip to content
Open
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
Comment thread
dmytrokirpa marked this conversation as resolved.
"type": "patch",
"comment": "fix: make BreadcrumbButtonBaseProps distribute over the ARIA button union so the anchor arm's href stays assignable",
"packageName": "@fluentui/react-breadcrumb",
"email": "array.knight@gmail.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type { ButtonSlots } from '@fluentui/react-button';
import type { ButtonState } from '@fluentui/react-button';
import type { ComponentProps } from '@fluentui/react-utilities';
import type { ComponentState } from '@fluentui/react-utilities';
import type { DistributiveOmit } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import * as React_2 from 'react';
Expand All @@ -29,7 +30,7 @@ export type BreadcrumbBaseState = Omit<BreadcrumbState, 'size'>;
export const BreadcrumbButton: ForwardRefComponent<BreadcrumbButtonProps>;

// @public (undocumented)
export type BreadcrumbButtonBaseProps = Omit<BreadcrumbButtonProps, 'size'>;
export type BreadcrumbButtonBaseProps = DistributiveOmit<BreadcrumbButtonProps, 'size'>;

// @public (undocumented)
export type BreadcrumbButtonBaseState = Omit<BreadcrumbButtonState, 'appearance' | 'size' | 'shape'>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import * as React from 'react';
import { render } from '@testing-library/react';
import { render, renderHook } from '@testing-library/react';
import { BreadcrumbButton } from './BreadcrumbButton';
import { useBreadcrumbButtonBase_unstable } from './useBreadcrumbButton';
import type { BreadcrumbButtonProps } from './BreadcrumbButton.types';
import { isConformant } from '../../testing/isConformant';
import { breadcrumbButtonClassNames } from './useBreadcrumbButtonStyles.styles';
Expand Down Expand Up @@ -67,4 +68,32 @@ describe('BreadcrumbButton', () => {
</div>
`);
});

// Regression test for https://github.com/microsoft/fluentui/issues/36645: a plain `Omit`
// collapsed the distributive ARIA button union, so the anchor arm's `href` was not assignable.
// Type-check runs against tests, so this covers the base hook and the types together.
it('accepts the anchor arm of the ARIA button union in the base hook', () => {
const { result } = renderHook(() =>
useBreadcrumbButtonBase_unstable({ as: 'a', href: '/somewhere' }, React.createRef<HTMLAnchorElement>()),
);

// `components.root` stays 'button' (the slot's declared default); the anchor arm resolves
// through the slot props, where useARIAButtonProps carries `as: 'a'` to the render layer.
expect(result.current).toMatchObject({
root: { as: 'a', href: '/somewhere' },
});
});

// Regression test for the controlType operator-precedence bug: `as ?? href ? 'a' : 'button'`
// parses as `(as ?? href) ? 'a' : 'button'`, so an explicit `as: 'button'` (truthy) computed
// controlType 'a' and the ARIA button pipeline emitted the anchor arm (`as: 'a'`, role="button")
// for a caller who asked for a real <button>.
it('keeps an explicit as="button" on the button arm of the base hook', () => {
const { result } = renderHook(() =>
useBreadcrumbButtonBase_unstable({ as: 'button' }, React.createRef<HTMLButtonElement>()),
);

expect(result.current.root.as).toBe('button');
expect(result.current.root.role).toBeUndefined();
});
});
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ComponentProps, ComponentState } from '@fluentui/react-utilities';
import type { ComponentProps, ComponentState, DistributiveOmit } from '@fluentui/react-utilities';
import type { ButtonProps, ButtonSlots, ButtonState } from '@fluentui/react-button';
import type { BreadcrumbProps } from '../Breadcrumb/Breadcrumb.types';

Expand All @@ -25,6 +25,6 @@ export type BreadcrumbButtonState = ComponentState<BreadcrumbButtonSlots> &
Omit<ButtonState, keyof ButtonSlots | 'components'> &
Required<Pick<BreadcrumbButtonProps, 'current' | 'size'>>;

export type BreadcrumbButtonBaseProps = Omit<BreadcrumbButtonProps, 'size'>;
export type BreadcrumbButtonBaseProps = DistributiveOmit<BreadcrumbButtonProps, 'size'>;
Comment thread
dmytrokirpa marked this conversation as resolved.

export type BreadcrumbButtonBaseState = Omit<BreadcrumbButtonState, 'appearance' | 'size' | 'shape'>;
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export const useBreadcrumbButtonBase_unstable = (
): BreadcrumbButtonBaseState => {
const { current = false, as, ...rest } = props;

const controlType = as ?? (props as ARIAButtonProps<'a'>).href ? 'a' : 'button';
const controlType = as ?? ((props as ARIAButtonProps<'a'>).href ? 'a' : 'button');

const buttonState = useButtonBase_unstable(
{
Expand Down
Loading