Last active
January 27, 2020 01:23
-
-
Save kof/82626399c24f8e20765abc8c4fc39dc8 to your computer and use it in GitHub Desktop.
Material-UI Switch using imaginary state machine
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Original implementation https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/Switch/Switch.js | |
// An attempt to use state machines inside of styles declaration. | |
const useStyles = createUseStyles({ | |
root: { | |
display: 'inline-flex', | |
overflow: 'hidden', | |
boxSizing: 'border-box', | |
position: 'relative', | |
flexShrink: 0, | |
zIndex: 0, // Reset the stacking context. | |
verticalAlign: 'middle', // For correct alignment with the text. | |
}, | |
switchBase: { | |
position: 'absolute', | |
top: 0, | |
left: 0, | |
zIndex: 1, // Render above the focus ripple. | |
color: theme.palette.type === 'light' ? theme.palette.grey[50] : theme.palette.grey[400], | |
transition: theme.transitions.create(['left', 'transform'], { | |
duration: theme.transitions.duration.shortest, | |
}), | |
'&$checked': { | |
transform: 'translateX(20px)', | |
}, | |
'&$disabled': { | |
color: theme.palette.type === 'light' ? theme.palette.grey[400] : theme.palette.grey[800], | |
}, | |
'&$checked + $track': { | |
opacity: 0.5, | |
}, | |
'&$disabled + $track': { | |
opacity: theme.palette.type === 'light' ? 0.12 : 0.1, | |
}, | |
}, | |
checked: {}, | |
disabled: {}, | |
input: { | |
left: '-100%', | |
width: '300%', | |
}, | |
thumb: { | |
boxShadow: theme.shadows[1], | |
backgroundColor: 'currentColor', | |
borderRadius: '50%', | |
}, | |
track: { | |
height: '100%', | |
width: '100%', | |
borderRadius: 14 / 2, | |
zIndex: -1, | |
transition: theme.transitions.create(['opacity', 'background-color'], { | |
duration: theme.transitions.duration.shortest, | |
}), | |
backgroundColor: | |
theme.palette.type === 'light' ? theme.palette.common.black : theme.palette.common.white, | |
opacity: theme.palette.type === 'light' ? 0.38 : 0.3, | |
}, | |
/* Rules from state machines */ | |
edge: fromState({ | |
initialState: 'none', | |
none: { | |
styles: null | |
}, | |
start: { | |
styles: { | |
marginLeft: -8, | |
} | |
}, | |
end: { | |
styles: { | |
marginRight: -8, | |
} | |
} | |
}), | |
size: fromState({ | |
initialState: 'medium', | |
medium: { | |
styles: { | |
width: 34 + 12 * 2, | |
height: 14 + 12 * 2, | |
padding: 12, | |
'& $thumb': { | |
width: 20, | |
height: 20, | |
} | |
} | |
}, | |
small: { | |
styles: { | |
width: 40, | |
height: 24, | |
padding: 7, | |
'& $thumb': { | |
width: 16, | |
height: 16, | |
}, | |
'& $switchBase': { | |
padding: 4, | |
'&$checked': { | |
transform: 'translateX(16px)', | |
}, | |
}, | |
} | |
} | |
}), | |
color: fromState({ | |
initialState: 'secondary', | |
primary: { | |
styles: { | |
'&$checked': { | |
color: theme.palette.primary.main, | |
'&:hover': { | |
backgroundColor: fade(theme.palette.primary.main, theme.palette.action.hoverOpacity), | |
'@media (hover: none)': { | |
backgroundColor: 'transparent', | |
}, | |
}, | |
}, | |
'&$disabled': { | |
color: theme.palette.type === 'light' ? theme.palette.grey[400] : theme.palette.grey[800], | |
}, | |
'&$checked + $track': { | |
backgroundColor: theme.palette.primary.main, | |
}, | |
'&$disabled + $track': { | |
backgroundColor: | |
theme.palette.type === 'light' ? theme.palette.common.black : theme.palette.common.white, | |
}, | |
} | |
}, | |
secondary: { | |
styles { | |
'&$checked': { | |
color: theme.palette.secondary.main, | |
'&:hover': { | |
backgroundColor: fade(theme.palette.secondary.main, theme.palette.action.hoverOpacity), | |
'@media (hover: none)': { | |
backgroundColor: 'transparent', | |
}, | |
}, | |
}, | |
'&$disabled': { | |
color: theme.palette.type === 'light' ? theme.palette.grey[400] : theme.palette.grey[800], | |
}, | |
'&$checked + $track': { | |
backgroundColor: theme.palette.secondary.main, | |
}, | |
'&$disabled + $track': { | |
backgroundColor: | |
theme.palette.type === 'light' ? theme.palette.common.black : theme.palette.common.white, | |
}, | |
} | |
} | |
}) | |
}) | |
const Switch = React.forwardRef(function Switch(props, ref) { | |
const { | |
className, | |
color = 'secondary', | |
edge = false, | |
size = 'medium', | |
...other | |
} = props; | |
const classes = useStyles({edge, size, color}) | |
const icon = <span className={classes.thumb} />; | |
return ( | |
<span className={`${classes.root} ${classes.edge} ${classes.size} ${className}`}> | |
<SwitchBase | |
type="checkbox" | |
icon={icon} | |
checkedIcon={icon} | |
classes={{ | |
root: `${classes.switchBase} ${classes.color}`, | |
input: classes.input, | |
checked: classes.checked, | |
disabled: classes.disabled, | |
}} | |
ref={ref} | |
{...other} | |
/> | |
<span className={classes.track} /> | |
</span> | |
); | |
}); | |
Switch.propTypes = { | |
/** | |
* If `true`, the component is checked. | |
*/ | |
checked: PropTypes.bool, | |
/** | |
* The icon to display when the component is checked. | |
*/ | |
checkedIcon: PropTypes.node, | |
/** | |
* Override or extend the styles applied to the component. | |
* See [CSS API](#css) below for more details. | |
*/ | |
classes: PropTypes.object.isRequired, | |
/** | |
* @ignore | |
*/ | |
className: PropTypes.string, | |
/** | |
* The color of the component. It supports those theme colors that make sense for this component. | |
*/ | |
color: PropTypes.oneOf(['primary', 'secondary', 'default']), | |
/** | |
* @ignore | |
*/ | |
defaultChecked: PropTypes.bool, | |
/** | |
* If `true`, the switch will be disabled. | |
*/ | |
disabled: PropTypes.bool, | |
/** | |
* If `true`, the ripple effect will be disabled. | |
*/ | |
disableRipple: PropTypes.bool, | |
/** | |
* If given, uses a negative margin to counteract the padding on one | |
* side (this is often helpful for aligning the left or right | |
* side of the icon with content above or below, without ruining the border | |
* size and shape). | |
*/ | |
edge: PropTypes.oneOf(['start', 'end', false]), | |
/** | |
* The icon to display when the component is unchecked. | |
*/ | |
icon: PropTypes.node, | |
/** | |
* The id of the `input` element. | |
*/ | |
id: PropTypes.string, | |
/** | |
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element. | |
*/ | |
inputProps: PropTypes.object, | |
/** | |
* Pass a ref to the `input` element. | |
*/ | |
inputRef: refType, | |
/** | |
* Callback fired when the state is changed. | |
* | |
* @param {object} event The event source of the callback. | |
* You can pull out the new checked state by accessing `event.target.checked` (boolean). | |
*/ | |
onChange: PropTypes.func, | |
/** | |
* If `true`, the `input` element will be required. | |
*/ | |
required: PropTypes.bool, | |
/** | |
* The size of the switch. | |
* `small` is equivalent to the dense switch styling. | |
*/ | |
size: PropTypes.oneOf(['small', 'medium']), | |
/** | |
* The input component prop `type`. | |
*/ | |
type: PropTypes.string, | |
/** | |
* The value of the component. The DOM API casts this to a string. | |
*/ | |
value: PropTypes.any, | |
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// An attempt to use state machines for combining classes. | |
// @inheritedComponent IconButton | |
import React from 'react'; | |
import PropTypes from 'prop-types'; | |
import clsx from 'clsx'; | |
import { refType } from '@material-ui/utils'; | |
import withStyles from '../styles/withStyles'; | |
import { fade } from '../styles/colorManipulator'; | |
import capitalize from '../utils/capitalize'; | |
import SwitchBase from '../internal/SwitchBase'; | |
export const styles = theme => ({ | |
/* Styles applied to the root element. */ | |
root: { | |
display: 'inline-flex', | |
width: 34 + 12 * 2, | |
height: 14 + 12 * 2, | |
overflow: 'hidden', | |
padding: 12, | |
boxSizing: 'border-box', | |
position: 'relative', | |
flexShrink: 0, | |
zIndex: 0, // Reset the stacking context. | |
verticalAlign: 'middle', // For correct alignment with the text. | |
}, | |
/* Styles applied to the root element if `edge="start"`. */ | |
edgeStart: { | |
marginLeft: -8, | |
}, | |
/* Styles applied to the root element if `edge="end"`. */ | |
edgeEnd: { | |
marginRight: -8, | |
}, | |
/* Styles applied to the internal `SwitchBase` component's `root` class. */ | |
switchBase: { | |
position: 'absolute', | |
top: 0, | |
left: 0, | |
zIndex: 1, // Render above the focus ripple. | |
color: theme.palette.type === 'light' ? theme.palette.grey[50] : theme.palette.grey[400], | |
transition: theme.transitions.create(['left', 'transform'], { | |
duration: theme.transitions.duration.shortest, | |
}), | |
'&$checked': { | |
transform: 'translateX(20px)', | |
}, | |
'&$disabled': { | |
color: theme.palette.type === 'light' ? theme.palette.grey[400] : theme.palette.grey[800], | |
}, | |
'&$checked + $track': { | |
opacity: 0.5, | |
}, | |
'&$disabled + $track': { | |
opacity: theme.palette.type === 'light' ? 0.12 : 0.1, | |
}, | |
}, | |
/* Styles applied to the internal SwitchBase component's root element if `color="primary"`. */ | |
colorPrimary: { | |
'&$checked': { | |
color: theme.palette.primary.main, | |
'&:hover': { | |
backgroundColor: fade(theme.palette.primary.main, theme.palette.action.hoverOpacity), | |
'@media (hover: none)': { | |
backgroundColor: 'transparent', | |
}, | |
}, | |
}, | |
'&$disabled': { | |
color: theme.palette.type === 'light' ? theme.palette.grey[400] : theme.palette.grey[800], | |
}, | |
'&$checked + $track': { | |
backgroundColor: theme.palette.primary.main, | |
}, | |
'&$disabled + $track': { | |
backgroundColor: | |
theme.palette.type === 'light' ? theme.palette.common.black : theme.palette.common.white, | |
}, | |
}, | |
/* Styles applied to the internal SwitchBase component's root element if `color="secondary"`. */ | |
colorSecondary: { | |
'&$checked': { | |
color: theme.palette.secondary.main, | |
'&:hover': { | |
backgroundColor: fade(theme.palette.secondary.main, theme.palette.action.hoverOpacity), | |
'@media (hover: none)': { | |
backgroundColor: 'transparent', | |
}, | |
}, | |
}, | |
'&$disabled': { | |
color: theme.palette.type === 'light' ? theme.palette.grey[400] : theme.palette.grey[800], | |
}, | |
'&$checked + $track': { | |
backgroundColor: theme.palette.secondary.main, | |
}, | |
'&$disabled + $track': { | |
backgroundColor: | |
theme.palette.type === 'light' ? theme.palette.common.black : theme.palette.common.white, | |
}, | |
}, | |
/* Styles applied to the root element if `size="small"`. */ | |
sizeSmall: { | |
width: 40, | |
height: 24, | |
padding: 7, | |
'& $thumb': { | |
width: 16, | |
height: 16, | |
}, | |
'& $switchBase': { | |
padding: 4, | |
'&$checked': { | |
transform: 'translateX(16px)', | |
}, | |
}, | |
}, | |
/* Pseudo-class applied to the internal `SwitchBase` component's `checked` class. */ | |
checked: {}, | |
/* Pseudo-class applied to the internal SwitchBase component's disabled class. */ | |
disabled: {}, | |
/* Styles applied to the internal SwitchBase component's input element. */ | |
input: { | |
left: '-100%', | |
width: '300%', | |
}, | |
/* Styles used to create the thumb passed to the internal `SwitchBase` component `icon` prop. */ | |
thumb: { | |
boxShadow: theme.shadows[1], | |
backgroundColor: 'currentColor', | |
width: 20, | |
height: 20, | |
borderRadius: '50%', | |
}, | |
/* Styles applied to the track element. */ | |
track: { | |
height: '100%', | |
width: '100%', | |
borderRadius: 14 / 2, | |
zIndex: -1, | |
transition: theme.transitions.create(['opacity', 'background-color'], { | |
duration: theme.transitions.duration.shortest, | |
}), | |
backgroundColor: | |
theme.palette.type === 'light' ? theme.palette.common.black : theme.palette.common.white, | |
opacity: theme.palette.type === 'light' ? 0.38 : 0.3, | |
}, | |
}); | |
const classStates = { | |
edge: { | |
initial: false, | |
start: 'edgeStart', | |
end: 'edgeEnd' | |
}, | |
size: { | |
initial: 'medium', | |
small: 'sizeSmall', | |
medium: 'sizeMedium' | |
}, | |
color: { | |
initial: 'secondary', | |
primary: 'colorPrimary', | |
secondary: 'colorSecondary' | |
} | |
} | |
const Switch = React.forwardRef(function Switch(props, ref) { | |
const { | |
classes, | |
className, | |
color, | |
edge, | |
size, | |
...other | |
} = props; | |
const icon = <span className={classes.thumb} />; | |
const cls = ClassesStateMachine(classes, classStates) | |
return ( | |
<span className={cls({root: true, edge, size}, className)}> | |
<SwitchBase | |
type="checkbox" | |
icon={icon} | |
checkedIcon={icon} | |
classes={{ | |
root: cls({switchBase: true, color}), | |
input: classes.input, | |
checked: classes.checked, | |
disabled: classes.disabled, | |
}} | |
ref={ref} | |
{...other} | |
/> | |
<span className={classes.track} /> | |
</span> | |
); | |
}); | |
Switch.propTypes = { | |
/** | |
* If `true`, the component is checked. | |
*/ | |
checked: PropTypes.bool, | |
/** | |
* The icon to display when the component is checked. | |
*/ | |
checkedIcon: PropTypes.node, | |
/** | |
* Override or extend the styles applied to the component. | |
* See [CSS API](#css) below for more details. | |
*/ | |
classes: PropTypes.object.isRequired, | |
/** | |
* @ignore | |
*/ | |
className: PropTypes.string, | |
/** | |
* The color of the component. It supports those theme colors that make sense for this component. | |
*/ | |
color: PropTypes.oneOf(['primary', 'secondary', 'default']), | |
/** | |
* @ignore | |
*/ | |
defaultChecked: PropTypes.bool, | |
/** | |
* If `true`, the switch will be disabled. | |
*/ | |
disabled: PropTypes.bool, | |
/** | |
* If `true`, the ripple effect will be disabled. | |
*/ | |
disableRipple: PropTypes.bool, | |
/** | |
* If given, uses a negative margin to counteract the padding on one | |
* side (this is often helpful for aligning the left or right | |
* side of the icon with content above or below, without ruining the border | |
* size and shape). | |
*/ | |
edge: PropTypes.oneOf(['start', 'end', false]), | |
/** | |
* The icon to display when the component is unchecked. | |
*/ | |
icon: PropTypes.node, | |
/** | |
* The id of the `input` element. | |
*/ | |
id: PropTypes.string, | |
/** | |
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element. | |
*/ | |
inputProps: PropTypes.object, | |
/** | |
* Pass a ref to the `input` element. | |
*/ | |
inputRef: refType, | |
/** | |
* Callback fired when the state is changed. | |
* | |
* @param {object} event The event source of the callback. | |
* You can pull out the new checked state by accessing `event.target.checked` (boolean). | |
*/ | |
onChange: PropTypes.func, | |
/** | |
* If `true`, the `input` element will be required. | |
*/ | |
required: PropTypes.bool, | |
/** | |
* The size of the switch. | |
* `small` is equivalent to the dense switch styling. | |
*/ | |
size: PropTypes.oneOf(['small', 'medium']), | |
/** | |
* The input component prop `type`. | |
*/ | |
type: PropTypes.string, | |
/** | |
* The value of the component. The DOM API casts this to a string. | |
*/ | |
value: PropTypes.any, | |
}; | |
export default withStyles(styles, { name: 'MuiSwitch' })(Switch); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment