v4
Search…
⌃K
Links

withStyles

It's like the material-ui v4 higher-order component API but type safe by design.
Using as const can often helps when you get red squiggly lines.

With functional component

MyComponent.tsx
import { withStyles } from "tss-react/mui";
​
type Props = {
className?: string;cod
classes?: Partial<Record<"root" | "label", string>>;
colorSmall: string;
};
​
function MyComponent(props: Props) {
​
const classes = withStyles.getClasses(props);
​
return (
<div className={classes.root}>
<span className={classes.text}>The background color should be different when the screen is small.</span>
</div>
);
}
​
const MyComponentStyled = withStyles(
MyComponent,
(theme, props) => ({
root: {
backgroundColor: theme.palette.primary.main,
height: 100
},
text: {
border: "1px solid red"
},
"@media (max-width: 960px)": {
root: {
backgroundColor: props.colorSmall
}
}
})
);
​
export default MyComponentStyled;
import MyComponent from "./MyComponent";
​
render(
<MyComponent
className="foo bar"
classes={{ text: "baz baz" }}
colorSmall="cyan"
/>
);

With class components

The main reason you would use withStyles over makeStyles is to support class based components.
MyComponent.tsx
import * as React from "react";
import { withStyles } from "tss-react/mui";
​
export type Props ={
className?: string;
classes?: Partial<Record<"root" | "span", string>>;
isBig: boolean;
};
​
class MyComponent extends React.Component<Props> {
render() {
const classes = withStyles.getClasses(this.props);
​
return (
<div className={classes.root}>
<span className={classes.span}>The background color should be different when the screen is small.</span>
</div>
);
}
}
​
const MyComponentStyled = withStyles(
MyComponent,
(theme, props) => ({
"root": {
"backgroundColor": theme.palette.primary.main,
"height": props.isBig ? 100 : 50
},
"span": {
"border": "1px solid red"
},
"@media (max-width: 960px)": {
"root": {
"backgroundColor": "red"
}
}
})
);
​
export default MyComponentStyled;
import MyComponent from "./MyComponent";
​
render(
<MyComponent
className="foo bar"
classes={{ text: "baz baz" }}
colorSmall="cyan"
/>
);

With no classes props

Your component can also only have a className prop (and no classes).
MyComponent.tsx
import * as React from "react";
import { withStyles } from "tss-react/mui";
​
export type Props ={
className?: string;
isBig: boolean;
};
​
class MyComponent extends React.Component<Props> {
render() {
const classes = withStyles.getClasses(this.props);
​
return (
<div className={classes.root}>
The background color should be different when the screen is small.
</div>
);
}
}
​
const MyComponentStyled = withStyles(
MyComponent,
(theme, props) => ({
"root": {
"backgroundColor": theme.palette.primary.main,
"height": props.isBig ? 100 : 50
},
"@media (max-width: 960px)": {
"root": {
"backgroundColor": "red"
}
}
})
);
​
export default MyComponentStyled;
import MyComponent from "./MyComponent";
​
render(
<MyComponent
className="foo bar"
colorSmall="cyan"
/>
);

With a MUI component

You can also pass a mui component like for example <Button /> and you'll be able to overwrite every rule name of the component (it uses the classes prop).
import Button from "@mui/material/Button";
import { withStyles } from "tss-react/mui";
​
const MyStyledButton = withStyles(Button, {
"root": {
"backgroundColor": "grey"
}
"text": {
"color": "red"
},
"@media (max-width: 960px)": {
"text": {
"color": "blue"
}
}
});
It's also possible to start from a builtin HTML component:
import { withStyles } from "tss-react/mui";
​
const MyAnchorStyled = withStyles("a", (theme, { href }) => ({
"root": {
"border": "1px solid black",
"backgroundColor": href?.startsWith("https")
? theme.palette.primary.main
: "red"
}
}));
You can experiment with those examples here live here, you can also run it locally with yarn start_spa.

Naming the stylesheets (useful for debugging and theme style overrides)

To ease debugging you can specify a name that will appear in every class names. It is like the option.name in material-ui v4's makeStyles.
It's also required to for theme style overrides.
import { withStyles } from "tss-react/mui";
​
const MyDiv = withStyles("div", {
"root": {
/* ... */
}
}, { "name": "MyDiv" });
​
//The class apllied to the div will be like: "css-xxxxxx-MyDiv-root"