[docs] Add Templates listing to examples page #4449
Merged
Conversation
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
Member
bharatkashyap
commented
Nov 22, 2024
•
bharatkashyap
commented
- Add the themed example as a featured example on the existing docs page, in the style of the Material UI templates list
- Link to this section from the Material UI docs
- https://deploy-preview-4449--mui-toolpad-docs.netlify.app/toolpad/core/templates/nextjs-dashboard
bharatkashyap
added
docs
prakhargupta1
approved these changes
Nov 22, 2024
There was a problem hiding this comment.
The featured example looks good: https://deploy-preview-4449--mui-toolpad-docs.netlify.app/toolpad/core/introduction/examples/ 🙌
| @@ -9,4 +9,10 @@ title: Examples | |||
|
|
|||
| <!-- #default-branch-switch --> | |||
|
|
|||
| {{"component": "modules/components/ExamplesGrid/ExamplesGrid.tsx", "examplesFile": "core-examples.ts"}} | |||
| ## Featured Examples | |||
There was a problem hiding this comment.
We use sentence case
Suggested change
| ## Featured Examples | |
| ## Featured examples |
Fixing this in #4350.
|
|
||
| export default function FeaturedExamples(props: FeaturedExamplesProps) { | ||
| const [examples, setExamples] = React.useState<Example[]>([]); | ||
| const [loading, setLoading] = React.useState(true); |
There was a problem hiding this comment.
Please no loading state, fixing this in #4350.
| @@ -9,4 +9,10 @@ title: Examples | |||
|
|
|||
| <!-- #default-branch-switch --> | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
If we keep pushing this, we will need to redo those screenshots, they don't work, proof:
To be clear:
- Aspect ratio is wrong, doesn't fit
- None consistent dimensions between light and dark mode
- Visible scrollbar
- Visible box shadow on the left
| description: string; | ||
| src: string; | ||
| srcDark?: string; | ||
| href: string; |
There was a problem hiding this comment.
| 'This app shows you how to get started using Toolpad Core with Next.js, Auth.js and customize the Material UI theme', | ||
| src: '/static/toolpad/docs/core/auth-next-themed.png', | ||
| srcDark: '/static/toolpad/docs/core/auth-next-themed-dark.png', | ||
| 'This example shows you how to get started building a dashboard with Toolpad Core, Next.js app router, Auth.js and Material UI components in a customized theme', |
There was a problem hiding this comment.
Leading dot:
Suggested change
| 'This example shows you how to get started building a dashboard with Toolpad Core, Next.js app router, Auth.js and Material UI components in a customized theme', | |
| 'This example shows you how to get started building a dashboard with Toolpad Core, Next.js app router, Auth.js and Material UI components in a customized theme.', |
Fixed this and the others in #4558
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.