Skip to content

[Rating] Make input ids less predictable #26493

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.

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
merged 6 commits into from
Jun 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
260 changes: 164 additions & 96 deletions packages/material-ui/src/Rating/Rating.js
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,116 @@ IconContainer.propTypes = {
value: PropTypes.number.isRequired,
};

function RatingItem(props) {
const {
classes,
disabled,
emptyIcon,
focus,
getLabelText,
highlightSelectedOnly,
hover,
icon,
IconContainerComponent,
isActive,
itemValue,
labelProps,
name,
onBlur,
onChange,
onClick,
onFocus,
readOnly,
styleProps,
ratingValue,
ratingValueRounded,
} = props;

const isFilled = highlightSelectedOnly ? itemValue === ratingValue : itemValue <= ratingValue;
const isHovered = itemValue <= hover;
const isFocused = itemValue <= focus;
const isChecked = itemValue === ratingValueRounded;

const id = useId();
const container = (
<RatingIcon
as={IconContainerComponent}
value={itemValue}
className={clsx(classes.icon, {
[classes.iconEmpty]: !isFilled,
[classes.iconFilled]: isFilled,
[classes.iconHover]: isHovered,
[classes.iconFocus]: isFocused,
[classes.iconActive]: isActive,
})}
styleProps={{
...styleProps,
iconEmpty: !isFilled,
iconFilled: isFilled,
iconHover: isHovered,
iconFocus: isFocused,
iconActive: isActive,
}}
>
{emptyIcon && !isFilled ? emptyIcon : icon}
</RatingIcon>
);

if (readOnly) {
return <span {...labelProps}>{container}</span>;
}

return (
<React.Fragment>
<RatingLabel
styleProps={{ ...styleProps, emptyValueFocused: undefined }}
htmlFor={id}
{...labelProps}
>
{container}
<span className={classes.visuallyHidden}>{getLabelText(itemValue)}</span>
</RatingLabel>
<input
className={classes.visuallyHidden}
onFocus={onFocus}
onBlur={onBlur}
onChange={onChange}
onClick={onClick}
disabled={disabled}
value={itemValue}
id={id}
type="radio"
name={name}
checked={isChecked}
/>
</React.Fragment>
);
}

RatingItem.propTypes = {
classes: PropTypes.object.isRequired,
disabled: PropTypes.bool.isRequired,
emptyIcon: PropTypes.node,
focus: PropTypes.number.isRequired,
getLabelText: PropTypes.func.isRequired,
highlightSelectedOnly: PropTypes.bool.isRequired,
hover: PropTypes.number.isRequired,
icon: PropTypes.node,
IconContainerComponent: PropTypes.elementType.isRequired,
isActive: PropTypes.bool.isRequired,
itemValue: PropTypes.number.isRequired,
labelProps: PropTypes.object,
name: PropTypes.string,
onBlur: PropTypes.func.isRequired,
onChange: PropTypes.func.isRequired,
onClick: PropTypes.func.isRequired,
onFocus: PropTypes.func.isRequired,
ratingValue: PropTypes.number,
ratingValueRounded: PropTypes.number,
readOnly: PropTypes.bool.isRequired,
styleProps: PropTypes.object.isRequired,
};

const defaultIcon = <Star fontSize="inherit" />;
const defaultEmptyIcon = <StarBorder fontSize="inherit" />;

Expand Down Expand Up @@ -397,67 +507,6 @@ const Rating = React.forwardRef(function Rating(inProps, ref) {

const classes = useUtilityClasses(styleProps);

const item = (state, labelProps) => {
const id = `${name}-${String(state.value).replace('.', '-')}`;
const container = (
<RatingIcon
as={IconContainerComponent}
value={state.value}
className={clsx(classes.icon, {
[classes.iconEmpty]: !state.filled,
[classes.iconFilled]: state.filled,
[classes.iconHover]: state.hover,
[classes.iconFocus]: state.focus,
[classes.iconActive]: state.active,
})}
styleProps={{
...styleProps,
iconEmpty: !state.filled,
iconFilled: state.filled,
iconHover: state.hover,
iconFocus: state.focus,
iconActive: state.active,
}}
>
{emptyIcon && !state.filled ? emptyIcon : icon}
</RatingIcon>
);

if (readOnly) {
return (
<span key={state.value} {...labelProps}>
{container}
</span>
);
}

return (
<React.Fragment key={state.value}>
<RatingLabel
styleProps={{ ...styleProps, emptyValueFocused: undefined }}
htmlFor={id}
{...labelProps}
>
{container}
<span className={classes.visuallyHidden}>{getLabelText(state.value)}</span>
</RatingLabel>
<input
className={classes.visuallyHidden}
onFocus={handleFocus}
onBlur={handleBlur}
onChange={handleChange}
onClick={handleClear}
disabled={disabled}
value={state.value}
id={id}
type="radio"
name={name}
checked={state.checked}
/>
</React.Fragment>
);
};

return (
<RatingRoot
ref={handleRef}
Expand All @@ -472,16 +521,37 @@ const Rating = React.forwardRef(function Rating(inProps, ref) {
{Array.from(new Array(max)).map((_, index) => {
const itemValue = index + 1;

const ratingItemProps = {
classes,
disabled,
emptyIcon,
focus,
getLabelText,
highlightSelectedOnly,
hover,
icon,
IconContainerComponent,
name,
onBlur: handleBlur,
onChange: handleChange,
onClick: handleClear,
onFocus: handleFocus,
ratingValue: value,
ratingValueRounded: valueRounded,
readOnly,
styleProps,
};

const isActive = itemValue === Math.ceil(value) && (hover !== -1 || focus !== -1);
if (precision < 1) {
const items = Array.from(new Array(1 / precision));
const iconActive = itemValue === Math.ceil(value) && (hover !== -1 || focus !== -1);
return (
<RatingDecimal
key={itemValue}
className={clsx(classes.decimal, { [classes.iconActive]: iconActive })}
className={clsx(classes.decimal, { [classes.iconActive]: isActive })}
styleProps={{
...styleProps,
iconActive,
iconActive: isActive,
}}
>
{items.map(($, indexDecimal) => {
Expand All @@ -490,44 +560,42 @@ const Rating = React.forwardRef(function Rating(inProps, ref) {
precision,
);

return item(
{
value: itemDecimalValue,
filled: highlightSelectedOnly
? itemDecimalValue === value
: itemDecimalValue <= value,
hover: itemDecimalValue <= hover,
focus: itemDecimalValue <= focus,
checked: itemDecimalValue === valueRounded,
},
{
style:
items.length - 1 === indexDecimal
? {}
: {
width:
itemDecimalValue === value
? `${(indexDecimal + 1) * precision * 100}%`
: '0%',
overflow: 'hidden',
zIndex: 1,
position: 'absolute',
},
},
return (
<RatingItem
key={itemDecimalValue}
{...ratingItemProps}
// The icon is already displayed as active
isActive={false}
itemValue={itemDecimalValue}
labelProps={{
style:
items.length - 1 === indexDecimal
? {}
: {
width:
itemDecimalValue === value
? `${(indexDecimal + 1) * precision * 100}%`
: '0%',
overflow: 'hidden',
zIndex: 1,
position: 'absolute',
},
}}
/>
);
})}
</RatingDecimal>
);
}

return item({
value: itemValue,
active: itemValue === value && (hover !== -1 || focus !== -1),
filled: highlightSelectedOnly ? itemValue === value : itemValue <= value,
hover: itemValue <= hover,
focus: itemValue <= focus,
checked: itemValue === valueRounded,
});
return (
<RatingItem
key={itemValue}
{...ratingItemProps}
isActive={isActive}
itemValue={itemValue}
/>
);
})}
{!readOnly && !disabled && (
<RatingLabel
Expand Down
6 changes: 3 additions & 3 deletions packages/material-ui/src/Rating/Rating.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ describe('<Rating />', () => {
const handleChange = spy();
const { container } = render(<Rating name="rating-test" onChange={handleChange} value={2} />);

fireEvent.click(container.querySelector('#rating-test-2'), {
fireEvent.click(container.querySelector('input[name="rating-test"][value="2"]'), {
clientX: 1,
});

Expand All @@ -77,7 +77,7 @@ describe('<Rating />', () => {
it('should select the rating', () => {
const handleChange = spy();
const { container } = render(<Rating name="rating-test" onChange={handleChange} value={2} />);
fireEvent.click(container.querySelector('#rating-test-3'));
fireEvent.click(container.querySelector('input[name="rating-test"][value="3"]'));
expect(handleChange.callCount).to.equal(1);
expect(handleChange.args[0][1]).to.deep.equal(3);
const checked = container.querySelector('input[name="rating-test"]:checked');
Expand Down Expand Up @@ -105,7 +105,7 @@ describe('<Rating />', () => {
checked = container.querySelector('input[name="rating-test"]:checked');
expect(checked.value).to.equal('3');

fireEvent.click(container.querySelector('#rating-test-2'));
fireEvent.click(container.querySelector('input[name="rating-test"][value="2"]'));
checked = container.querySelector('input[name="rating-test"]:checked');
expect(checked.value).to.equal('2');
});
Expand Down
6 changes: 6 additions & 0 deletions test/regressions/fixtures/Rating/PreciseFocusVisibleRating.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import * as React from 'react';
import Rating from '@material-ui/core/Rating';

export default function FocusVisibleRating() {
return <Rating name="no-value-precise" precision={0.5} value={0.5} />;
}
11 changes: 11 additions & 0 deletions test/regressions/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,17 @@ async function main() {
await page.keyboard.press('ArrowLeft');
await takeScreenshot({ testcase, route: '/regression-Rating/FocusVisibleRating3' });
});

it('should handle focus-visible with precise ratings correctly', async () => {
const index = routes.findIndex(
(route) => route === '/regression-Rating/PreciseFocusVisibleRating',
);
const testcase = await renderFixture(index);
await page.keyboard.press('Tab');
await takeScreenshot({ testcase, route: '/regression-Rating/PreciseFocusVisibleRating2' });
await page.keyboard.press('ArrowRight');
await takeScreenshot({ testcase, route: '/regression-Rating/PreciseFocusVisibleRating3' });
});
});

describe('DateTimePicker', () => {
Expand Down