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

[Accordion] Migrate AccordionActions to emotion #24538

Merged
merged 2 commits into from
Jan 22, 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/accordion-actions.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" } },
"disableSpacing": { "type": { "name": "bool" } }
"disableSpacing": { "type": { "name": "bool" } },
"sx": { "type": { "name": "object" } }
},
"name": "AccordionActions",
"styles": { "classes": ["root", "spacing"], "globalClasses": {}, "name": "MuiAccordionActions" },
Expand All @@ -11,6 +12,6 @@
"filename": "/packages/material-ui/src/AccordionActions/AccordionActions.js",
"inheritance": null,
"demos": "<ul><li><a href=\"/components/accordion/\">Accordion</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.",
"classes": "Override or extend the styles applied to the component. See <a href=\"#css\">CSS API</a> below for more details.",
"disableSpacing": "If <code>true</code>, the actions do not have additional margin."
"disableSpacing": "If <code>true</code>, the actions do not have additional margin.",
"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
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as React from 'react';
import { InternalStandardProps as StandardProps } from '..';
import { SxProps } from '@material-ui/system';
import { InternalStandardProps as StandardProps, Theme } from '..';

export interface AccordionActionsProps extends StandardProps<React.HTMLAttributes<HTMLDivElement>> {
/**
Expand All @@ -20,6 +21,10 @@ export interface AccordionActionsProps extends StandardProps<React.HTMLAttribute
* @default false
*/
disableSpacing?: boolean;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
}

export type AccordionActionsClassKey = keyof NonNullable<AccordionActionsProps['classes']>;
Expand Down
71 changes: 54 additions & 17 deletions packages/material-ui/src/AccordionActions/AccordionActions.js
Original file line number Diff line number Diff line change
@@ -1,31 +1,64 @@
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 experimentalStyled from '../styles/experimentalStyled';
import useThemeProps from '../styles/useThemeProps';
import { getAccordionActionsUtilityClass } from './accordionActionsClasses';

export const styles = {
/* Styles applied to the root element. */
root: {
display: 'flex',
alignItems: 'center',
padding: 8,
justifyContent: 'flex-end',
const overridesResolver = (props, styles) => {
const { styleProps } = props;

return deepmerge(styles.root || {}, {
...(!styleProps.disableSpacing && styles.spacing),
});
};

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

const slots = {
root: ['root', !disableSpacing && 'spacing'],
};

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

const AccordionActionsRoot = experimentalStyled(
'div',
{},
{
name: 'MuiAccordionActions',
slot: 'Root',
overridesResolver,
},
)(({ styleProps }) => ({
/* Styles applied to the root element. */
display: 'flex',
alignItems: 'center',
padding: 8,
justifyContent: 'flex-end',
/* Styles applied to the root element unless `disableSpacing={true}`. */
spacing: {
'& > :not(:first-child)': {
...(!styleProps.disableSpacing && {
'& > :not(:first-of-type)': {
marginLeft: 8,
},
},
};
}),
}));

const AccordionActions = React.forwardRef(function AccordionActions(props, ref) {
const { classes, className, disableSpacing = false, ...other } = props;
const AccordionActions = React.forwardRef(function AccordionActions(inProps, ref) {
const props = useThemeProps({ props: inProps, name: 'MuiAccordionActions' });
const { className, disableSpacing = false, ...other } = props;
const styleProps = { ...props, disableSpacing };

const classes = useUtilityClasses(styleProps);

return (
<div
className={clsx(classes.root, { [classes.spacing]: !disableSpacing }, className)}
<AccordionActionsRoot
className={clsx(classes.root, className)}
ref={ref}
styleProps={styleProps}
{...other}
/>
);
Expand Down Expand Up @@ -53,6 +86,10 @@ AccordionActions.propTypes = {
* @default false
*/
disableSpacing: PropTypes.bool,
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: PropTypes.object,
};

export default withStyles(styles, { name: 'MuiAccordionActions' })(AccordionActions);
export default AccordionActions;
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
import * as React from 'react';
import { getClasses, createMount, describeConformance } from 'test/utils';
import { createMount, describeConformanceV5 } from 'test/utils';
import AccordionActions from './AccordionActions';
import classes from './accordionActionsClasses';

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

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

describeConformance(<AccordionActions>Conformance</AccordionActions>, () => ({
describeConformanceV5(<AccordionActions>Conformance</AccordionActions>, () => ({
classes,
inheritComponent: 'div',
mount,
refInstanceof: window.HTMLDivElement,
skip: ['componentProp'],
muiName: 'MuiAccordionActions',
testVariantProps: { disableSpacing: true },
skip: ['componentProp', 'componentsProp'],
}));
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export interface AccordionActionsClasses {
root: string;
spacing: string;
}

declare const accordionActionsClasses: AccordionActionsClasses;

export function getAccordionActionsUtilityClass(slot: string): string;

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

export function getAccordionActionsUtilityClass(slot) {
return generateUtilityClass('MuiAccordionActions', slot);
}

const accordionActionsClasses = generateUtilityClasses('MuiAccordionActions', ['root', 'spacing']);

export default accordionActionsClasses;
3 changes: 3 additions & 0 deletions packages/material-ui/src/AccordionActions/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
export { default } from './AccordionActions';
export * from './AccordionActions';

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

export { default as accordionActionsClasses } from './accordionActionsClasses';
export * from './accordionActionsClasses';