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

Jump to bottom

[system][docs] Add "dynamic values" section to sx prop page #42239

Merged
merged 6 commits into from
May 30, 2024
Merged

[system][docs] Add "dynamic values" section to sx prop page #42239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f71359
Include guidance around dynamic values
aarongarciah May 14, 2024
863b7f0
Make color input controlled
aarongarciah May 14, 2024
4c5d18d
Add CSP callout
aarongarciah May 14, 2024
60fed26
One sentence per line
aarongarciah May 15, 2024
6b3fe3e
Remove unnecessary markdown
aarongarciah May 29, 2024
065f566
Copy improvements
aarongarciah May 30, 2024
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
38 changes: 38 additions & 0 deletions docs/data/system/getting-started/the-sx-prop/DynamicValues.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import * as React from 'react';
import Box from '@mui/material/Box';
import Stack from '@mui/material/Stack';
import Typography from '@mui/material/Typography';

export default function DynamicValues() {
const [color, setColor] = React.useState('#007fff');

return (
<Stack spacing={1} alignItems="center">
<Typography
component="label"
variant="body2"
sx={{ display: 'inline-flex', alignItems: 'center', gap: 1 }}
>
Pick a color to see a live preview
<input
type="color"
value={color}
onChange={(event) => setColor(event.target.value)}
/>
</Typography>
<Box
component="div"
sx={{
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
width: 75,
height: 75,
borderRadius: 2,
backgroundColor: 'var(--bg)',
}}
style={{ '--bg': color }}
/>
</Stack>
);
}
38 changes: 38 additions & 0 deletions docs/data/system/getting-started/the-sx-prop/DynamicValues.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import * as React from 'react';
import Box from '@mui/material/Box';
import Stack from '@mui/material/Stack';
import Typography from '@mui/material/Typography';

export default function DynamicValues() {
const [color, setColor] = React.useState('#007fff');

return (
<Stack spacing={1} alignItems="center">
<Typography
component="label"
variant="body2"
sx={{ display: 'inline-flex', alignItems: 'center', gap: 1 }}
>
Pick a color to see a live preview
<input
type="color"
value={color}
onChange={(event) => setColor(event.target.value)}
/>
</Typography>
<Box
component="div"
sx={{
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
width: 75,
height: 75,
borderRadius: 2,
backgroundColor: 'var(--bg)',
}}
style={{ '--bg': color } as React.CSSProperties}
/>
</Stack>
);
}
12 changes: 12 additions & 0 deletions docs/data/system/getting-started/the-sx-prop/the-sx-prop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,18 @@

{{"demo": "PassingSxProp.js", "bg": true, "defaultCodeOpen": true}}

## Dynamic values

For highly dynamic CSS values, we recommend using inline CSS variables instead of passing an object with varying values to the `sx` prop on each render.

Check warning on line 297 in docs/data/system/getting-started/the-sx-prop/the-sx-prop.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "docs/data/system/getting-started/the-sx-prop/the-sx-prop.md", "range": {"start": {"line": 297, "column": 32}}}, "severity": "WARNING"}
This approach avoids inserting unnecessary `style` tags into the DOM, which prevents potential performance issues when dealing with CSS properties that can hold a wide range of values that change frequently—for example, a color picker with live preview.

:::info
If you're having problems with your Content Security Policy while using inline styles with the `style` attribute, make sure you've enabled the [`style-src-attr` directive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src-attr).
Visit the [Content Security Policy guide](/material-ui/guides/content-security-policy/) for configuration details.
:::

{{"demo": "DynamicValues.js", "bg": true}}

## TypeScript usage

A frequent source of confusion with the `sx` prop is TypeScript's [type widening](https://mariusschulz.com/blog/literal-type-widening-in-typescript), which causes this example not to work as expected:
Expand Down
Loading