Pular para o conteúdo

🎉 v5 is out! Head to the documentation to get started.

API

A referência da API do @material-ui/core/styles.

createGenerateClassName([options]) => class name generator

Uma função que retorna uma função geradora de nome de classe.

Argumentos

  1. options (Object [opcional]):
    • options.disableGlobal (Boolean [opcional]): Padrão false. Desabilita a geração de nomes de classes determinísticas.
    • options.productionPrefix (String [opcional]): Padrão 'jss'. A string usada para prefixar os nomes de classes em produção.
    • options.seed (String [opcional]): Padrão ''. A string usada unicamente para identificar o gerador. Ela pode ser usada para evitar colisões de nomes de classes ao usar vários geradores no mesmo documento.

Retornos

class name generator: O gerador que deve ser fornecido ao JSS.

Exemplos

import React from 'react';
import { StylesProvider, createGenerateClassName } from '@material-ui/core/styles';

const generateClassName = createGenerateClassName({
  productionPrefix: 'c',
});

export default function App() {
  return (
    <StylesProvider generateClassName={generateClassName}>...</StylesProvider>
  );
}

createStyles(styles) => styles

Esta função realmente não "faz nada" em tempo de execução, é apenas uma função de identidade. Sua única finalidade é lidar com a ampliação de tipos do TypeScript, ao fornecer regras de estilo para makeStyles/withStyles que são uma função do tema.

Argumentos

  1. styles (Object): Um objeto de estilos.

Retornos

styles: Um objeto de estilos.

Exemplos

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 <div className={classes.root} />;
}

makeStyles(styles, [options]) => hook

Vincula uma folha de estilo a um componente de função usando o padrão hook.

Argumentos

  1. styles (Function | Object): Uma função que gera os estilos ou um objeto de estilos. Ela será vinculada ao componente. Use a assinatura da função se você precisar ter acesso ao tema. É fornecido como o primeiro argumento.
  2. options (Object [opcional]):
    • options.defaultTheme (Object [opcional]): O tema padrão a ser usado se um tema não for fornecido por meio de um provedor de temas.
    • options.name (String [opcional]): O nome da folha de estilo. Útil para depuração.
    • options.flip (Boolean [opcional]): Quando definido como false, está folha irá cancelar a transformação rtl. Quando definido para true, os estilos são invertidos. Quando definido para null, segue theme.direction.
    • As outras chaves são encaminhadas para o argumento de opções do jss.createStyleSheet ([styles], [options]).

Retornos

hook: Um hook. Este hook pode ser usado em uma função que retorna o componente. A documentação geralmente chama esse hook retornado de useStyles. Aceita um argumento: as propriedades que serão usadas para "interpolação" na folha de estilo.

Exemplos

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 <div className={classes.root} />;
}

ServerStyleSheets

Esta é uma classe utilitária para manipular a renderização do lado do servidor. Você pode seguir este guia para uma abordagem prática.

import ReactDOMServer from 'react-dom/server';
import { ServerStyleSheets } from '@material-ui/core/styles';

const sheets = new ServerStyleSheets();
const html = ReactDOMServer.renderToString(sheets.collect(<App />));
const cssString = sheets.toString();

const response = `
<!DOCTYPE html>
<html>
  <head>
    <style id="jss-server-side">${cssString}</style>
  </head>
  <body>${html}</body>
</html>
`;

new ServerStyleSheets([options])

A instanciação aceita um objeto de opções como primeiro argumento.

  1. options (Object [opcional]): As opções são distribuídas como propriedades para o componente StylesProvider.

sheets.collect(node) => Elemento React

O método envolve seu nó React em um elemento provedor. Ele coleta as folhas de estilo durante a renderização para que elas possam ser enviadas posteriormente ao cliente.

sheets.toString() => CSS string

O método retorna os estilos coletados.

⚠️ Você deve chamar .collect() antes de usar este método.

sheets.getStyleElement() => CSS do elemento React

O método é uma alternativa para .toString() quando você esta renderizando a página inteira com React.

⚠️ Você deve chamar .collect() antes de usar este método.

styled(Component)(styles, [options]) => Component

Vincula uma folha de estilos, com uma função de componente, usando o padrão de componentes estilizados (styled components).

Argumentos

  1. Component: O componente que será manipulado.
  2. styles (Function | Object): Uma função que gera os estilos ou um objeto de estilos. Ela será vinculada ao componente. Use a assinatura da função se você precisar ter acesso ao tema. É fornecido como propriedade do primeiro argumento.
  3. options (Object [opcional]):
    • options.defaultTheme (Object [opcional]): O tema padrão a ser usado se um tema não for fornecido por meio de um provedor de temas.
    • options.withTheme (Boolean [opcional]): Padrão false. Fornecer o objeto theme para o componente como uma propriedade.
    • options.name (String [opcional]): O nome da folha de estilo. Útil para depuração. Se o valor não for fornecido, ele tentará usar o nome do componente.
    • options.flip (Boolean [opcional]): Quando definido como false, está folha irá cancelar a transformação rtl. Quando definido para true, os estilos são invertidos. Quando definido para null, segue theme.direction.
    • As outras chaves são encaminhadas para o argumento de opções do jss.createStyleSheet ([styles], [options]).

Retornos

Component: O novo componente criado.

Exemplos

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 (
    <MyThemeComponent>
      <MyComponent />
    </MyThemeComponent>
  );
}

StylesProvider

Este componente permite que você altere o comportamento da solução de estilo. Ele torna as opções disponíveis na árvore React graças ao contexto.

Deve preferencialmente ser usado na raiz da sua árvore de componentes.

Propriedades

Nome Tipo Padrão Descrição
children * node Sua árvore de componentes.
disableGeneration bool false Você pode desabilitar a geração dos estilos com esta opção. Pode ser útil ao percorrer a árvore React fora da etapa de renderização de HTML no servidor. Digamos que você esteja usando react-apollo para extrair todas as consultas feitas pela interface do lado do servidor. Você pode acelerar significativamente a varredura com essa propriedade.
generateClassName func Gerador de nome de classes do JSS.
injectFirst bool false Por padrão, os estilos são injetados por último no elemento <head> da página. Como resultado, eles ganham mais especificidade do que qualquer outra folha de estilo. Se você quiser sobrescrever estilos do Material-UI, defina esta propriedade.
jss object Instância do JSS.

Exemplos

import React from 'react';
import ReactDOM from 'react-dom';
import { StylesProvider } from '@material-ui/core/styles';

function App() {
  return (
    <StylesProvider jss={jss}>...</StylesProvider>
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));

ThemeProvider

Este componente tem uma propriedade theme, e se torna disponível pela árvore React graças ao contexto. Deve preferencialmente ser usado na raiz da sua árvore de componentes.

Propriedades

Nome Tipo Padrão Descrição
children * node Sua árvore de componentes.
theme * union: object | func Um objeto de tema. Você pode utilizar uma função para receber o tema externo.

Exemplos

import React from 'react';
import ReactDOM from 'react-dom';
import { ThemeProvider } from '@material-ui/core/styles';

const theme = {};

function App() {
  return (
    <ThemeProvider theme={theme}>...</ThemeProvider>
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));

useTheme() => theme

Este hook retorna o objeto theme, para que possa ser usado dentro de um componente de função.

Retornos

theme: O objeto de tema previamente injetado no contexto.

Exemplos

import React from 'react';
import { useTheme } from '@material-ui/core/styles';

export default function MyComponent() {
  const theme = useTheme();

  return <div>{`spacing ${theme.spacing}`}</div>;
}

withStyles(styles, [options]) => higher-order component

Vincula uma folha de estilos com um componente usando o padrão de higher-order component. Ele não modifica o componente passado para ele; em vez disso, ele retorna um novo componente, com a propriedade classes. Este objeto classes contém o nome das classes inseridas no DOM.

Alguns detalhes de implementação que podem ser interessantes para estar ciente:

  • Adiciona uma propriedade classes, assim você pode substituir, a partir do exterior, os nomes de classe previamente injectados.
  • Ela encaminha refs para o componente interno.
  • A propriedade innerRef está descontinuada. Em vez disso, use ref.
  • Ela não faz copia sobre estáticos. Por exemplo, pode ser usado para definir um método estático (next.js) getInitialProps().

Argumentos

  1. styles (Function | Object): Uma função que gera os estilos ou um objeto de estilos. Ela será vinculada ao componente. Use a assinatura da função se você precisar ter acesso ao tema. É fornecido como o primeiro argumento.
  2. options (Object [opcional]):
    • options.defaultTheme (Object [opcional]): O tema padrão a ser usado se um tema não for fornecido por meio de um provedor de temas.
    • options.withTheme (Boolean [opcional]): Padrão false. Fornece o objeto theme para o componente como uma propriedade.
    • options.name (String [opcional]): O nome da folha de estilo. Útil para depuração. Se o valor não for fornecido, ele tentará usar o nome do componente.
    • options.flip (Boolean [opcional]): Quando definido como false, está folha irá cancelar a transformação rtl. Quando definido para true, os estilos são invertidos. Quando definido para null, segue theme.direction.
    • As outras chaves são encaminhadas para o argumento de opções do jss.createStyleSheet ([styles], [options]).

Retornos

higher-order component: Deve ser usado para encapsular o componente.

Exemplos

import React from 'react';
import { withStyles } from '@material-ui/core/styles';

const styles = {
  root: {
    backgroundColor: 'red',
  },
};

function MyComponent(props) {
  return <div className={props.classes.root} />;
}

export default withStyles(styles)(MyComponent);

Além disso, você pode usar com decoradores dessa forma:

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 <div className={this.props.classes.root} />;
  }
}

export default MyComponent

withTheme(Component) => Component

Fornece o objeto theme como uma propriedade do componente de entrada, para que ele possa ser usado no método de renderização.

Argumentos

  1. Component: O componente que será manipulado.

Retornos

Component: O novo componente criado. Encaminha refs para o componente interno.

Exemplos

import React from 'react';
import { withTheme } from '@material-ui/core/styles';

function MyComponent(props) {
  return <div>{props.theme.direction}</div>;
}

export default withTheme(MyComponent);