005cf56baf
Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# Shape
|
|
|
|
<p class="description">The shape is a design token that helps control the border radius of components.</p>
|
|
|
|
The `shape` contains a single property, `borderRadius`, with the default value of `4px`.
|
|
Several components use this value to set consistent border radii across the library.
|
|
|
|
## Custom shape
|
|
|
|
To add custom shapes, create a theme with the `shape` key:
|
|
|
|
```js
|
|
import { createTheme } from '@mui/material/styles';
|
|
|
|
const theme = createTheme({
|
|
shape: {
|
|
borderRadius: 8,
|
|
borderRadiusSm: 4, // new property
|
|
borderRadiusMd: 8, // new property
|
|
borderRadiusLg: 16, // new property
|
|
borderRadiusXl: 24, // new property
|
|
},
|
|
});
|
|
```
|
|
|
|
### Typescript
|
|
|
|
If you're using TypeScript you need to use [module augmentation](/material-ui/guides/typescript/#customization-of-theme) to extend **new** shape properties to the theme.
|
|
|
|
```ts
|
|
declare module '@mui/material/styles' {
|
|
interface Shape {
|
|
borderRadiusSm: number;
|
|
borderRadiusMd: number;
|
|
borderRadiusLg: number;
|
|
borderRadiusXl: number;
|
|
}
|
|
|
|
interface ShapeOptions {
|
|
borderRadiusSm?: number;
|
|
borderRadiusMd?: number;
|
|
borderRadiusLg?: number;
|
|
borderRadiusXl?: number;
|
|
}
|
|
}
|
|
```
|