Skip to content

pass in icon props to presence badge icon slot, and use default strings #22901

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
micahgodbolt merged 8 commits into from
May 17, 2022
Merged

pass in icon props to presence badge icon slot, and use default strings #22901

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
787936b
pass in icon props to presence badge icon slot, and use default strings
micahgodbolt May 9, 2022
d842ad1
change file
micahgodbolt May 9, 2022
7deb57d
Merge branch 'master' into badge-icon-slot
micahgodbolt May 11, 2022
6ea50bf
remove unused import
micahgodbolt May 11, 2022
ea8c890
update api file
micahgodbolt May 11, 2022
8bb6118
merge conflict
micahgodbolt May 11, 2022
fd84c7e
Update packages/react-badge/src/components/PresenceBadge/usePresenceB…
micahgodbolt May 13, 2022
d0df13b
Update packages/react-badge/src/stories/PresenceBadgeStatus.stories.tsx
micahgodbolt May 13, 2022
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-badge-ddd7ad34-0c86-4cbf-8df7-498ff221cfbf.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "pass in icon props to presence badge icon slot, and use default strings",
"packageName": "@fluentui/react-badge",
"email": "mgodbolt@microsoft.com",
"dependentChangeType": "patch"
}
2 changes: 1 addition & 1 deletion packages/react-badge/etc/react-badge.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export const presenceBadgeClassName = "fui-PresenceBadge";
export const presenceBadgeClassNames: SlotClassNames<BadgeSlots>;

// @public (undocumented)
export type PresenceBadgeProps = Omit<ComponentProps<Pick<BadgeSlots, 'root'>>, 'color'> & Pick<BadgeProps, 'size'> & {
export type PresenceBadgeProps = Omit<ComponentProps<Pick<BadgeSlots, 'root' | 'icon'>>, 'color'> & Pick<BadgeProps, 'size'> & {
status?: PresenceBadgeStatus;
outOfOffice?: boolean;
};
Expand Down
2 changes: 1 addition & 1 deletion packages/react-badge/src/components/PresenceBadge/PresenceBadge.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export type PresenceBadgeStatus =
| 'doNotDisturb'
| 'unknown';

export type PresenceBadgeProps = Omit<ComponentProps<Pick<BadgeSlots, 'root'>>, 'color'> &
export type PresenceBadgeProps = Omit<ComponentProps<Pick<BadgeSlots, 'root' | 'icon'>>, 'color'> &
Pick<BadgeProps, 'size'> & {
/**
* Represents several status
Expand Down
17 changes: 15 additions & 2 deletions packages/react-badge/src/components/PresenceBadge/usePresenceBadge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
presenceOofRegular,
presenceUnknownRegular,
} from './presenceIcons';
import { useBadge_unstable, BadgeProps } from '../Badge/index';
import { useBadge_unstable } from '../Badge/index';
import type { PresenceBadgeProps, PresenceBadgeState } from './PresenceBadge.types';

const iconMap = (
Expand All @@ -37,6 +37,16 @@ const iconMap = (
}
};

const DEFAULT_STRINGS = {
busy: 'busy',
outOfOffice: 'out of office',
away: 'away',
available: 'available',
offline: 'offline',
doNotDisturb: 'do not disturb',
unknown: 'unknown',
};

/**
* Returns the props and state required to render the component
*/
Expand All @@ -49,8 +59,11 @@ export const usePresenceBadge_unstable = (
{
size: 'medium',
...props,
icon: resolveShorthand(undefined as BadgeProps['icon'], {
icon: resolveShorthand(props.icon, {
required: true,
defaultProps: {
'aria-label': props.status && DEFAULT_STRINGS[props.status],
},
}),
},
ref,
Expand Down