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

[material-ui][docs] Add TemplateFrame to templates #43406

Merged
merged 7 commits into from
Aug 27, 2024
Merged

[material-ui][docs] Add TemplateFrame to templates #43406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
03fde79
Add TemplateFrame to templates
zanivan Aug 22, 2024
7a9d5bc
Skip regression
zanivan Aug 22, 2024
25863e8
Fix input label
zanivan Aug 23, 2024
cbb9b75
Fix typo
zanivan Aug 23, 2024
920b6ec
Remove container from TemplateFrame
zanivan Aug 23, 2024
4e82a0b
Remove blank line
zanivan Aug 23, 2024
99e2ca2
Removed comments
zanivan Aug 27, 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
42 changes: 21 additions & 21 deletions docs/data/material/getting-started/templates/blog/Blog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import AppAppBar from './components/AppAppBar';
import MainContent from './components/MainContent';
import Latest from './components/Latest';
import Footer from './components/Footer';
import NavBar from './NavBar';
import TemplateFrame from './TemplateFrame';

import getBlogTheme from './theme/getBlogTheme';

Expand Down Expand Up @@ -41,25 +41,25 @@ export default function Blog() {
};

return (
<ThemeProvider theme={showCustomTheme ? blogTheme : defaultTheme}>
<CssBaseline />
{/* you can delete this NavBar component since it's just no navigate to other pages */}
<NavBar
toggleCustomTheme={toggleCustomTheme}
showCustomTheme={showCustomTheme}
mode={mode}
toggleColorMode={toggleColorMode}
/>
<AppAppBar />
<Container
maxWidth="lg"
component="main"
sx={{ display: 'flex', flexDirection: 'column', mt: 24, mb: 16, gap: 4 }}
>
<MainContent />
<Latest />
</Container>
<Footer />
</ThemeProvider>
<TemplateFrame
toggleCustomTheme={toggleCustomTheme}
showCustomTheme={showCustomTheme}
mode={mode}
toggleColorMode={toggleColorMode}
>
<ThemeProvider theme={showCustomTheme ? blogTheme : defaultTheme}>
<CssBaseline />
<AppAppBar />
<Container
maxWidth="lg"
component="main"
sx={{ display: 'flex', flexDirection: 'column', my: 16, gap: 4 }}
>
<MainContent />
<Latest />
</Container>
<Footer />
</ThemeProvider>
</TemplateFrame>
);
}
43 changes: 22 additions & 21 deletions docs/data/material/getting-started/templates/blog/Blog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import AppAppBar from './components/AppAppBar';
import MainContent from './components/MainContent';
import Latest from './components/Latest';
import Footer from './components/Footer';
import NavBar from './NavBar';
import TemplateFrame from './TemplateFrame';

import getBlogTheme from './theme/getBlogTheme';

Expand Down Expand Up @@ -41,25 +41,26 @@ export default function Blog() {
};

return (
<ThemeProvider theme={showCustomTheme ? blogTheme : defaultTheme}>
<CssBaseline />
{/* you can delete this NavBar component since it's just no navigate to other pages */}
<NavBar
toggleCustomTheme={toggleCustomTheme}
showCustomTheme={showCustomTheme}
mode={mode}
toggleColorMode={toggleColorMode}
/>
<AppAppBar />
<Container
maxWidth="lg"
component="main"
sx={{ display: 'flex', flexDirection: 'column', mt: 24, mb: 16, gap: 4 }}
>
<MainContent />
<Latest />
</Container>
<Footer />
</ThemeProvider>
<TemplateFrame
toggleCustomTheme={toggleCustomTheme}
showCustomTheme={showCustomTheme}
mode={mode}
toggleColorMode={toggleColorMode}
>
<ThemeProvider theme={showCustomTheme ? blogTheme : defaultTheme}>
<CssBaseline />

<AppAppBar />
<Container
maxWidth="lg"
component="main"
sx={{ display: 'flex', flexDirection: 'column', my: 16, gap: 4 }}
>
<MainContent />
<Latest />
</Container>
<Footer />
</ThemeProvider>
</TemplateFrame>
);
}
35 changes: 24 additions & 11 deletions .../getting-started/templates/blog/NavBar.js → ...g-started/templates/blog/TemplateFrame.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,12 @@ import IconButton from '@mui/material/IconButton';
import Box from '@mui/material/Box';
import AppBar from '@mui/material/AppBar';
import Toolbar from '@mui/material/Toolbar';
import Container from '@mui/material/Container';
import ArrowBackRoundedIcon from '@mui/icons-material/ArrowBackRounded';
import ToggleColorMode from './components/ToggleColorMode';
import getBlogTheme from './theme/getBlogTheme';

const StyledAppBar = styled(AppBar)(({ theme }) => ({
position: 'fixed',
position: 'relative',
display: 'flex',
alignItems: 'center',
justifyContent: 'space-between',
Expand All @@ -25,23 +24,35 @@ const StyledAppBar = styled(AppBar)(({ theme }) => ({
backgroundColor: theme.palette.background.paper,
boxShadow: theme.shadows[1],
backgroundImage: 'none',
padding: 4,
zIndex: theme.zIndex.drawer + 1,
flex: '0 0 auto',
}));

function NavBar({ showCustomTheme, toggleCustomTheme, mode, toggleColorMode }) {
function TemplateFrame({
showCustomTheme,
toggleCustomTheme,
mode,
toggleColorMode,
children,
}) {
const handleChange = (event) => {
toggleCustomTheme(event.target.value === 'custom');
};
const blogTheme = createTheme(getBlogTheme(mode));

return (
<ThemeProvider theme={blogTheme}>
<StyledAppBar>
<Container maxWidth="lg">
<Box sx={{ height: '100dvh', display: 'flex', flexDirection: 'column' }}>
<StyledAppBar>
<Toolbar
variant="dense"
disableGutters
sx={{ display: 'flex', justifyContent: 'space-between' }}
sx={{
display: 'flex',
justifyContent: 'space-between',
width: '100%',
p: '8px 12px',
}}
>
<Button
variant="text"
Expand Down Expand Up @@ -84,17 +95,19 @@ function NavBar({ showCustomTheme, toggleCustomTheme, mode, toggleColorMode }) {
/>
</Box>
</Toolbar>
</Container>
</StyledAppBar>
</StyledAppBar>
<Box sx={{ flex: '1 1', overflow: 'auto' }}>{children}</Box>
</Box>
</ThemeProvider>
);
}

NavBar.propTypes = {
TemplateFrame.propTypes = {
children: PropTypes.node,
mode: PropTypes.oneOf(['dark', 'light']).isRequired,
showCustomTheme: PropTypes.bool.isRequired,
toggleColorMode: PropTypes.func.isRequired,
toggleCustomTheme: PropTypes.func.isRequired,
};

export default NavBar;
export default TemplateFrame;
30 changes: 19 additions & 11 deletions ...getting-started/templates/blog/NavBar.tsx → ...-started/templates/blog/TemplateFrame.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ import IconButton from '@mui/material/IconButton';
import Box from '@mui/material/Box';
import AppBar from '@mui/material/AppBar';
import Toolbar from '@mui/material/Toolbar';
import Container from '@mui/material/Container';
import ArrowBackRoundedIcon from '@mui/icons-material/ArrowBackRounded';
import ToggleColorMode from './components/ToggleColorMode';
import getBlogTheme from './theme/getBlogTheme';

const StyledAppBar = styled(AppBar)(({ theme }) => ({
position: 'fixed',
position: 'relative',
display: 'flex',
alignItems: 'center',
justifyContent: 'space-between',
Expand All @@ -29,35 +28,43 @@ const StyledAppBar = styled(AppBar)(({ theme }) => ({
backgroundColor: theme.palette.background.paper,
boxShadow: theme.shadows[1],
backgroundImage: 'none',
padding: 4,
zIndex: theme.zIndex.drawer + 1,
flex: '0 0 auto',
}));

interface NavBarProps {
interface TemplateFrameProps {
showCustomTheme: boolean;
toggleCustomTheme: (theme: boolean) => void;
mode: PaletteMode;
toggleColorMode: () => void;
children: React.ReactNode;
}

export default function NavBar({
export default function TemplateFrame({
showCustomTheme,
toggleCustomTheme,
mode,
toggleColorMode,
}: NavBarProps) {
children,
}: TemplateFrameProps) {
const handleChange = (event: SelectChangeEvent) => {
toggleCustomTheme(event.target.value === 'custom');
};
const blogTheme = createTheme(getBlogTheme(mode));

return (
<ThemeProvider theme={blogTheme}>
<StyledAppBar>
<Container maxWidth="lg">
<Box sx={{ height: '100dvh', display: 'flex', flexDirection: 'column' }}>
<StyledAppBar>
<Toolbar
variant="dense"
disableGutters
sx={{ display: 'flex', justifyContent: 'space-between' }}
sx={{
display: 'flex',
justifyContent: 'space-between',
width: '100%',
p: '8px 12px',
}}
>
<Button
variant="text"
Expand Down Expand Up @@ -100,8 +107,9 @@ export default function NavBar({
/>
</Box>
</Toolbar>
</Container>
</StyledAppBar>
</StyledAppBar>
<Box sx={{ flex: '1 1', overflow: 'auto' }}>{children}</Box>
</Box>
</ThemeProvider>
);
}
5 changes: 1 addition & 4 deletions docs/data/material/getting-started/templates/blog/components/Footer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import Link from '@mui/material/Link';
import Stack from '@mui/material/Stack';
import TextField from '@mui/material/TextField';
import Typography from '@mui/material/Typography';
import { visuallyHidden } from '@mui/utils';
import FacebookIcon from '@mui/icons-material/GitHub';
import LinkedInIcon from '@mui/icons-material/LinkedIn';
import TwitterIcon from '@mui/icons-material/X';
Expand Down Expand Up @@ -70,10 +69,8 @@ export default function Footer() {
<Typography variant="body2" sx={{ color: 'text.secondary', mb: 2 }}>
Subscribe for weekly updates. No spams ever!
</Typography>
<InputLabel htmlFor="email-newsletter">Email</InputLabel>
<Stack direction="row" spacing={1} useFlexGap>
<InputLabel htmlFor="email-newsletter" sx={visuallyHidden}>
Email
</InputLabel>
<TextField
id="email-newsletter"
hiddenLabel
Expand Down
5 changes: 1 addition & 4 deletions docs/data/material/getting-started/templates/blog/components/Footer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import Link from '@mui/material/Link';
import Stack from '@mui/material/Stack';
import TextField from '@mui/material/TextField';
import Typography from '@mui/material/Typography';
import { visuallyHidden } from '@mui/utils';
import FacebookIcon from '@mui/icons-material/GitHub';
import LinkedInIcon from '@mui/icons-material/LinkedIn';
import TwitterIcon from '@mui/icons-material/X';
Expand Down Expand Up @@ -70,10 +69,8 @@ export default function Footer() {
<Typography variant="body2" sx={{ color: 'text.secondary', mb: 2 }}>
Subscribe for weekly updates. No spams ever!
</Typography>
<InputLabel htmlFor="email-newsletter">Email</InputLabel>
<Stack direction="row" spacing={1} useFlexGap>
<InputLabel htmlFor="email-newsletter" sx={visuallyHidden}>
Email
</InputLabel>
<TextField
id="email-newsletter"
hiddenLabel
Expand Down
Loading