Add DashboardLayout component to @toolpad/core #3554
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Dashboard Layout API | ||
|
|
||
| <p class="description">DashboardLayout API reference</p> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import * as React from 'react'; | ||
|
There was a problem hiding this comment. Was this hand-written? I think we should port the There was a problem hiding this comment. I hadn't noticed that, I guess I can include it in this PR if it's simple. There was a problem hiding this comment. I've added it here, seems to work fine 9465e74 |
||
| import Box from '@mui/material/Box'; | ||
| import Typography from '@mui/material/Typography'; | ||
| import DashboardIcon from '@mui/icons-material/Dashboard'; | ||
| import ShoppingCartIcon from '@mui/icons-material/ShoppingCart'; | ||
| import BarChartIcon from '@mui/icons-material/BarChart'; | ||
| import DescriptionIcon from '@mui/icons-material/Description'; | ||
| import LayersIcon from '@mui/icons-material/Layers'; | ||
| import { AppProvider } from '@toolpad/core/AppProvider'; | ||
| import { DashboardLayout } from '@toolpad/core/DashboardLayout'; | ||
|
|
||
| const NAVIGATION = [ | ||
| { | ||
| kind: 'header', | ||
| title: 'Main items', | ||
| }, | ||
| { | ||
| title: 'Dashboard', | ||
| icon: <DashboardIcon />, | ||
| }, | ||
| { | ||
| title: 'Orders', | ||
| icon: <ShoppingCartIcon />, | ||
| }, | ||
| { | ||
| kind: 'divider', | ||
| }, | ||
| { | ||
| kind: 'header', | ||
| title: 'Analytics', | ||
| }, | ||
| { | ||
| title: 'Reports', | ||
| icon: <BarChartIcon />, | ||
| children: [ | ||
| { | ||
| title: 'Sales', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Traffic', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: 'Integrations', | ||
| icon: <LayersIcon />, | ||
| }, | ||
| ]; | ||
|
|
||
| export default function DashboardLayoutBasic() { | ||
| return ( | ||
| <AppProvider navigation={NAVIGATION}> | ||
| <DashboardLayout> | ||
| <Box | ||
| sx={{ | ||
| py: 4, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| alignItems: 'center', | ||
| }} | ||
| > | ||
| <Typography>Dashboard content goes here.</Typography> | ||
| </Box> | ||
| </DashboardLayout> | ||
| </AppProvider> | ||
| ); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| import * as React from 'react'; | ||
| import Box from '@mui/material/Box'; | ||
| import Typography from '@mui/material/Typography'; | ||
| import DashboardIcon from '@mui/icons-material/Dashboard'; | ||
| import ShoppingCartIcon from '@mui/icons-material/ShoppingCart'; | ||
| import BarChartIcon from '@mui/icons-material/BarChart'; | ||
| import DescriptionIcon from '@mui/icons-material/Description'; | ||
| import LayersIcon from '@mui/icons-material/Layers'; | ||
| import { AppProvider } from '@toolpad/core/AppProvider'; | ||
| import { DashboardLayout } from '@toolpad/core/DashboardLayout'; | ||
| import type { Navigation } from '@toolpad/core'; | ||
|
|
||
| const NAVIGATION: Navigation = [ | ||
| { | ||
| kind: 'header', | ||
| title: 'Main items', | ||
| }, | ||
| { | ||
| title: 'Dashboard', | ||
| icon: <DashboardIcon />, | ||
| }, | ||
| { | ||
| title: 'Orders', | ||
| icon: <ShoppingCartIcon />, | ||
| }, | ||
| { | ||
| kind: 'divider', | ||
| }, | ||
| { | ||
| kind: 'header', | ||
| title: 'Analytics', | ||
| }, | ||
| { | ||
| title: 'Reports', | ||
| icon: <BarChartIcon />, | ||
| children: [ | ||
| { | ||
| title: 'Sales', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Traffic', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: 'Integrations', | ||
| icon: <LayersIcon />, | ||
| }, | ||
| ]; | ||
|
|
||
| export default function DashboardLayoutBasic() { | ||
| return ( | ||
| <AppProvider navigation={NAVIGATION}> | ||
| <DashboardLayout> | ||
| <Box | ||
| sx={{ | ||
| py: 4, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| alignItems: 'center', | ||
| }} | ||
| > | ||
| <Typography>Dashboard content goes here.</Typography> | ||
| </Box> | ||
| </DashboardLayout> | ||
| </AppProvider> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| import * as React from 'react'; | ||
| import Box from '@mui/material/Box'; | ||
| import Typography from '@mui/material/Typography'; | ||
| import DashboardIcon from '@mui/icons-material/Dashboard'; | ||
| import ShoppingCartIcon from '@mui/icons-material/ShoppingCart'; | ||
| import { AppProvider } from '@toolpad/core/AppProvider'; | ||
| import { DashboardLayout } from '@toolpad/core/DashboardLayout'; | ||
|
|
||
| const NAVIGATION = [ | ||
| { | ||
| title: 'Dashboard', | ||
| icon: <DashboardIcon />, | ||
| }, | ||
| { | ||
| title: 'Orders', | ||
| icon: <ShoppingCartIcon />, | ||
| }, | ||
| ]; | ||
|
|
||
| const BRANDING = { | ||
| logo: <img src="https://mui.com/static/logo.png" alt="MUI logo" />, | ||
| title: 'MUI', | ||
| }; | ||
|
|
||
| export default function DashboardLayoutBranding() { | ||
| return ( | ||
| <AppProvider navigation={NAVIGATION} branding={BRANDING}> | ||
| <DashboardLayout> | ||
| <Box | ||
| sx={{ | ||
| py: 4, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| alignItems: 'center', | ||
| }} | ||
| > | ||
| <Typography>Dashboard content goes here.</Typography> | ||
| </Box> | ||
| </DashboardLayout> | ||
| </AppProvider> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import * as React from 'react'; | ||
| import Box from '@mui/material/Box'; | ||
| import Typography from '@mui/material/Typography'; | ||
| import DashboardIcon from '@mui/icons-material/Dashboard'; | ||
| import ShoppingCartIcon from '@mui/icons-material/ShoppingCart'; | ||
| import { AppProvider } from '@toolpad/core/AppProvider'; | ||
| import { DashboardLayout } from '@toolpad/core/DashboardLayout'; | ||
| import type { Navigation, Branding } from '@toolpad/core'; | ||
|
|
||
| const NAVIGATION: Navigation = [ | ||
| { | ||
| title: 'Dashboard', | ||
| icon: <DashboardIcon />, | ||
| }, | ||
| { | ||
| title: 'Orders', | ||
| icon: <ShoppingCartIcon />, | ||
| }, | ||
| ]; | ||
|
|
||
| const BRANDING: Branding = { | ||
| logo: <img src="https://mui.com/static/logo.png" alt="MUI logo" />, | ||
| title: 'MUI', | ||
| }; | ||
|
|
||
| export default function DashboardLayoutBranding() { | ||
| return ( | ||
| <AppProvider navigation={NAVIGATION} branding={BRANDING}> | ||
| <DashboardLayout> | ||
| <Box | ||
| sx={{ | ||
| py: 4, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| alignItems: 'center', | ||
| }} | ||
| > | ||
| <Typography>Dashboard content goes here.</Typography> | ||
| </Box> | ||
| </DashboardLayout> | ||
| </AppProvider> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| import * as React from 'react'; | ||
| import Box from '@mui/material/Box'; | ||
| import Typography from '@mui/material/Typography'; | ||
| import DescriptionIcon from '@mui/icons-material/Description'; | ||
| import FolderIcon from '@mui/icons-material/Folder'; | ||
| import { AppProvider } from '@toolpad/core/AppProvider'; | ||
| import { DashboardLayout } from '@toolpad/core/DashboardLayout'; | ||
|
|
||
| const NAVIGATION = [ | ||
| { | ||
| title: 'Item 1', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Item 2', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Folder 1', | ||
| icon: <FolderIcon />, | ||
| children: [ | ||
| { | ||
| title: 'Item A1', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Item A2', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Folder A1', | ||
| icon: <FolderIcon />, | ||
| children: [ | ||
| { | ||
| title: 'Item B1', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Item B2', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| { kind: 'divider' }, | ||
| { | ||
| kind: 'header', | ||
| title: 'Header 1', | ||
| }, | ||
| { | ||
| title: 'Item A', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| kind: 'header', | ||
| title: 'Header 2', | ||
| }, | ||
| { | ||
| title: 'Item B', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Folder 2', | ||
| icon: <FolderIcon />, | ||
| children: [ | ||
| { | ||
| kind: 'header', | ||
| title: 'Header A1', | ||
| }, | ||
| { | ||
| title: 'Item C1', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { | ||
| title: 'Item C2', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| { kind: 'divider' }, | ||
| { | ||
| kind: 'header', | ||
| title: 'Header A2', | ||
| }, | ||
| { | ||
| title: 'Item C3', | ||
| icon: <DescriptionIcon />, | ||
| }, | ||
| ], | ||
| }, | ||
| ]; | ||
|
|
||
| export default function DashboardLayoutNavigation() { | ||
| return ( | ||
| <AppProvider navigation={NAVIGATION}> | ||
| <DashboardLayout> | ||
| <Box | ||
| sx={{ | ||
| py: 4, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| alignItems: 'center', | ||
| }} | ||
| > | ||
| <Typography>Dashboard content goes here.</Typography> | ||
| </Box> | ||
| </DashboardLayout> | ||
| </AppProvider> | ||
| ); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the API, let's port the docs generator from X?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can do that in this separate PR, right? #3536
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, the X one, I was checking the Base one, will take a look.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah yes, base may be better