Skip to content

fix(Pill): selectable by keyboard #22839

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
chpalac merged 7 commits into from
May 5, 2022
Merged

fix(Pill): selectable by keyboard #22839

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5711aeb
fix: pill behavior
chpalac May 4, 2022
ed03f57
fix: Pill by adding default accessibility and considering selectable …
chpalac May 4, 2022
467551a
chore: remove unstable comment
chpalac May 5, 2022
42e0c27
chore: add missing role prop
chpalac May 5, 2022
a08c6bf
chore: handle dismiss and actionable
chpalac May 5, 2022
f036e36
chore: add role button when selectable
chpalac May 5, 2022
e5f3ddb
chore: add changelog
chpalac May 5, 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
11 changes: 7 additions & 4 deletions packages/fluentui/accessibility/src/behaviors/Pill/pillBehavior.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,22 @@ import { IS_FOCUSABLE_ATTRIBUTE } from '../../attributes';
export const pillBehavior: Accessibility<PillBehaviorProps> = p => ({
attributes: {
root: {
role: p.actionable ? 'button' : 'none',
tabIndex: p.actionable ? 0 : -1,
[IS_FOCUSABLE_ATTRIBUTE]: p.actionable || p.role === 'option',
role: p.actionable || p.selectable ? 'button' : 'none',
tabIndex: p.actionable || p.selectable ? 0 : -1,
[IS_FOCUSABLE_ATTRIBUTE]: p.actionable || p.selectable || p.role === 'option',
...(p.selectable && {
'aria-selected': p.selected,
}),
},
},
keyActions: {
root: {
...(p.actionable && {
...(p.dismissible && {
performDismiss: {
keyCombinations: [{ keyCode: keyboardKey.Delete }, { keyCode: keyboardKey.Backspace }],
},
}),
...((p.selectable || p.actionable) && {
performClick: {
keyCombinations: [{ keyCode: keyboardKey.Enter }, { keyCode: SpacebarKey }],
},
Expand All @@ -32,4 +34,5 @@ export type PillBehaviorProps = {
selectable: boolean;
selected: boolean;
role: AriaRole;
dismissible: boolean;
};
20 changes: 15 additions & 5 deletions packages/fluentui/react-northstar/src/components/Pill/Pill.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import * as PropTypes from 'prop-types';
import * as React from 'react';
import * as customPropTypes from '@fluentui/react-proptypes';
import * as _ from 'lodash';
import { Accessibility, pillBehavior, PillBehaviorProps } from '@fluentui/accessibility';
import { Accessibility, AriaRole, pillBehavior, PillBehaviorProps } from '@fluentui/accessibility';
import { UIComponentProps, ContentComponentProps, commonPropTypes, SizeValue, createShorthand } from '../../utils';
import { ShorthandValue, FluentComponentStaticProps, ComponentEventHandler } from '../../types';
import { BoxProps } from '../Box/Box';
Expand Down Expand Up @@ -103,16 +103,20 @@ export interface PillProps extends UIComponentProps, ContentComponentProps<Short
* @param data - All props.
*/
onSelectionChange?: ComponentEventHandler<PillProps>;

/**
* Role to be set in the pill root element
*/
role?: AriaRole;
Comment thread
chpalac marked this conversation as resolved.
}

export type PillStylesProps = Required<
Pick<PillProps, 'appearance' | 'size' | 'rectangular' | 'disabled' | 'selectable' | 'selected'>
Pick<PillProps, 'appearance' | 'size' | 'rectangular' | 'disabled' | 'selectable' | 'selected' | 'actionable'>
>;

export const pillClassName = 'ui-pill';

/**
* THIS COMPONENT IS UNSTABLE
* Pills should be used when representing an input, as a way to filter content, or to represent an attribute.
*/
export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) => {
Expand All @@ -139,6 +143,8 @@ export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) =
icon,
selectable,
selectedIndicator,
role,
onDismiss,
} = props;

const [selected, setSelected] = useAutoControlled({
Expand Down Expand Up @@ -172,6 +178,8 @@ export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) =
actionable,
selectable,
selected,
role,
dismissible: Boolean(onDismiss),
}),
rtl: context.rtl,
});
Expand All @@ -185,6 +193,7 @@ export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) =
disabled,
selectable,
selected,
actionable,
}),
mapPropsToInlineStyles: () => ({
className,
Expand Down Expand Up @@ -212,7 +221,7 @@ export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) =
{...getA11yProps('root', {
className: classes.root,
ref,
...(actionable && { onClick: handleClick }),
...((actionable || selectable) && { onClick: handleClick }),
...unhandledProps,
})}
>
Expand All @@ -236,7 +245,7 @@ export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) =
actionable,
}),
})}
{actionable &&
{Boolean(onDismiss) &&
createShorthand(PillAction, action || {}, {
overrideProps: (prevProps: PillActionProps & { onClick: (e: React.MouseEvent) => void }) => ({
onClick: e => {
Expand All @@ -255,6 +264,7 @@ export const Pill = (React.forwardRef<HTMLSpanElement, PillProps>((props, ref) =

Pill.defaultProps = {
as: 'span' as const,
accessibility: pillBehavior,
};

Pill.propTypes = {
Expand Down
4 changes: 4 additions & 0 deletions packages/fluentui/react-northstar/src/themes/teams/components/Pill/pillStyles.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ export const pillStyles: ComponentSlotStylesPrepared<PillStylesProps, PillVariab
}),
}),

...(p.actionable && {
cursor: 'pointer',
}),

...getBorderFocusStyles({ variables: siteVariables }),
};
},
Expand Down