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.

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

[Skeleton][material-ui] Add new props to the Skeleton component #38483

Merged
merged 14 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
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
15 changes: 13 additions & 2 deletions docs/data/material/components/skeleton/Facebook.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ function Media(props) {
<CardHeader
avatar={
loading ? (
<Skeleton animation="wave" variant="circular" width={40} height={40} />
<Skeleton
animation="wave"
size="box"
shape="circular"
width={40}
height={40}
/>
) : (
<Avatar
alt="Ted talk"
Expand Down Expand Up @@ -54,7 +60,12 @@ function Media(props) {
}
/>
{loading ? (
<Skeleton sx={{ height: 190 }} animation="wave" variant="rectangular" />
<Skeleton
sx={{ height: 190 }}
animation="wave"
size="box"
shape="rectangular"
/>
) : (
<CardMedia
component="img"
Expand Down
15 changes: 13 additions & 2 deletions docs/data/material/components/skeleton/Facebook.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,13 @@ function Media(props: MediaProps) {
<CardHeader
avatar={
loading ? (
<Skeleton animation="wave" variant="circular" width={40} height={40} />
<Skeleton
animation="wave"
size="box"
shape="circular"
width={40}
height={40}
/>
) : (
<Avatar
alt="Ted talk"
Expand Down Expand Up @@ -57,7 +63,12 @@ function Media(props: MediaProps) {
}
/>
{loading ? (
<Skeleton sx={{ height: 190 }} animation="wave" variant="rectangular" />
<Skeleton
sx={{ height: 190 }}
animation="wave"
size="box"
shape="rectangular"
/>
) : (
<CardMedia
component="img"
Expand Down
13 changes: 13 additions & 0 deletions docs/data/material/components/skeleton/Shapes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as React from 'react';
import Skeleton from '@mui/material/Skeleton';
import Stack from '@mui/material/Stack';

export default function Shapes() {
return (
<Stack spacing={1}>
<Skeleton shape="circular" size="box" width={40} height={40} />
<Skeleton shape="rectangular" size="box" width={210} height={60} />
<Skeleton shape="rounded" size="box" width={210} height={60} />
</Stack>
);
}
13 changes: 13 additions & 0 deletions docs/data/material/components/skeleton/Shapes.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import * as React from 'react';
import Skeleton from '@mui/material/Skeleton';
import Stack from '@mui/material/Stack';

export default function Shapes() {
return (
<Stack spacing={1}>
<Skeleton shape="circular" size="box" width={40} height={40} />
<Skeleton shape="rectangular" size="box" width={210} height={60} />
<Skeleton shape="rounded" size="box" width={210} height={60} />
</Stack>
);
}
3 changes: 3 additions & 0 deletions docs/data/material/components/skeleton/Shapes.tsx.preview
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Skeleton shape="circular" size="box" width={40} height={40} />
<Skeleton shape="rectangular" size="box" width={210} height={60} />
<Skeleton shape="rounded" size="box" width={210} height={60} />
14 changes: 14 additions & 0 deletions docs/data/material/components/skeleton/Sizes.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import Skeleton from '@mui/material/Skeleton';
import Stack from '@mui/material/Stack';

export default function Sizes() {
return (
<Stack spacing={1} width={210}>
{/* For size="text", adjust the height via font-size */}
<Skeleton size="text" sx={{ fontSize: '1rem' }} />
{/* For size="box", adjust height based on bounding box */}
<Skeleton size="box" height={40} />
</Stack>
);
}
14 changes: 14 additions & 0 deletions docs/data/material/components/skeleton/Sizes.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import Skeleton from '@mui/material/Skeleton';
import Stack from '@mui/material/Stack';

export default function Sizes() {
return (
<Stack spacing={1} width={210}>
{/* For size="text", adjust the height via font-size */}
<Skeleton size="text" sx={{ fontSize: '1rem' }} />
{/* For size="box", adjust height based on bounding box */}
<Skeleton size="box" height={40} />
</Stack>
);
}
4 changes: 4 additions & 0 deletions docs/data/material/components/skeleton/Sizes.tsx.preview
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{/* For size="text", adjust the height via font-size */}
<Skeleton size="text" sx={{ fontSize: '1rem' }} />
{/* For size="box", adjust height based on bounding box */}
<Skeleton size="box" height={40} />
4 changes: 2 additions & 2 deletions docs/data/material/components/skeleton/SkeletonChildren.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function SkeletonChildrenDemo(props) {
<Box sx={{ display: 'flex', alignItems: 'center' }}>
<Box sx={{ margin: 1 }}>
{loading ? (
<Skeleton variant="circular">
<Skeleton size="box" shape="circular">
<Avatar />
</Skeleton>
) : (
Expand All @@ -37,7 +37,7 @@ function SkeletonChildrenDemo(props) {
</Box>
</Box>
{loading ? (
<Skeleton variant="rectangular" width="100%">
<Skeleton size="box" shape="rectangular" width="100%">
<div style={{ paddingTop: '57%' }} />
</Skeleton>
) : (
Expand Down
4 changes: 2 additions & 2 deletions docs/data/material/components/skeleton/SkeletonChildren.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function SkeletonChildrenDemo(props: { loading?: boolean }) {
<Box sx={{ display: 'flex', alignItems: 'center' }}>
<Box sx={{ margin: 1 }}>
{loading ? (
<Skeleton variant="circular">
<Skeleton size="box" shape="circular">
<Avatar />
</Skeleton>
) : (
Expand All @@ -36,7 +36,7 @@ function SkeletonChildrenDemo(props: { loading?: boolean }) {
</Box>
</Box>
{loading ? (
<Skeleton variant="rectangular" width="100%">
<Skeleton size="box" shape="rectangular" width="100%">
<div style={{ paddingTop: '57%' }} />
</Skeleton>
) : (
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/components/skeleton/SkeletonColor.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default function SkeletonColor() {
>
<Skeleton
sx={{ bgcolor: 'grey.900' }}
variant="rectangular"
shape="rectangular"
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
width={210}
height={118}
/>
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/components/skeleton/SkeletonColor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default function SkeletonColor() {
>
<Skeleton
sx={{ bgcolor: 'grey.900' }}
variant="rectangular"
shape="rectangular"
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
width={210}
height={118}
/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<Skeleton
sx={{ bgcolor: 'grey.900' }}
variant="rectangular"
shape="rectangular"
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
width={210}
height={118}
/>
16 changes: 0 additions & 16 deletions docs/data/material/components/skeleton/Variants.js

This file was deleted.

17 changes: 0 additions & 17 deletions docs/data/material/components/skeleton/Variants.tsx

This file was deleted.

7 changes: 0 additions & 7 deletions docs/data/material/components/skeleton/Variants.tsx.preview

This file was deleted.

2 changes: 1 addition & 1 deletion docs/data/material/components/skeleton/YouTube.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function Media(props) {
src={item.src}
/>
) : (
<Skeleton variant="rectangular" width={210} height={118} />
<Skeleton shape="rectangular" width={210} height={118} />
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
)}

{item ? (
Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/components/skeleton/YouTube.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function Media(props: MediaProps) {
src={item.src}
/>
) : (
<Skeleton variant="rectangular" width={210} height={118} />
<Skeleton shape="rectangular" width={210} height={118} />
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
)}
{item ? (
<Box sx={{ pr: 2 }}>
Expand Down
20 changes: 14 additions & 6 deletions docs/data/material/components/skeleton/skeleton-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,27 @@ O componente é projetado para ser usado **diretamente em seus componentes**. Po
item ? (
<img style={{ width: 210, height: 118 }} alt={item.title} src={item.src} />
) : (
<Skeleton variant="rect" width={210} height={118} />
<Skeleton shape="rect" width={210} height={118} />
);
}
```

## Variantes
## Formas

The component supports 4 shape variants:
O componente suporta 3 formas:

- `text` (default): represents a single line of text (you can adjust the height via font size).
- `circular`, `rectangular`, and `rounded`: come with different border radius to let you take control of the size.
- `circular`, `rectangular`, e `rounded`: Venha com um raio de borda diferente para permitir que você assuma o controle da forma.

{{"demo": "Variants.js"}}
{{"demo": "Shapes.js"}}

## Tamanhos

Você pode usar os seguintes valores para especificar o tamanho do componente:

- `text` (default): representa uma única linha de texto (você pode ajustar a altura por tamanho da fonte).
- `box`: Escala o componente para o tamanho da caixa delimitadora.

{{"demo": "Sizes.js"}}

## Animações

Expand Down
22 changes: 15 additions & 7 deletions docs/data/material/components/skeleton/skeleton-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,27 @@ githubLabel: 'component: skeleton'
src={item.src}
/>
) : (
<Skeleton variant="rectangular" width={210} height={118} />
<Skeleton shape="rectangular" width={210} height={118} />
);
}
```

## 变体
## 形状

The component supports 4 shape variants:
组件支持 3 种形状:

- `text` (default): represents a single line of text (you can adjust the height via font size).
- `circular`, `rectangular`, and `rounded`: come with different border radius to let you take control of the size.
- `circular`, `rectangular`, 和 `rounded`: 带有不同的边界半径,让您控制形状

{{"demo": "Variants.js"}}
{{"demo": "Shapes.js"}}

## 尺寸

您可以使用以下值来指定组件的大小:

- `text` (默认值):表示一行文本(您可以通过字体大小调整高度)。
- `box`: 将组件扩展到边界框的大小。

{{"demo": "Sizes.js"}}

## 动画

Expand Down Expand Up @@ -73,7 +81,7 @@ The component supports 4 shape variants:

```jsx
loading ? (
<Skeleton variant="circular">
<Skeleton shape="circular">
<Avatar />
</Skeleton>
) : (
Expand Down
20 changes: 14 additions & 6 deletions docs/data/material/components/skeleton/skeleton.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,27 @@ For instance:
src={item.src}
/>
) : (
<Skeleton variant="rectangular" width={210} height={118} />
<Skeleton shape="rectangular" width={210} height={118} />
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
);
}
```

## Variants
## Shapes

The component supports 4 shape variants:
The component supports 3 shapes:

- `circular`, `rectangular`, and `rounded`: come with different border radius to let you take control of the shape.

{{"demo": "Shapes.js"}}

## Sizes

You can use the following values to specify the size of the component:

- `text` (default): represents a single line of text (you can adjust the height via font size).
- `circular`, `rectangular`, and `rounded`: come with different border radius to let you take control of the size.
- `box`: scale the component to the size of the bounding box.

{{"demo": "Variants.js"}}
{{"demo": "Sizes.js"}}

## Animations

Expand Down Expand Up @@ -76,7 +84,7 @@ infer its width and height from them.

```jsx
loading ? (
<Skeleton variant="circular">
<Skeleton shape="circular">
DiegoAndai marked this conversation as resolved.
Show resolved Hide resolved
<Avatar />
</Skeleton>
) : (
Expand Down
Loading