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

fix(react-infobutton): Apply aria-owns only when the popover is open and cleanup infobutton stories #28463

Merged
merged 6 commits into from
Jul 14, 2023
Merged

fix(react-infobutton): Apply aria-owns only when the popover is open and cleanup infobutton stories #28463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
347fcad
fix(react-infobutton): Make InfoLabel only add aria-owns when the pop…
sopranopillow Jul 7, 2023
3713b2b
change file
sopranopillow Jul 7, 2023
2b13a82
cleaning up infobutton stories
sopranopillow Jul 7, 2023
eee0212
update example
sopranopillow Jul 7, 2023
5c1f74f
fixing lint
sopranopillow Jul 7, 2023
2c0d1f7
Merge branch 'master' of https://github.com/microsoft/fluentui into r…
sopranopillow Jul 14, 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
7 changes: 7 additions & 0 deletions change/@fluentui-react-infobutton-1b09e7d8-69ff-4983-9b7c-420f583f8d73.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "fix(react-infobutton): Make InfoLabel only add aria-owns when the popover is open.",
"packageName": "@fluentui/react-infobutton",
"email": "esteban.230@hotmail.com",
"dependentChangeType": "patch"
}
12 changes: 10 additions & 2 deletions packages/react-components/react-infobutton/src/components/InfoLabel/InfoLabel.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';

import { render } from '@testing-library/react';
import { fireEvent, render } from '@testing-library/react';
import { isConformant } from '../../testing/isConformant';
import { InfoLabel } from './InfoLabel';

Expand Down Expand Up @@ -44,13 +44,21 @@ describe('InfoLabel', () => {
expect(infoButton.getAttribute('aria-labelledby')).toBe(`${label.id} ${infoButton.id}`);
});

it("applies InfoButton's info slot id to aria-owns on the InfoLabel's wrapper", () => {
it("applies InfoButton's info slot id to aria-owns on the InfoLabel's wrapper when open", () => {
const { container } = render(<InfoLabel className="info-label-wrapper" info={{ id: 'test-id' }} />);
expect(container.getElementsByClassName('info-label-wrapper')[0].getAttribute('aria-owns')).toBeNull();

fireEvent.click(container.getElementsByTagName('button')[0]);

expect(container.getElementsByClassName('info-label-wrapper')[0].getAttribute('aria-owns')).toBe('test-id');
});

it("applies InfoButton's correct id to aria-owns on the InfoLabel's wrapper when id is provided to the infoButton slot", () => {
const { container } = render(<InfoLabel className="info-label-wrapper" infoButton={{ info: { id: 'test-id' } }} />);
expect(container.getElementsByClassName('info-label-wrapper')[0].getAttribute('aria-owns')).toBeNull();

fireEvent.click(container.getElementsByTagName('button')[0]);

expect(container.getElementsByClassName('info-label-wrapper')[0].getAttribute('aria-owns')).toBe('test-id');
});
});
16 changes: 14 additions & 2 deletions packages/react-components/react-infobutton/src/components/InfoLabel/useInfoLabel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as React from 'react';

import { Label } from '@fluentui/react-label';
import { resolveShorthand, useId } from '@fluentui/react-utilities';
import { mergeCallbacks, resolveShorthand, useEventCallback, useId } from '@fluentui/react-utilities';
import { InfoButton } from '../InfoButton/InfoButton';
import type { InfoLabelProps, InfoLabelState } from './InfoLabel.types';

Expand All @@ -26,6 +26,7 @@ export const useInfoLabel_unstable = (props: InfoLabelProps, ref: React.Ref<HTML
...labelProps
} = props;
const baseId = useId('infolabel-');
const [open, setOpen] = React.useState(false);

const root = resolveShorthand(rootShorthand, {
required: true,
Expand Down Expand Up @@ -54,15 +55,26 @@ export const useInfoLabel_unstable = (props: InfoLabelProps, ref: React.Ref<HTML
},
});

const infoButtonPopover = resolveShorthand(infoButton?.popover, { required: true });
infoButtonPopover.onOpenChange = useEventCallback(
mergeCallbacks(infoButtonPopover.onOpenChange, (e, data) => {
setOpen(data.open);
}),
);

if (infoButton) {
infoButton.popover = infoButtonPopover;
infoButton.info = resolveShorthand(infoButton?.info, {
defaultProps: {
id: baseId + '__info',
},
});

infoButton['aria-labelledby'] ??= `${label.id} ${infoButton.id}`;
root['aria-owns'] ??= infoButton.info?.id;

if (open) {
root['aria-owns'] ??= infoButton.info?.id;
}
}

return {
Expand Down
15 changes: 5 additions & 10 deletions packages/react-components/react-infobutton/stories/InfoButton/InfoButtonDefault.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';
import { InfoButton } from '@fluentui/react-infobutton';
import { Label, Link, makeStyles, useId } from '@fluentui/react-components';
import { Label, makeStyles, useId } from '@fluentui/react-components';
import type { InfoButtonProps } from '@fluentui/react-infobutton';
import type { PopoverProps } from '@fluentui/react-components';

Expand All @@ -15,16 +15,11 @@ export const Default = (props: Partial<InfoButtonProps>) => {
const labelId = useId('label');
const infobuttonId = useId('infobutton');
const infobuttonInfoId = infobuttonId + '__info';

const [open, setOpen] = React.useState(false);

const info = (
<>
This is example information for an InfoButton. <Link href="https://react.fluentui.dev">Learn more</Link>
</>
);

const onOpenChange: PopoverProps['onOpenChange'] = (e, data) => setOpen(data.open);
const onOpenChange: PopoverProps['onOpenChange'] = (e, data) => {
setOpen(data.open);
};

return (
<div aria-owns={open ? infobuttonInfoId : undefined}>
Expand All @@ -35,7 +30,7 @@ export const Default = (props: Partial<InfoButtonProps>) => {
className={styles.infoButton}
info={{
id: infobuttonInfoId,
children: info,
children: 'This is example information for an InfoButton.',
}}
popover={{
onOpenChange,
Expand Down
23 changes: 7 additions & 16 deletions packages/react-components/react-infobutton/stories/InfoButton/InfoButtonSize.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as React from 'react';
import { InfoButton } from '@fluentui/react-infobutton';
import { Label, Link, makeStyles, shorthands, useId } from '@fluentui/react-components';
import { Label, makeStyles, shorthands, useId } from '@fluentui/react-components';
import type { InfoButtonProps } from '@fluentui/react-infobutton';
import type { PopoverProps } from '@fluentui/react-components';

Expand All @@ -19,28 +19,19 @@ const useStyles = makeStyles({

const InfoButtonSize: React.FC<{ size: InfoButtonProps['size'] }> = ({ size }) => {
const styles = useStyles();
const labelId = useId('label');
const infobuttonId = useId('infobutton');
const infobuttonInfoId = infobuttonId + '__info';

const infobuttonInfoId = useId('infobuton__info');
const [open, setOpen] = React.useState(false);
const info = 'This is example information for an InfoButton.';

const info = (
<>
This is example information for an InfoButton. <Link href="https://react.fluentui.dev">Learn more</Link>
</>
);

const onOpenChange: PopoverProps['onOpenChange'] = (e, data) => setOpen(data.open);
const onOpenChange: PopoverProps['onOpenChange'] = (e, data) => {
setOpen(data.open);
};

return (
<div aria-owns={open ? infobuttonInfoId : undefined}>
<Label size={size} id={labelId}>
This is a {size} Infobutton
</Label>
<Label size={size}>This is a {size} Infobutton</Label>
<InfoButton
size={size}
id={infobuttonId}
className={styles.infoButton}
info={{
id: infobuttonInfoId,
Expand Down