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

[Table] Migrate TableContainer to emotion #24666

Merged
merged 4 commits into from
Jan 28, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/pages/api-docs/table-container.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"props": {
"children": { "type": { "name": "node" } },
"classes": { "type": { "name": "object" } },
"component": { "type": { "name": "elementType" } }
"component": { "type": { "name": "elementType" } },
"sx": { "type": { "name": "object" } }
},
"name": "TableContainer",
"styles": { "classes": ["root"], "globalClasses": {}, "name": "MuiTableContainer" },
Expand All @@ -11,6 +12,6 @@
"filename": "/packages/material-ui/src/TableContainer/TableContainer.js",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/tables/\">Tables</a></li></ul>",
"styledComponent": false,
"styledComponent": true,
"cssComponent": false
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"propDescriptions": {
"children": "The content of the component, normally <code>Table</code>.",
"classes": "Override or extend the styles applied to the component. See <a href=\"#css\">CSS API</a> below for more details.",
"component": "The component used for the root node. Either a string to use a HTML element or a component."
"component": "The component used for the root node. Either a string to use a HTML element or a component.",
"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." } }
}
6 changes: 6 additions & 0 deletions packages/material-ui/src/TableContainer/TableContainer.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { SxProps } from '@material-ui/system';
import * as React from 'react';
import { Theme } from '..';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';

export interface TableContainerTypeMap<P = {}, D extends React.ElementType = 'div'> {
Expand All @@ -14,6 +16,10 @@ export interface TableContainerTypeMap<P = {}, D extends React.ElementType = 'di
/** Styles applied to the root element. */
root?: string;
};
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
};
defaultComponent: D;
}
Expand Down
63 changes: 52 additions & 11 deletions packages/material-ui/src/TableContainer/TableContainer.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,57 @@
import * as React from 'react';
import PropTypes from 'prop-types';
import clsx from 'clsx';
import withStyles from '../styles/withStyles';
import { unstable_composeClasses as composeClasses } from '@material-ui/unstyled';
import useThemeProps from '../styles/useThemeProps';
import experimentalStyled from '../styles/experimentalStyled';
import { getTableContainerUtilityClass } from './tableContainerClasses';

export const styles = {
/* Styles applied to the root element. */
root: {
width: '100%',
overflowX: 'auto',
},
const overridesResolver = (props, styles) => styles.root || {};

const useUtilityClasses = (styleProps) => {
const { classes } = styleProps;

const slots = {
root: ['root'],
};

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

const TableContainer = React.forwardRef(function TableContainer(props, ref) {
const { classes, className, component: Component = 'div', ...other } = props;
const TableContainerRoot = experimentalStyled(
'div',
{},
{
name: 'MuiTableContainer',
slot: 'Root',
overridesResolver,
},
)({
/* Styles applied to the root element. */
width: '100%',
overflowX: 'auto',
});

const TableContainer = React.forwardRef(function TableContainer(inProps, ref) {
const props = useThemeProps({ props: inProps, name: 'MuiTableContainer' });
const { className, component = 'div', ...other } = props;

const styleProps = {
...props,
component,
};

return <Component ref={ref} className={clsx(classes.root, className)} {...other} />;
const classes = useUtilityClasses(styleProps);

return (
<TableContainerRoot
ref={ref}
as={component}
className={clsx(classes.root, className)}
styleProps={styleProps}
{...other}
/>
);
});

TableContainer.propTypes = {
Expand All @@ -39,6 +76,10 @@ TableContainer.propTypes = {
* Either a string to use a HTML element or a component.
*/
component: PropTypes.elementType,
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: PropTypes.object,
};

export default withStyles(styles, { name: 'MuiTableContainer' })(TableContainer);
export default TableContainer;
13 changes: 6 additions & 7 deletions packages/material-ui/src/TableContainer/TableContainer.test.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
import * as React from 'react';
import { getClasses, createMount, describeConformance } from 'test/utils';
import { createMount, describeConformanceV5 } from 'test/utils';
import TableContainer from './TableContainer';
import classes from './tableContainerClasses';

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

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

describeConformance(<TableContainer />, () => ({
describeConformanceV5(<TableContainer />, () => ({
classes,
inheritComponent: 'div',
mount,
muiName: 'MuiTableContainer',
testVariantProps: { variant: 'foo' },
refInstanceof: window.HTMLDivElement,
testComponentPropWith: 'span',
skip: ['componentsProp'],
}));
});
3 changes: 3 additions & 0 deletions packages/material-ui/src/TableContainer/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
export { default } from './TableContainer';
export * from './TableContainer';

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

export { default as tableContainerClasses } from './tableContainerClasses';
export * from './tableContainerClasses';
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export interface TableContainerClasses {
root: string;
}

declare const tableContainerClasses: TableContainerClasses;

export function getTableContainerUtilityClass(slot: string): string;

export default tableContainerClasses;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { generateUtilityClass, generateUtilityClasses } from '@material-ui/unstyled';

export function getTableContainerUtilityClass(slot) {
return generateUtilityClass('MuiTableContainer', slot);
}

const tableContainerClasses = generateUtilityClasses('MuiTableContainer', ['root']);

export default tableContainerClasses;