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

[List] Migrate ListItemText to emotion #24602

Merged
merged 20 commits into from
Jan 25, 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
5 changes: 3 additions & 2 deletions docs/pages/api-docs/list-item-text.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"primary": { "type": { "name": "node" } },
"primaryTypographyProps": { "type": { "name": "object" } },
"secondary": { "type": { "name": "node" } },
"secondaryTypographyProps": { "type": { "name": "object" } }
"secondaryTypographyProps": { "type": { "name": "object" } },
"sx": { "type": { "name": "object" } }
},
"name": "ListItemText",
"styles": {
Expand All @@ -20,6 +21,6 @@
"filename": "/packages/material-ui/src/ListItemText/ListItemText.js",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/lists/\">Lists</a></li></ul>",
"styledComponent": false,
"styledComponent": true,
"cssComponent": false
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"primary": "The main content element.",
"primaryTypographyProps": "These props will be forwarded to the primary typography component (as long as disableTypography is not <code>true</code>).",
"secondary": "The secondary content element.",
"secondaryTypographyProps": "These props will be forwarded to the secondary typography component (as long as disableTypography is not <code>true</code>)."
"secondaryTypographyProps": "These props will be forwarded to the secondary typography component (as long as disableTypography is not <code>true</code>).",
"sx": "The system prop that allows defining system overrides as well as additional CSS styles. See the <a href=\"/system/basics/#the-sx-prop\">`sx` page</a> for more details."
},
"classDescriptions": {
"root": { "description": "Styles applied to the root element." },
Expand Down
7 changes: 6 additions & 1 deletion packages/material-ui/src/ListItemText/ListItemText.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { SxProps } from '@material-ui/system';
import * as React from 'react';
import { InternalStandardProps as StandardProps } from '..';
import { InternalStandardProps as StandardProps, Theme } from '..';
import { TypographyProps } from '../Typography';

export interface ListItemTextProps<
Expand Down Expand Up @@ -65,6 +66,10 @@ export interface ListItemTextProps<
SecondaryTypographyComponent,
{ component?: SecondaryTypographyComponent }
>;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
}

export type ListItemTextClassKey = keyof NonNullable<ListItemTextProps['classes']>;
Expand Down
112 changes: 75 additions & 37 deletions packages/material-ui/src/ListItemText/ListItemText.js
Original file line number Diff line number Diff line change
@@ -1,39 +1,68 @@
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import withStyles from '../styles/withStyles';
import { deepmerge } from '@material-ui/utils';
import { unstable_composeClasses as composeClasses } from '@material-ui/unstyled';
import Typography from '../Typography';
import ListContext from '../List/ListContext';
import useThemeProps from '../styles/useThemeProps';
import experimentalStyled from '../styles/experimentalStyled';
import listItemTextClasses, { getListItemTextUtilityClass } from './listItemTextClasses';

export const styles = {
/* Styles applied to the root element. */
root: {
flex: '1 1 auto',
minWidth: 0,
marginTop: 4,
marginBottom: 4,
},
/* Styles applied to the Typography component if primary and secondary are set. */
multiline: {
marginTop: 6,
marginBottom: 6,
const overridesResolver = (props, styles) => {
const { styleProps } = props;

return deepmerge(styles.root || {}, {
...(styleProps.inset && styles.inset),
...(styleProps.primary && styleProps.secondary && styles.multiline),
...(styleProps.dense && styles.dense),
[`& .${listItemTextClasses.primary}`]: styles.primary,
[`& .${listItemTextClasses.secondary}`]: styles.secondary,
});
};

const useUtilityClasses = (styleProps) => {
const { classes, inset, primary, secondary, dense } = styleProps;

const slots = {
root: ['root', inset && 'inset', dense && 'dense', primary && secondary && 'multiline'],
primary: ['primary'],
secondary: ['secondary'],
};

return composeClasses(slots, getListItemTextUtilityClass, classes);
};

const ListItemTextRoot = experimentalStyled(
'div',
{},
{
name: 'MuiListItemText',
slot: 'Root',
overridesResolver,
},
/* Styles applied to the Typography component if dense. */
dense: {},
)(({ styleProps }) => ({
/* Styles applied to the root element. */
flex: '1 1 auto',
minWidth: 0,
marginTop: 4,
marginBottom: 4,
/* Styles applied to the root if primary and secondary are set. */
...(styleProps.primary &&
styleProps.secondary && {
marginTop: 6,
marginBottom: 6,
}),
/* Styles applied to the root element if `inset={true}`. */
inset: {
...(styleProps.inset && {
paddingLeft: 56,
},
/* Styles applied to the primary `Typography` component. */
primary: {},
/* Styles applied to the secondary `Typography` component. */
secondary: {},
};
}),
}));

const ListItemText = React.forwardRef(function ListItemText(props, ref) {
const ListItemText = React.forwardRef(function ListItemText(inProps, ref) {
const props = useThemeProps({ props: inProps, name: 'MuiListItemText' });
const {
children,
classes,
className,
disableTypography = false,
inset = false,
Expand All @@ -46,6 +75,19 @@ const ListItemText = React.forwardRef(function ListItemText(props, ref) {
const { dense } = React.useContext(ListContext);

let primary = primaryProp != null ? primaryProp : children;
let secondary = secondaryProp;

const styleProps = {
...props,
disableTypography,
inset,
primary: !!primary,
secondary: !!secondary,
dense,
};

const classes = useUtilityClasses(styleProps);

if (primary != null && primary.type !== Typography && !disableTypography) {
primary = (
<Typography
Expand All @@ -60,7 +102,6 @@ const ListItemText = React.forwardRef(function ListItemText(props, ref) {
);
}

let secondary = secondaryProp;
if (secondary != null && secondary.type !== Typography && !disableTypography) {
secondary = (
<Typography
Expand All @@ -76,22 +117,15 @@ const ListItemText = React.forwardRef(function ListItemText(props, ref) {
}

return (
<div
className={clsx(
classes.root,
{
[classes.dense]: dense,
[classes.inset]: inset,
[classes.multiline]: primary && secondary,
},
className,
)}
<ListItemTextRoot
className={clsx(classes.root, className)}
styleProps={styleProps}
ref={ref}
{...other}
>
{primary}
{secondary}
</div>
</ListItemTextRoot>
);
});

Expand Down Expand Up @@ -144,6 +178,10 @@ ListItemText.propTypes = {
* (as long as disableTypography is not `true`).
*/
secondaryTypographyProps: PropTypes.object,
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: PropTypes.object,
};

export default withStyles(styles, { name: 'MuiListItemText' })(ListItemText);
export default ListItemText;
15 changes: 7 additions & 8 deletions packages/material-ui/src/ListItemText/ListItemText.test.js
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
import * as React from 'react';
import { expect } from 'chai';
import { getClasses, createMount, createClientRender, describeConformance } from 'test/utils';
import { createMount, createClientRender, describeConformanceV5 } from 'test/utils';
import Typography, { typographyClasses } from '../Typography';
import ListItemText from './ListItemText';
import classes from './listItemTextClasses';

describe('<ListItemText />', () => {
const mount = createMount();
const render = createClientRender();
let classes;

before(() => {
classes = getClasses(<ListItemText />);
});

describeConformance(<ListItemText />, () => ({
describeConformanceV5(<ListItemText>Conformance?</ListItemText>, () => ({
classes,
inheritComponent: 'div',
mount,
muiName: 'MuiListItemText',
testVariantProps: { inset: true },
testDeepOverrides: { slotName: 'primary', slotClassName: classes.primary },
refInstanceof: window.HTMLDivElement,
skip: ['componentProp'],
skip: ['componentProp', 'componentsProp'],
}));

it('should render with inset class', () => {
Expand Down
3 changes: 3 additions & 0 deletions packages/material-ui/src/ListItemText/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
export { default } from './ListItemText';
export * from './ListItemText';

export { default as listItemTextClasses } from './listItemTextClasses';
export * from './listItemTextClasses';
3 changes: 3 additions & 0 deletions packages/material-ui/src/ListItemText/index.js
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
export { default } from './ListItemText';

export { default as listItemTextClasses } from './listItemTextClasses';
export * from './listItemTextClasses';
14 changes: 14 additions & 0 deletions packages/material-ui/src/ListItemText/listItemTextClasses.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
export interface ListItemTextClasses {
root: string;
multiline: string;
dense: string;
inset: string;
primary: string;
secondary: string;
}

declare const listItemTextClasses: ListItemTextClasses;

export function getListItemTextUtilityClass(slot: string): string;

export default listItemTextClasses;
16 changes: 16 additions & 0 deletions packages/material-ui/src/ListItemText/listItemTextClasses.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { generateUtilityClass, generateUtilityClasses } from '@material-ui/unstyled';

export function getListItemTextUtilityClass(slot) {
return generateUtilityClass('MuiListItemText', slot);
}

const listItemTextClasses = generateUtilityClasses('MuiListItemText', [
'root',
'multiline',
'dense',
'inset',
'primary',
'secondary',
]);

export default listItemTextClasses;