Skip to content

Fix accessibility labels for tree stories #27443

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
petdud merged 7 commits into from
Apr 13, 2023
Merged

Fix accessibility labels for tree stories #27443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
10ad3d6
add item
Apr 4, 2023
c1d224a
labels
Apr 5, 2023
07d5dfb
r
Apr 5, 2023
7d22a56
fixes
Apr 5, 2023
03de676
aria labels in treeitem
Apr 5, 2023
f55acd4
Merge branch 'master' into tree-fix-labels
petdud Apr 5, 2023
e2fe8af
Merge branch 'master' into tree-fix-labels
petdud Apr 12, 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
108 changes: 53 additions & 55 deletions packages/react-components/react-tree/stories/Layouts/TreeItemLayout.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import * as React from 'react';
import { Tree, TreeItem, TreeItemLayout } from '@fluentui/react-tree';
import {
CalendarLtr20Regular,
Flag20Regular,
FluentIconsProps,
Image20Regular,
Important16Regular,
LockClosed20Regular,
MoreHorizontal20Regular,
Expand All @@ -16,10 +16,10 @@ const iconStyleProps: FluentIconsProps = {
primaryFill: 'red',
};

const Badges = () => (
const Badges = ({ isImportant, messageCount }: { isImportant?: boolean; messageCount?: number }) => (
<>
<Important16Regular {...iconStyleProps} />
<CounterBadge count={1} color="danger" size="small" />
{isImportant && <Important16Regular {...iconStyleProps} />}
{messageCount && messageCount > 0 && <CounterBadge count={messageCount} color="danger" size="small" />}
</>
);

Expand All @@ -32,10 +32,10 @@ const RenderIconsAfter = () => (

const Actions = () => (
<>
<Button appearance="subtle" icon={<Flag20Regular />} />
<Button aria-label="Report" appearance="subtle" icon={<Flag20Regular />} />
<Menu>
<MenuTrigger disableButtonEnhancement>
<Button appearance="subtle" icon={<MoreHorizontal20Regular />} />
<Button aria-label="More options" appearance="subtle" icon={<MoreHorizontal20Regular />} />
</MenuTrigger>

<MenuPopover>
Expand All @@ -51,58 +51,56 @@ const Actions = () => (
);

const treeItemLayoutProps = {
iconBefore: <CalendarLtr20Regular />,
iconBefore: <Image20Regular />,
iconAfter: <RenderIconsAfter />,
};

export const Layout = () => {
return (
<Tree aria-label="Tree">
<TreeItem actions={<Actions />}>
<TreeItemLayout {...treeItemLayoutProps} aside={<Badges />}>
Content
</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout>Tree Item</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>level 2, item 1</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 2</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 3</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 2</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 3</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
<TreeItem actions={<Actions />}>
<TreeItemLayout {...treeItemLayoutProps} aside={<Important16Regular {...iconStyleProps} />}>
Content
</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout>level 2, item 1</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>level 3, item 1</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
</Tree>
</TreeItem>
</Tree>
);
};
export const Layout = () => (
<Tree aria-label="Tree">
<TreeItem aria-description="Private, 1 message" actions={<Actions />}>
<TreeItemLayout {...treeItemLayoutProps} aside={<Badges isImportant={true} messageCount={1} />}>
Content
</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout>Tree Item</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>level 2, item 1</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 2</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 3</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 2</TreeItemLayout>
</TreeItem>
<TreeItem>
<TreeItemLayout>level 2, item 3</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
<TreeItem aria-description="Private" actions={<Actions />}>
<TreeItemLayout {...treeItemLayoutProps} aside={<Important16Regular {...iconStyleProps} />}>
Content
</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout>level 2, item 1</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>level 3, item 1</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
</Tree>
</TreeItem>
</Tree>
);

Layout.parameters = {
docs: {
Expand Down
44 changes: 22 additions & 22 deletions packages/react-components/react-tree/stories/Layouts/TreeItemLayoutAside.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,59 @@ const iconStyleProps: FluentIconsProps = {
primaryFill: 'red',
};

const RenderAside = () => (
const RenderAside = ({ isImportant, messageCount }: { isImportant?: boolean; messageCount?: number }) => (
<>
<Important16Regular {...iconStyleProps} />
<CounterBadge count={1} color="danger" size="small" />
{isImportant && <Important16Regular {...iconStyleProps} />}
{messageCount && messageCount > 0 && <CounterBadge count={messageCount} color="danger" size="small" />}
</>
);

const Actions = () => (
<>
<Button appearance="subtle" icon={<Edit20Regular />} />
<Button appearance="subtle" icon={<MoreHorizontal20Regular />} />
<Button appearance="subtle" icon={<Edit20Regular aria-label="Edit" />} />
<Button appearance="subtle" icon={<MoreHorizontal20Regular aria-label="More options" />} />
</>
);

export const Aside = () => (
<Tree aria-label="Tree">
<TreeItem>
<TreeItemLayout aside={<RenderAside />}>level 1, item 1</TreeItemLayout>
<TreeItem aria-description="Important, 3 message">
<TreeItemLayout aside={<RenderAside isImportant={true} messageCount={3} />}>level 1, item 1</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 2, item 1</TreeItemLayout>
<TreeItem aria-description="Important" actions={<Actions />}>
<TreeItemLayout aside={<RenderAside isImportant={true} />}>level 2, item 1</TreeItemLayout>
</TreeItem>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 2, item 2</TreeItemLayout>
<TreeItem aria-description="2 messages" actions={<Actions />}>
<TreeItemLayout aside={<RenderAside messageCount={2} />}>level 2, item 2</TreeItemLayout>
</TreeItem>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 2, item 3</TreeItemLayout>
<TreeItem aria-description="1 messages" actions={<Actions />}>
<TreeItemLayout aside={<RenderAside messageCount={1} />}>level 2, item 3</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
<TreeItem>
<TreeItemLayout aside={<RenderAside />}>level 1, item 2</TreeItemLayout>
<TreeItem aria-description="Important, 1 message">
<TreeItemLayout aside={<RenderAside isImportant={true} messageCount={1} />}>level 1, item 2</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 2, item 1</TreeItemLayout>
<TreeItem aria-description="1 message" actions={<Actions />}>
<TreeItemLayout aside={<RenderAside messageCount={1} />}>level 2, item 1</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 3, item 1</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>

<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 2, item 2</TreeItemLayout>
<TreeItem aria-description="Important" actions={<Actions />}>
<TreeItemLayout aside={<RenderAside isImportant={true} />}>level 2, item 2</TreeItemLayout>
<Tree>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 3, item 1</TreeItemLayout>
<TreeItemLayout>level 3, item 1</TreeItemLayout>
</TreeItem>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 3, item 2</TreeItemLayout>
<TreeItemLayout>level 3, item 2</TreeItemLayout>
</TreeItem>
<TreeItem actions={<Actions />}>
<TreeItemLayout aside={<RenderAside />}>level 3, item 3</TreeItemLayout>
<TreeItemLayout>level 3, item 3</TreeItemLayout>
</TreeItem>
</Tree>
</TreeItem>
Expand Down
48 changes: 24 additions & 24 deletions packages/react-components/react-tree/stories/Layouts/TreeItemPersonaLayout.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const iconStyleProps: FluentIconsProps = {
const Badges = () => {
const badgeStyles = useBadgeStyles();
return (
<div aria-hidden className={badgeStyles.base}>
<div className={badgeStyles.base}>
<Important16Regular {...iconStyleProps} />
<CounterBadge count={1} color="danger" size="small" />
</div>
Expand All @@ -49,10 +49,10 @@ const Badges = () => {
const RenderActions = () => {
return (
<>
<Button appearance="subtle" icon={<Flag20Regular />} />
<Button aria-label="Report" appearance="subtle" icon={<Flag20Regular />} />
<Menu>
<MenuTrigger disableButtonEnhancement>
<Button appearance="subtle" icon={<MoreHorizontal20Regular />} />
<Button aria-label="More options" appearance="subtle" icon={<MoreHorizontal20Regular />} />
</MenuTrigger>

<MenuPopover>
Expand All @@ -73,9 +73,9 @@ export const TreePersonaLayout = () => {

return (
<Tree aria-label="Tree">
<TreeItem actions={<RenderActions />}>
<TreeItem aria-description="1 new message, important" actions={<RenderActions />}>
<TreeItemPersonaLayout
description="Secondary text slot"
description={<div className={styles.unread}>Secondary text slot</div>}
aside={
<>
<span>00:00 AM</span>
Expand All @@ -84,27 +84,26 @@ export const TreePersonaLayout = () => {
}
media={<Avatar />}
>
Primary text slot
<div className={styles.unread}>Primary text slot</div>
</TreeItemPersonaLayout>
<Tree>
<TreeItem>
<TreeItemPersonaLayout media={<Avatar />}>content</TreeItemPersonaLayout>
</TreeItem>
<TreeItem>
<TreeItemPersonaLayout description="description" media={<Avatar />}>
content
</TreeItemPersonaLayout>
</TreeItem>
<TreeItem>
<TreeItemPersonaLayout description="description" media={<Avatar />}>
content
</TreeItemPersonaLayout>
<Tree>
<TreeItem>
<TreeItemPersonaLayout description="description" media={<Avatar />}>
content
</TreeItemPersonaLayout>
</TreeItem>
</Tree>
</TreeItem>
</Tree>
</TreeItem>
<TreeItem actions={<RenderActions />}>
<TreeItem aria-description="1 message, important" actions={<RenderActions />}>
<TreeItemPersonaLayout
description={<div className={styles.unread}>Secondary text slot</div>}
description="Secondary text slot"
aside={
<>
<span>00:00 AM</span>
Expand All @@ -113,20 +112,21 @@ export const TreePersonaLayout = () => {
}
media={<Avatar />}
>
<div className={styles.unread}>Primary text slot</div>
Primary text slot
</TreeItemPersonaLayout>
<Tree>
<TreeItem>
<TreeItemPersonaLayout media={<Avatar />}>content</TreeItemPersonaLayout>
</TreeItem>
<TreeItem>
<TreeItemPersonaLayout description="description" media={<Avatar />}>
content
</TreeItemPersonaLayout>
</TreeItem>
<TreeItem>
<TreeItemPersonaLayout description="description" media={<Avatar />}>
content
</TreeItemPersonaLayout>
<Tree>
<TreeItem>
<TreeItemPersonaLayout description="description" media={<Avatar />}>
content
</TreeItemPersonaLayout>
</TreeItem>
</Tree>
</TreeItem>
</Tree>
</TreeItem>
Expand Down
2 changes: 1 addition & 1 deletion ...s/react-components/react-tree/stories/Layouts/TreeItemPersonaLayoutReadUnread.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const ReadUnread = () => {
Read content message
</TreeItemPersonaLayout>
</TreeItem>
<TreeItem>
<TreeItem aria-description="New message">
<TreeItemPersonaLayout
description={<div className={styles.unread}>Secondary text content</div>}
media={<Avatar />}
Expand Down
4 changes: 2 additions & 2 deletions packages/react-components/react-tree/stories/TreeItem/TreeItemActions.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import story from './TreeItemActions.md';
const RenderActions = () => {
return (
<>
<Button appearance="subtle" icon={<Edit20Regular />} />
<Button aria-label="Edit" appearance="subtle" icon={<Edit20Regular />} />
<Menu>
<MenuTrigger disableButtonEnhancement>
<Button appearance="subtle" icon={<MoreHorizontal20Regular />} />
<Button aria-label="More options" appearance="subtle" icon={<MoreHorizontal20Regular />} />
</MenuTrigger>

<MenuPopover>
Expand Down
4 changes: 2 additions & 2 deletions packages/react-components/react-tree/stories/TreeItem/TreeItemIconAfter.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { LockClosed20Regular } from '@fluentui/react-icons';
export const IconAfter = () => {
return (
<Tree aria-label="Tree">
<TreeItem>
<TreeItem aria-description="Private">
<TreeItemLayout iconAfter={<LockClosed20Regular />}>level 1, item 1</TreeItemLayout>
<Tree>
<TreeItem>
Expand All @@ -19,7 +19,7 @@ export const IconAfter = () => {
</TreeItem>
</Tree>
</TreeItem>
<TreeItem>
<TreeItem aria-description="Private">
<TreeItemLayout iconAfter={<LockClosed20Regular />}>level 1, item 2</TreeItemLayout>
<Tree>
<TreeItem>
Expand Down
6 changes: 3 additions & 3 deletions packages/react-components/react-tree/stories/TreeItem/TreeItemIconBefore.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import * as React from 'react';
import { Tree, TreeItem, TreeItemLayout } from '@fluentui/react-tree';
import { CheckboxChecked20Filled, CheckboxUnchecked20Filled } from '@fluentui/react-icons';
import { Image20Regular } from '@fluentui/react-icons';
import story from './TreeItemIconBefore.md';

export const IconBefore = () => {
return (
<Tree aria-label="Tree">
<TreeItem>
<TreeItemLayout iconBefore={<CheckboxUnchecked20Filled />}>level 1, item 1</TreeItemLayout>
<TreeItemLayout iconBefore={<Image20Regular />}>level 1, item 1</TreeItemLayout>
<Tree>
<TreeItem>
<TreeItemLayout>level 2, item 1</TreeItemLayout>
Expand All @@ -21,7 +21,7 @@ export const IconBefore = () => {
</Tree>
</TreeItem>
<TreeItem>
<TreeItemLayout iconBefore={<CheckboxChecked20Filled />}>level 1, item 2</TreeItemLayout>
<TreeItemLayout iconBefore={<Image20Regular />}>level 1, item 2</TreeItemLayout>
<Tree>
<TreeItem>
level 2, item 1
Expand Down