# API
The API reference of @material-ui/core/styles.
## `createGenerateClassName([options]) => class name generator`
A function which returns [a class name generator function](https://cssinjs.org/jss-api/#generate-your-class-names).
### Paramètres
1. `options` (*Object* [optional]):
- `options.disableGlobal` (*Boolean* [optional]): Valeur par défaut `false`. Disable the generation of deterministic class names.
- `options.productionPrefix` (*String* [optional]): Defaults to `'jss'`. The string used to prefix the class names in production.
- `options.seed` (*String* [optional]): Defaults to `''`. The string used to uniquely identify the generator. It can be used to avoid class name collisions when using multiple generators in the same document.
### Valeur de retour
`class name generator`: The generator should be provided to JSS.
### Exemples
```jsx
import React from 'react';
import { StylesProvider, createGenerateClassName } from '@material-ui/core/styles';
const generateClassName = createGenerateClassName({
productionPrefix: 'c',
});
export default function App() {
return (
...
);
}
```
## `createStyles(styles) => styles`
This function doesn't really "do anything" at runtime, it's just the identity function. Its only purpose is to defeat **TypeScript**'s type widening when providing style rules to `makeStyles`/`withStyles` which are a function of the `Theme`.
### Paramètres
1. `styles` (*Object*): A styles object.
### Valeur de retour
`styles`: A styles object.
### Exemples
```jsx
import { makeStyles, createStyles } from '@material-ui/core/styles';
const useStyles = makeStyles((theme: Theme) => createStyles({
root: {
backgroundColor: theme.color.red,
},
}));
export default function MyComponent {
const classes = useStyles();
return ;
}
```
## `makeStyles(styles, [options]) => hook`
Link a style sheet with a function component using the **hook** pattern.
### Paramètres
1. `styles` (*Function | Object*): A function generating the styles or a styles object. It will be linked to the component. Use the function signature if you need to have access to the theme. It's provided as the first argument.
2. `options` (*Object* [optional]):
- `options.defaultTheme` (*Object* [optional]): The default theme to use if a theme isn't supplied through a Theme Provider.
- `options.name` (*String* [optional]): The name of the style sheet. Useful for debugging.
- `options.flip` (*Boolean* [optional]): When set to `false`, this sheet will opt-out the `rtl` transformation. When set to `true`, the styles are inversed. When set to `null`, it follows `theme.direction`.
- The other keys are forwarded to the options argument of [jss.createStyleSheet([styles], [options])](https://cssinjs.org/jss-api/#create-style-sheet).
### Valeur de retour
`hook`: A hook. This hook can be used in a function component. The documentation often calls this returned hook `useStyles`. It accepts one argument: the properties that will be used for "interpolation" in the style sheet.
### Exemples
```jsx
import React from 'react';
import { makeStyles } from '@material-ui/core/styles';
const useStyles = makeStyles({
root: {
backgroundColor: 'red',
color: props => props.color,
},
});
export default function MyComponent(props) {
const classes = useStyles(props);
return ;
}
```
## `ServerStyleSheets`
This is a class helper to handle server-side rendering. [You can follow this guide for a practical approach](/guides/server-rendering/).
```jsx
import ReactDOMServer from 'react-dom/server';
import { ServerStyleSheets } from '@material-ui/core/styles';
const sheets = new ServerStyleSheets();
const html = ReactDOMServer.renderToString(sheets.collect());
const cssString = sheets.toString();
const response = `
${html}
`;
```
### `new ServerStyleSheets([options])`
The instantiation accepts an options object as a first argument.
1. `options` (*Object* [optional]): The options are spread as props to the [`StylesProvider`](#stylesprovider) component.
### `sheets.collect(node) => React element`
The method wraps your React node in a provider element. It collects the style sheets during the rendering so they can be later sent to the client.
### `sheets.toString() => CSS string`
The method returns the collected styles.
⚠️ You must call `.collect()` before using this method.
### `sheets.getStyleElement() => CSS React element`
The method is an alternative to `.toString()` when you are rendering the whole page with React.
⚠️ You must call `.collect()` before using this method.
## `styled(Component)(styles, [options]) => Component`
Link a style sheet with a function component using the **styled components** pattern.
### Paramètres
1. `Component`: The component that will be wrapped.
2. `styles` (*Function | Object*): A function generating the styles or a styles object. It will be linked to the component. Use the function signature if you need to have access to the theme. It's provided as property of the first argument.
3. `options` (*Object* [optional]):
- `options.defaultTheme` (*Object* [optional]): The default theme to use if a theme isn't supplied through a Theme Provider.
- `options.withTheme` (*Boolean* [optional]): Valeur par défaut `false`. Provide the `theme` object to the component as a property.
- `options.name` (*String* [optional]): The name of the style sheet. Useful for debugging. If the value isn't provided, it will try to fallback to the name of the component.
- `options.flip` (*Boolean* [optional]): When set to `false`, this sheet will opt-out the `rtl` transformation. When set to `true`, the styles are inversed. When set to `null`, it follows `theme.direction`.
- The other keys are forwarded to the options argument of [jss.createStyleSheet([styles], [options])](https://cssinjs.org/jss-api/#create-style-sheet).
### Valeur de retour
`Component`: The new component created.
### Exemples
```jsx
import React from 'react';
import { styled } from '@material-ui/core/styles';
const MyComponent = styled('div')({
backgroundColor: 'red',
});
const MyThemeComponent = styled('div')(({
theme
}) => ({
padding: theme.spacing(1),
}));
export default function StyledComponents() {
return (
);
}
```
## `StylesProvider`
This component allows you to change the behavior of the styling solution. It makes the options available down the React tree thanks to the context.
It should preferably be used at **the root of your component tree**.
### Props
| Nom | Type | Défaut | Description |
|:----------------- |:------ |:------ |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| children * | node | | Your component tree. |
| disableGeneration | bool | false | You can disable the generation of the styles with this option. It can be useful when traversing the React tree outside of the HTML rendering step on the server. Let's say you are using react-apollo to extract all the queries made by the interface server-side. You can significantly speed up the traversal with this property. |
| generateClassName | func | | JSS's class name generator. |
| injectFirst | bool | false | By default, the styles are injected last in the `` element of the page. As a result, they gain more specificity than any other style sheet. If you want to override Material-UI's styles, set this prop. |
| jss | object | | JSS's instance. |
### Exemples
```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import { StylesProvider } from '@material-ui/core/styles';
function App() {
return (
...
);
}
ReactDOM.render(, document.querySelector('#app'));
```
## `ThemeProvider`
This component takes a `theme` property, and makes it available down the React tree thanks to the context. It should preferably be used at **the root of your component tree**.
### Props
| Nom | Type | Défaut | Description |
|:--------------- |:---------------------------------------- |:------ |:--------------------------------------------------------------------- |
| children * | node | | Your component tree. |
| theme * | union: object | func | | A theme object. You can provide a function to extend the outer theme. |
### Exemples
```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import { ThemeProvider } from '@material-ui/core/styles';
const theme = {};
function App() {
return (
...
);
}
ReactDOM.render(, document.querySelector('#app'));
```
## `useTheme() => theme`
This hook returns the `theme` object so it can be used inside a function component.
### Valeur de retour
`theme`: The theme object previously injected in the context.
### Exemples
```jsx
import React from 'react';
import { useTheme } from '@material-ui/core/styles';
export default function MyComponent() {
const theme = useTheme();
return {`spacing ${theme.spacing}`}
;
}
```
## `withStyles(styles, [options]) => higher-order component`
Link a style sheet with a component using the **higher-order component** pattern. It does not modify the component passed to it; instead, it returns a new component with a `classes` property. This `classes` object contains the name of the class names injected in the DOM.
Some implementation details that might be interesting to being aware of:
- It adds a `classes` property so you can override the injected class names from the outside.
- It forwards refs to the inner component.
- The `innerRef` prop is deprecated. Use `ref` instead.
- It does **not** copy over statics. For instance, it can be used to defined a `getInitialProps()` static method (next.js).
### Paramètres
1. `styles` (*Function | Object*): A function generating the styles or a styles object. It will be linked to the component. Use the function signature if you need to have access to the theme. It's provided as the first argument.
2. `options` (*Object* [optional]):
- `options.defaultTheme` (*Object* [optional]): The default theme to use if a theme isn't supplied through a Theme Provider.
- `options.withTheme` (*Boolean* [optional]): Valeur par défaut `false`. Provide the `theme` object to the component as a property.
- `options.name` (*String* [optional]): The name of the style sheet. Useful for debugging. If the value isn't provided, it will try to fallback to the name of the component.
- `options.flip` (*Boolean* [optional]): When set to `false`, this sheet will opt-out the `rtl` transformation. When set to `true`, the styles are inversed. When set to `null`, it follows `theme.direction`.
- The other keys are forwarded to the options argument of [jss.createStyleSheet([styles], [options])](https://cssinjs.org/jss-api/#create-style-sheet).
### Valeur de retour
`higher-order component`: Should be used to wrap a component.
### Exemples
```jsx
import React from 'react';
import { withStyles } from '@material-ui/core/styles';
const styles = {
root: {
backgroundColor: 'red',
},
};
function MyComponent(props) {
return ;
}
export default withStyles(styles)(MyComponent);
```
Also, you can use as [decorators](https://babeljs.io/docs/en/babel-plugin-proposal-decorators) like so:
```jsx
import React from 'react';
import { withStyles } from '@material-ui/core/styles';
const styles = {
root: {
backgroundColor: 'red',
},
};
@withStyles(styles)
class MyComponent extends React.Component {
render () {
return ;
}
}
export default MyComponent
```
## `withTheme(Component) => Component`
Provide the `theme` object as a property of the input component so it can be used in the render method.
### Paramètres
1. `Component`: The component that will be wrapped.
### Valeur de retour
`Component`: The new component created. Does forward refs to the inner component.
### Exemples
```jsx
import React from 'react';
import { withTheme } from '@material-ui/core/styles';
function MyComponent(props) {
return {props.theme.direction}
;
}
export default withTheme(MyComponent);
```