Some checks failed
Close stale issues and PRs / stale (push) Has been cancelled
273 lines
6.7 KiB
TypeScript
273 lines
6.7 KiB
TypeScript
import React, { ReactNode, useCallback } from 'react';
|
|
import { useSelector } from 'react-redux';
|
|
import { makeStyles } from 'tss-react/mui';
|
|
|
|
import { showOverflowDrawer } from '../../../../toolbox/functions.web';
|
|
import Icon from '../../../icons/components/Icon';
|
|
import { TEXT_OVERFLOW_TYPES } from '../../constants.any';
|
|
|
|
import TextWithOverflow from './TextWithOverflow';
|
|
|
|
export interface IProps {
|
|
|
|
/**
|
|
* Label used for accessibility.
|
|
*/
|
|
accessibilityLabel?: string;
|
|
|
|
/**
|
|
* The context menu item background color.
|
|
*/
|
|
backgroundColor?: string;
|
|
|
|
/**
|
|
* Component children.
|
|
*/
|
|
children?: ReactNode;
|
|
|
|
/**
|
|
* CSS class name used for custom styles.
|
|
*/
|
|
className?: string;
|
|
|
|
/**
|
|
* Id of dom element controlled by this item. Matches aria-controls.
|
|
* Useful if you need this item as a tab element.
|
|
*
|
|
*/
|
|
controls?: string;
|
|
|
|
/**
|
|
* Custom icon. If used, the icon prop is ignored.
|
|
* Used to allow custom children instead of just the default icons.
|
|
*/
|
|
customIcon?: ReactNode;
|
|
|
|
/**
|
|
* Whether or not the action is disabled.
|
|
*/
|
|
disabled?: boolean;
|
|
|
|
/**
|
|
* Default icon for action.
|
|
*/
|
|
icon?: Function;
|
|
|
|
/**
|
|
* Id of the action container.
|
|
*/
|
|
id?: string;
|
|
|
|
/**
|
|
* Click handler.
|
|
*/
|
|
onClick?: (e?: React.MouseEvent<any>) => void;
|
|
|
|
/**
|
|
* Keydown handler.
|
|
*/
|
|
onKeyDown?: (e: React.KeyboardEvent<HTMLDivElement>) => void;
|
|
|
|
/**
|
|
* Keypress handler.
|
|
*/
|
|
onKeyPress?: (e?: React.KeyboardEvent) => void;
|
|
|
|
/**
|
|
* Overflow type for item text.
|
|
*/
|
|
overflowType?: TEXT_OVERFLOW_TYPES;
|
|
|
|
/**
|
|
* You can use this item as a tab. Defaults to button if not set.
|
|
*
|
|
* If no onClick handler is provided, we assume the context menu item is
|
|
* not interactive and no role will be set.
|
|
*/
|
|
role?: 'tab' | 'button' | 'menuitem';
|
|
|
|
/**
|
|
* Whether the item is marked as selected.
|
|
*/
|
|
selected?: boolean;
|
|
|
|
/**
|
|
* TestId of the element, if any.
|
|
*/
|
|
testId?: string;
|
|
|
|
/**
|
|
* Action text.
|
|
*/
|
|
text?: string;
|
|
|
|
/**
|
|
* Class name for the text.
|
|
*/
|
|
textClassName?: string;
|
|
}
|
|
|
|
const useStyles = makeStyles()(theme => {
|
|
return {
|
|
contextMenuItem: {
|
|
alignItems: 'center',
|
|
cursor: 'pointer',
|
|
display: 'flex',
|
|
minHeight: '40px',
|
|
padding: '10px 16px',
|
|
boxSizing: 'border-box',
|
|
|
|
'& > *:not(:last-child)': {
|
|
marginRight: theme.spacing(3)
|
|
},
|
|
|
|
'&:hover': {
|
|
backgroundColor: theme.palette.ui02
|
|
},
|
|
|
|
'&:active': {
|
|
backgroundColor: theme.palette.ui03
|
|
},
|
|
|
|
'&.focus-visible': {
|
|
boxShadow: `inset 0 0 0 2px ${theme.palette.action01Hover}`
|
|
}
|
|
},
|
|
|
|
selected: {
|
|
borderLeft: `3px solid ${theme.palette.action01Hover}`,
|
|
paddingLeft: '13px',
|
|
backgroundColor: theme.palette.ui02
|
|
},
|
|
|
|
contextMenuItemDisabled: {
|
|
pointerEvents: 'none'
|
|
},
|
|
|
|
contextMenuItemIconDisabled: {
|
|
'& svg': {
|
|
fill: `${theme.palette.text03} !important`
|
|
}
|
|
},
|
|
|
|
contextMenuItemLabelDisabled: {
|
|
color: theme.palette.text03,
|
|
|
|
'&:hover': {
|
|
background: 'none'
|
|
},
|
|
|
|
'& svg': {
|
|
fill: theme.palette.text03
|
|
}
|
|
},
|
|
|
|
contextMenuItemDrawer: {
|
|
padding: '13px 16px'
|
|
},
|
|
|
|
contextMenuItemIcon: {
|
|
'& svg': {
|
|
fill: theme.palette.icon01
|
|
}
|
|
},
|
|
|
|
text: {
|
|
...theme.typography.bodyShortRegular,
|
|
color: theme.palette.text01
|
|
},
|
|
|
|
drawerText: {
|
|
...theme.typography.bodyShortRegularLarge
|
|
}
|
|
};
|
|
});
|
|
|
|
const ContextMenuItem = ({
|
|
accessibilityLabel,
|
|
backgroundColor,
|
|
children,
|
|
className,
|
|
controls,
|
|
customIcon,
|
|
disabled,
|
|
id,
|
|
icon,
|
|
onClick,
|
|
onKeyDown,
|
|
onKeyPress,
|
|
overflowType,
|
|
role = 'button',
|
|
selected,
|
|
testId,
|
|
text,
|
|
textClassName }: IProps) => {
|
|
const { classes: styles, cx } = useStyles();
|
|
const _overflowDrawer: boolean = useSelector(showOverflowDrawer);
|
|
const style = backgroundColor ? { backgroundColor } : {};
|
|
const onKeyPressHandler = useCallback(e => {
|
|
// only trigger the fallback behavior (onClick) if we dont have any explicit keyboard event handler
|
|
if (onClick && !onKeyPress && !onKeyDown && (e.key === 'Enter' || e.key === ' ')) {
|
|
e.preventDefault();
|
|
onClick(e);
|
|
}
|
|
|
|
if (onKeyPress) {
|
|
onKeyPress(e);
|
|
}
|
|
}, [ onClick, onKeyPress, onKeyDown ]);
|
|
|
|
let tabIndex: undefined | 0 | -1;
|
|
|
|
if (role === 'tab') {
|
|
tabIndex = selected ? 0 : -1;
|
|
}
|
|
|
|
if ((role === 'button' || role === 'menuitem') && !disabled) {
|
|
tabIndex = 0;
|
|
}
|
|
|
|
return (
|
|
<div
|
|
aria-controls = { controls }
|
|
aria-disabled = { disabled }
|
|
aria-label = { accessibilityLabel || undefined }
|
|
aria-selected = { role === 'tab' ? selected : undefined }
|
|
className = { cx(styles.contextMenuItem,
|
|
_overflowDrawer && styles.contextMenuItemDrawer,
|
|
disabled && styles.contextMenuItemDisabled,
|
|
selected && styles.selected,
|
|
className
|
|
) }
|
|
data-testid = { testId }
|
|
id = { id }
|
|
key = { text }
|
|
onClick = { disabled ? undefined : onClick }
|
|
onKeyDown = { disabled ? undefined : onKeyDown }
|
|
onKeyPress = { disabled ? undefined : onKeyPressHandler }
|
|
role = { onClick ? role : undefined }
|
|
style = { style }
|
|
tabIndex = { onClick ? tabIndex : undefined }>
|
|
{customIcon ? customIcon
|
|
: icon && <Icon
|
|
className = { cx(styles.contextMenuItemIcon,
|
|
disabled && styles.contextMenuItemIconDisabled) }
|
|
size = { 20 }
|
|
src = { icon } />}
|
|
{text && (
|
|
<TextWithOverflow
|
|
className = { cx(styles.text,
|
|
_overflowDrawer && styles.drawerText,
|
|
disabled && styles.contextMenuItemLabelDisabled,
|
|
textClassName) }
|
|
overflowType = { overflowType } >
|
|
{text}
|
|
</TextWithOverflow>
|
|
)}
|
|
{children}
|
|
</div>
|
|
);
|
|
};
|
|
|
|
export default ContextMenuItem;
|