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

[docs][joy] Revise the Joy UI Link page #37829

Merged
merged 6 commits into from
Jul 21, 2023
Merged

[docs][joy] Revise the Joy UI Link page #37829

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
0c05401
revise Link component docs
danilo-leal Jul 5, 2023
7c564a5
run yarn docs:typescript:formatted
danilo-leal Jul 5, 2023
3b402d8
writing tweaks
danilo-leal Jul 5, 2023
5b0b295
clarify about the overlay prop
danilo-leal Jul 5, 2023
fa3a3cb
copywriting review
danilo-leal Jul 19, 2023
71e97bb
tiny copy fix (removing icon)
danilo-leal Jul 19, 2023
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
14 changes: 14 additions & 0 deletions docs/data/joy/components/link/BasicsLink.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import Link from '@mui/joy/Link';
import Box from '@mui/joy/Box';

export default function BasicsLink() {
return (
<Box sx={{ display: 'flex', gap: 2, flexWrap: 'wrap' }}>
<Link href="#basics">Link</Link>
<Link href="#basics" disabled>
Disabled
</Link>
</Box>
);
}
14 changes: 14 additions & 0 deletions docs/data/joy/components/link/BasicsLink.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import Link from '@mui/joy/Link';
import Box from '@mui/joy/Box';

export default function BasicsLink() {
return (
<Box sx={{ display: 'flex', gap: 2, flexWrap: 'wrap' }}>
<Link href="#basics">Link</Link>
<Link href="#basics" disabled>
Disabled
</Link>
</Box>
);
}
4 changes: 4 additions & 0 deletions docs/data/joy/components/link/BasicsLink.tsx.preview
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<Link href="#basics">Link</Link>
<Link href="#basics" disabled>
Disabled
</Link>
77 changes: 77 additions & 0 deletions docs/data/joy/components/link/LinkColors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Sheet from '@mui/joy/Sheet';
import Link from '@mui/joy/Link';
import RadioGroup from '@mui/joy/RadioGroup';
import Radio from '@mui/joy/Radio';
import Typography from '@mui/joy/Typography';

export default function LinkColors() {
const [variant, setVariant] = React.useState('solid');
return (
<Box
sx={{
display: 'flex',
alignItems: 'center',
gap: 3,
}}
>
<Box
sx={{
display: 'grid',
gridTemplateColumns: 'repeat(2, minmax(0, 1fr))',
gap: 2,
}}
>
<Link href="#colors" variant={variant} color="primary">
Primary
</Link>
<Link href="#colors" variant={variant} color="neutral">
Neutral
</Link>
<Link href="#colors" variant={variant} color="danger">
Danger
</Link>
<Link href="#colors" variant={variant} color="info">
Info
</Link>
<Link href="#colors" variant={variant} color="success">
Success
</Link>
<Link href="#colors" variant={variant} color="warning">
Warning
</Link>
</Box>
<Sheet
sx={{
background: 'transparent',
pl: 4,
borderLeft: '1px solid',
borderColor: 'divider',
}}
>
<Typography
level="body2"
fontWeight="xl"
id="variant-label"
textColor="text.primary"
mb={1}
>
Variant:
</Typography>
<RadioGroup
size="sm"
aria-labelledby="variant-label"
name="variant"
value={variant}
onChange={(event) => setVariant(event.target.value)}
>
<Radio label="Solid" value="solid" />
<Radio label="Soft" value="soft" />
<Radio label="Outlined" value="outlined" />
<Radio label="Plain" value="plain" />
</RadioGroup>
</Sheet>
</Box>
);
}
78 changes: 78 additions & 0 deletions docs/data/joy/components/link/LinkColors.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Sheet from '@mui/joy/Sheet';
import Link from '@mui/joy/Link';
import RadioGroup from '@mui/joy/RadioGroup';
import Radio from '@mui/joy/Radio';
import Typography from '@mui/joy/Typography';
import { VariantProp } from '@mui/joy/styles';

export default function LinkColors() {
const [variant, setVariant] = React.useState<VariantProp>('solid');
return (
<Box
sx={{
display: 'flex',
alignItems: 'center',
gap: 3,
}}
>
<Box
sx={{
display: 'grid',
gridTemplateColumns: 'repeat(2, minmax(0, 1fr))',
gap: 2,
}}
>
<Link href="#colors" variant={variant} color="primary">
Primary
</Link>
<Link href="#colors" variant={variant} color="neutral">
Neutral
</Link>
<Link href="#colors" variant={variant} color="danger">
Danger
</Link>
<Link href="#colors" variant={variant} color="info">
Info
</Link>
<Link href="#colors" variant={variant} color="success">
Success
</Link>
<Link href="#colors" variant={variant} color="warning">
Warning
</Link>
</Box>
<Sheet
sx={{
background: 'transparent',
pl: 4,
borderLeft: '1px solid',
borderColor: 'divider',
}}
>
<Typography
level="body2"
fontWeight="xl"
id="variant-label"
textColor="text.primary"
mb={1}
>
Variant:
</Typography>
<RadioGroup
size="sm"
aria-labelledby="variant-label"
name="variant"
value={variant}
onChange={(event) => setVariant(event.target.value as VariantProp)}
>
<Radio label="Solid" value="solid" />
<Radio label="Soft" value="soft" />
<Radio label="Outlined" value="outlined" />
<Radio label="Plain" value="plain" />
</RadioGroup>
</Sheet>
</Box>
);
}
22 changes: 22 additions & 0 deletions docs/data/joy/components/link/LinkDisabled.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Link from '@mui/joy/Link';

export default function LinkDisabled() {
return (
<Box sx={{ display: 'flex', gap: 2, flexWrap: 'wrap' }}>
<Link href="#disabled" disabled variant="solid">
Solid
</Link>
<Link href="#disabled" disabled variant="soft">
Soft
</Link>
<Link href="#disabled" disabled variant="outlined">
Outlined
</Link>
<Link href="#disabled" disabled variant="plain">
Plain
</Link>
</Box>
);
}
22 changes: 22 additions & 0 deletions docs/data/joy/components/link/LinkDisabled.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Link from '@mui/joy/Link';

export default function LinkDisabled() {
return (
<Box sx={{ display: 'flex', gap: 2, flexWrap: 'wrap' }}>
<Link href="#disabled" disabled variant="solid">
Solid
</Link>
<Link href="#disabled" disabled variant="soft">
Soft
</Link>
<Link href="#disabled" disabled variant="outlined">
Outlined
</Link>
<Link href="#disabled" disabled variant="plain">
Plain
</Link>
</Box>
);
}
12 changes: 12 additions & 0 deletions docs/data/joy/components/link/LinkDisabled.tsx.preview
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<Link href="#disabled" disabled variant="solid">
Solid
</Link>
<Link href="#disabled" disabled variant="soft">
Soft
</Link>
<Link href="#disabled" disabled variant="outlined">
Outlined
</Link>
<Link href="#disabled" disabled variant="plain">
Plain
</Link>
37 changes: 37 additions & 0 deletions docs/data/joy/components/link/LinkLevels.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Link from '@mui/joy/Link';

export default function LinkLevels() {
return (
<Box sx={{ display: 'flex', gap: 2, alignItems: 'center', flexWrap: 'wrap' }}>
<Link href="#levels" level="h1">
H1
</Link>
<Link href="#levels" level="h2">
H2
</Link>
<Link href="#levels" level="h3">
H3
</Link>
<Link href="#levels" level="h4">
H4
</Link>
<Link href="#levels" level="h5">
H5
</Link>
<Link href="#levels" level="h6">
H6
</Link>
<Link href="#levels" level="body1">
Body 1
</Link>
<Link href="#levels" level="body2">
Body 2
</Link>
<Link href="#levels" level="body3">
Body 3
</Link>
</Box>
);
}
37 changes: 37 additions & 0 deletions docs/data/joy/components/link/LinkLevels.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Link from '@mui/joy/Link';

export default function LinkLevels() {
return (
<Box sx={{ display: 'flex', gap: 2, alignItems: 'center', flexWrap: 'wrap' }}>
<Link href="#levels" level="h1">
H1
</Link>
<Link href="#levels" level="h2">
H2
</Link>
<Link href="#levels" level="h3">
H3
</Link>
<Link href="#levels" level="h4">
H4
</Link>
<Link href="#levels" level="h5">
H5
</Link>
<Link href="#levels" level="h6">
H6
</Link>
<Link href="#levels" level="body1">
Body 1
</Link>
<Link href="#levels" level="body2">
Body 2
</Link>
<Link href="#levels" level="body3">
Body 3
</Link>
</Box>
);
}
19 changes: 19 additions & 0 deletions docs/data/joy/components/link/LinkUnderline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Link from '@mui/joy/Link';

export default function LinkUnderline() {
return (
<Box sx={{ display: 'flex', gap: 2, flexWrap: 'wrap' }}>
<Link href="#underline" underline="always">
Always
</Link>
<Link href="#underline" underline="hover">
Hover
</Link>
<Link href="#underline" underline="none">
None
</Link>
</Box>
);
}
19 changes: 19 additions & 0 deletions docs/data/joy/components/link/LinkUnderline.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as React from 'react';
import Box from '@mui/joy/Box';
import Link from '@mui/joy/Link';

export default function LinkUnderline() {
return (
<Box sx={{ display: 'flex', gap: 2, flexWrap: 'wrap' }}>
<Link href="#underline" underline="always">
Always
</Link>
<Link href="#underline" underline="hover">
Hover
</Link>
<Link href="#underline" underline="none">
None
</Link>
</Box>
);
}
9 changes: 9 additions & 0 deletions docs/data/joy/components/link/LinkUnderline.tsx.preview
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<Link href="#underline" underline="always">
Always
</Link>
<Link href="#underline" underline="hover">
Hover
</Link>
<Link href="#underline" underline="none">
None
</Link>
Loading