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.

Sign up for GitHub

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

[Doc] Fix custom theme doc doesn't explain how to override default theme #5676

Merged
merged 2 commits into from
Dec 16, 2020
Merged

[Doc] Fix custom theme doc doesn't explain how to override default theme #5676

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de87f23
[Doc] Fix custom theme doc doesn't explain how to override default theme
fzaninotto Dec 15, 2020
6b47836
Fix spacing
fzaninotto Dec 15, 2020
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
23 changes: 10 additions & 13 deletions docs/Theming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,15 +310,18 @@ const App = () => (

## Writing a Custom Theme

If you need more fine-tuning, you'll need to write your own `theme` object, following [Material UI themes documentation](https://material-ui.com/customization/themes/). Material UI merges custom theme objects with the default theme.
If you need more fine-tuning, you'll need to write your own `theme` object, following [Material UI themes documentation](https://material-ui.com/customization/themes/).

For instance, here is how to override the default react-admin theme:

```jsx
import { createMuiTheme } from '@material-ui/core/styles';
import { defaultTheme } from 'react-admin';
import merge from 'lodash/merge';
import indigo from '@material-ui/core/colors/indigo';
import pink from '@material-ui/core/colors/pink';
import red from '@material-ui/core/colors/red';

const myTheme = createMuiTheme({
const myTheme = merge({}, defaultTheme, {
palette: {
primary: indigo,
secondary: pink,
Expand All @@ -328,13 +331,7 @@ const myTheme = createMuiTheme({
},
typography: {
// Use the system font instead of the default Roboto font.
fontFamily: [
'-apple-system',
'BlinkMacSystemFont',
'"Segoe UI"',
'Arial',
'sans-serif',
].join(','),
fontFamily: ['-apple-system', 'BlinkMacSystemFont', '"Segoe UI"', 'Arial', 'sans-serif'].join(','),
},
overrides: {
MuiButton: { // override the styles of all instances of this component
Expand All @@ -346,7 +343,7 @@ const myTheme = createMuiTheme({
});
```

The `myTheme` object contains the following keys:
A `theme` object can contain the following keys:

* `breakpoints`
* `direction`
Expand All @@ -355,9 +352,9 @@ The `myTheme` object contains the following keys:
* `palette`
* `props`
* `shadows`
* `typography`
* `transitions`
* `spacing`
* `transitions`
* `typography`
* `zIndex`

**Tip**: Check [Material UI default theme documentation](https://material-ui.com/customization/default-theme/) to see the default values and meaning for these keys.
Expand Down