Skip to content
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

[Chip] Fix Avatar CSS issue #18156

Merged

Conversation

oliviertassinari
Copy link
Member

Closes #16374.

Our documentation reproduces the problem, we can verify the fix directly with the Netlify preview.

@oliviertassinari oliviertassinari added the component: chip This is the name of the generic UI component, not the React module! label Nov 2, 2019
@mui-pr-bot
Copy link

mui-pr-bot commented Nov 2, 2019

Details of bundle changes.

Comparing: 8a78af8...6e01dee

bundle Size Change Size Gzip Change Gzip
@material-ui/core ▲ +91 B (+0.03% ) 349 kB ▲ +20 B (+0.02% ) 95.4 kB
Autocomplete ▲ +91 B (+0.07% ) 125 kB ▲ +17 B (+0.04% ) 39.5 kB
@material-ui/lab ▲ +91 B (+0.05% ) 168 kB ▲ +15 B (+0.03% ) 50.6 kB
@material-ui/core[umd] ▲ +91 B (+0.03% ) 308 kB ▲ +14 B (+0.02% ) 88.8 kB
Chip ▲ +90 B (+0.11% ) 81 kB ▲ +16 B (+0.06% ) 24.7 kB
Select ▼ -1 B (-0.00% ) 112 kB ▼ -2 B (-0.01% ) 33.4 kB
Fab ▼ -1 B (-0.00% ) 75.1 kB -- 23.3 kB
FormControl ▼ -1 B (-0.00% ) 62.8 kB -- 19.5 kB
FormLabel ▼ -1 B (-0.00% ) 61.9 kB -- 19.1 kB
ListItem ▼ -1 B (-0.00% ) 75.4 kB -- 23.5 kB
MenuItem ▼ -1 B (-0.00% ) 76.4 kB -- 23.8 kB
StepIcon ▼ -1 B (-0.00% ) 63.1 kB -- 19.6 kB
Tooltip ▼ -1 B (-0.00% ) 97.7 kB -- 30.9 kB
StepConnector -- 61.2 kB ▲ +9 B (+0.05% ) 19.2 kB
TreeItem -- 71.8 kB ▼ -7 B (-0.03% ) 22.6 kB
Button -- 77.8 kB ▲ +6 B (+0.02% ) 24.1 kB
Avatar -- 61.1 kB ▼ -5 B (-0.03% ) 19.2 kB
Stepper -- 63.2 kB ▲ +5 B (+0.03% ) 19.9 kB
ListItemSecondaryAction -- 60.5 kB ▲ +4 B (+0.02% ) 18.9 kB
TableCell -- 62.5 kB ▼ -4 B (-0.02% ) 19.6 kB
@material-ui/system -- 14.8 kB ▼ -3 B (-0.07% ) 4.06 kB
Box -- 69.2 kB ▲ +3 B (+0.01% ) 20.9 kB
CircularProgress -- 62.5 kB ▲ +3 B (+0.02% ) 19.7 kB
AppBar -- 62.2 kB ▲ +2 B (+0.01% ) 19.5 kB
Breadcrumbs -- 66.4 kB ▲ +2 B (+0.01% ) 20.8 kB
CardActionArea -- 73.3 kB ▲ +2 B (+0.01% ) 23.1 kB
CardActions -- 60.5 kB ▼ -2 B (-0.01% ) 18.9 kB
RadioGroup -- 61.7 kB ▲ +2 B (+0.01% ) 19.3 kB
SpeedDialIcon -- 63 kB ▼ -2 B (-0.01% ) 19.8 kB
StepButton -- 80.6 kB ▼ -2 B (-0.01% ) 25.3 kB
Tab -- 74.6 kB ▼ -2 B (-0.01% ) 23.6 kB
TreeView -- 64.4 kB ▼ -2 B (-0.01% ) 20.1 kB
@material-ui/styles -- 50.8 kB ▲ +1 B (+0.01% ) 15.4 kB
Badge -- 63.8 kB ▼ -1 B (-0.01% ) 19.7 kB
BottomNavigation -- 60.8 kB ▲ +1 B (+0.01% ) 19 kB
BottomNavigationAction -- 73.8 kB ▼ -1 B (-0.00% ) 23.3 kB
Card -- 61.2 kB ▼ -1 B (-0.01% ) 19.1 kB
CardContent -- 60.4 kB ▼ -1 B (-0.01% ) 18.9 kB
CardHeader -- 63.5 kB ▲ +1 B (+0.01% ) 20 kB
Checkbox -- 80 kB ▲ +1 B (0.00% ) 25.1 kB
ClickAwayListener -- 3.85 kB ▼ -1 B (-0.06% ) 1.55 kB
Container -- 61.6 kB ▼ -1 B (-0.01% ) 19.2 kB
CssBaseline -- 56 kB ▼ -1 B (-0.01% ) 17.5 kB
Dialog -- 80.9 kB ▼ -1 B (-0.00% ) 25.1 kB
DialogActions -- 60.5 kB ▼ -1 B (-0.01% ) 18.9 kB
FormControlLabel -- 64 kB ▲ +1 B (0.00% ) 20.1 kB
FormHelperText -- 61.7 kB ▼ -1 B (-0.01% ) 19.3 kB
Grid -- 63.5 kB ▼ -1 B (-0.01% ) 19.9 kB
GridListTileBar -- 61.7 kB ▼ -1 B (-0.01% ) 19.3 kB
Hidden -- 64.5 kB ▲ +1 B (0.00% ) 20.2 kB
Icon -- 61.2 kB ▼ -1 B (-0.01% ) 19.2 kB
InputLabel -- 63.8 kB ▼ -1 B (-0.01% ) 19.8 kB
Link -- 65 kB ▼ -1 B (-0.00% ) 20.6 kB
ListItemText -- 63.4 kB ▼ -1 B (-0.01% ) 19.9 kB
Radio -- 80.9 kB ▼ -1 B (-0.00% ) 25.4 kB
RootRef -- 4.43 kB ▲ +1 B (+0.06% ) 1.67 kB
Skeleton -- 60.9 kB ▼ -1 B (-0.01% ) 19.1 kB
Slider -- 73.8 kB ▲ +1 B (0.00% ) 23.3 kB
Snackbar -- 75.6 kB ▼ -1 B (-0.00% ) 23.5 kB
SnackbarContent -- 64.1 kB ▲ +1 B (0.00% ) 20.1 kB
StepContent -- 67.4 kB ▼ -1 B (-0.00% ) 21 kB
StepLabel -- 67 kB ▲ +1 B (0.00% ) 21 kB
SwipeableDrawer -- 90.1 kB ▼ -1 B (-0.00% ) 27.9 kB
TableHead -- 60.6 kB ▼ -1 B (-0.01% ) 18.9 kB
TablePagination -- 139 kB ▲ +1 B (0.00% ) 40.5 kB
TableSortLabel -- 75.6 kB ▼ -1 B (-0.00% ) 23.9 kB
TextField -- 121 kB ▲ +1 B (0.00% ) 35.4 kB
ToggleButton -- 74.4 kB ▼ -1 B (-0.00% ) 23.5 kB
Toolbar -- 60.8 kB ▼ -1 B (-0.01% ) 19 kB
useAutocomplete -- 11.1 kB ▲ +1 B (+0.02% ) 4.21 kB
useMediaQuery -- 2.49 kB ▲ +1 B (+0.10% ) 1.05 kB
Backdrop -- 66.2 kB -- 20.4 kB
ButtonBase -- 72.3 kB -- 22.6 kB
ButtonGroup -- 62.7 kB -- 19.5 kB
CardMedia -- 60.8 kB -- 19.1 kB
Collapse -- 66.3 kB -- 20.5 kB
colorManipulator -- 3.83 kB -- 1.52 kB
DialogContent -- 60.7 kB -- 19 kB
DialogContentText -- 62.5 kB -- 19.6 kB
DialogTitle -- 62.7 kB -- 19.7 kB
Divider -- 61 kB -- 19.1 kB
docs.landing -- 56 kB -- 14.6 kB
docs.main -- 602 kB -- 192 kB
Drawer -- 82.7 kB -- 25.6 kB
ExpansionPanel -- 69.7 kB -- 21.7 kB
ExpansionPanelActions -- 60.5 kB -- 18.9 kB
ExpansionPanelDetails -- 60.4 kB -- 18.9 kB
ExpansionPanelSummary -- 76.4 kB -- 24.1 kB
Fade -- 22 kB -- 7.6 kB
FilledInput -- 72 kB -- 22.3 kB
FormGroup -- 60.5 kB -- 18.9 kB
GridList -- 60.9 kB -- 19.1 kB
GridListTile -- 62.2 kB -- 19.5 kB
Grow -- 22.6 kB -- 7.72 kB
IconButton -- 74.4 kB -- 23.2 kB
Input -- 70.9 kB -- 22.1 kB
InputAdornment -- 63.5 kB -- 20 kB
InputBase -- 69.1 kB -- 21.6 kB
LinearProgress -- 63.8 kB -- 19.9 kB
List -- 60.8 kB -- 18.9 kB
ListItemAvatar -- 60.6 kB -- 18.9 kB
ListItemIcon -- 60.6 kB -- 19 kB
ListSubheader -- 61.2 kB -- 19.2 kB
Menu -- 86.6 kB -- 27.2 kB
MenuList -- 64.4 kB -- 20.1 kB
MobileStepper -- 66.2 kB -- 20.6 kB
Modal -- 14.2 kB -- 4.96 kB
NativeSelect -- 75.2 kB -- 23.7 kB
NoSsr -- 2.19 kB -- 1.04 kB
OutlinedInput -- 72.5 kB -- 22.5 kB
Paper -- 60.7 kB -- 18.9 kB
Popover -- 81 kB -- 25 kB
Popper -- 28.5 kB -- 10.2 kB
Portal -- 2.87 kB -- 1.29 kB
Rating -- 68.3 kB -- 21.8 kB
Slide -- 24.1 kB -- 8.21 kB
SpeedDial -- 84.3 kB -- 26.5 kB
SpeedDialAction -- 114 kB -- 36 kB
Step -- 61.1 kB -- 19.1 kB
styles/createMuiTheme -- 15.2 kB -- 5.36 kB
SvgIcon -- 61.5 kB -- 19.1 kB
Switch -- 79.3 kB -- 24.7 kB
Table -- 61 kB -- 19.1 kB
TableBody -- 60.5 kB -- 18.9 kB
TableFooter -- 60.6 kB -- 18.9 kB
TableRow -- 61 kB -- 19.1 kB
Tabs -- 83.7 kB -- 26.6 kB
TextareaAutosize -- 5.06 kB -- 2.11 kB
ToggleButtonGroup -- 61.6 kB -- 19.4 kB
Typography -- 62.1 kB -- 19.3 kB
Zoom -- 22.1 kB -- 7.6 kB

Generated by 🚫 dangerJS against 6e01dee

@oliviertassinari oliviertassinari added the bug 🐛 Something doesn't work label Nov 3, 2019
@@ -8,7 +8,6 @@ import useForkRef from '../utils/useForkRef';
import unsupportedProp from '../utils/unsupportedProp';
import capitalize from '../utils/capitalize';
import ButtonBase from '../ButtonBase';
import '../Avatar'; // So we don't have any override priority issue.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think a "harmless" side-effect such as Avatar.propTypes = Avatar.propTypes (or similar, like Avatar.a = Avatar.a) might suffice? I'm on holiday rn so I don't have much time to look into this issue myself, sorry.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After more reflexion, I think that having to pull out another module to get the correct side effect isn't right. It prevents tree-shaking. Autocomplete users shouldn't bundle the Avatar if they don't use it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enjoy your holidays 👍

@@ -42,6 +41,29 @@ export const styles = theme => {
opacity: 0.5,
pointerEvents: 'none',
},
'& $avatar': {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious whether or not you deem this a breaking change because strictly speaking specificity is increased 😅

Copy link
Member Author

@oliviertassinari oliviertassinari Nov 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The outlined variant already increases the specificity to style the avatar.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True - but let's say someone was just specifying a single avatar class name, they'd now need to also do & $avatar. Maybe not a big concern - I was more just curious to hear your perspective on breaking/non-breaking changes so we can adopt the same principle at my workplace.

Copy link
Member Author

@oliviertassinari oliviertassinari Nov 3, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NMinhNguyen If somebody has overridden the class, he would likely face #16374, as we do. He would already be forced to increase the specificity.

@oliviertassinari oliviertassinari marked this pull request as ready for review November 3, 2019 10:16
@oliviertassinari oliviertassinari changed the title [Chip] Force Avatar side-effect [Chip] Fix Avatar CSS issue Nov 3, 2019
oliviertassinari and others added 2 commits November 3, 2019 13:38
Co-Authored-By: Minh Nguyen <minhnguyenxx@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something doesn't work component: chip This is the name of the generic UI component, not the React module!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CSS rules specificity is order dependent on chips
3 participants