Skip to content

[docs] Add Templates listing to examples page#4449

Merged
bharatkashyap merged 3 commits intomui:masterfrom
bharatkashyap:examples-template
Nov 22, 2024
Merged

[docs] Add Templates listing to examples page#4449
bharatkashyap merged 3 commits intomui:masterfrom
bharatkashyap:examples-template

Conversation

@bharatkashyap
Copy link
Collaborator

@bharatkashyap bharatkashyap commented Nov 22, 2024

@bharatkashyap bharatkashyap added docs Improvements or additions to the documentation. examples Relating to /examples. labels Nov 22, 2024
Copy link
Contributor

@prakhargupta1 prakhargupta1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bharatkashyap bharatkashyap merged commit 79c6bf2 into mui:master Nov 22, 2024
<!-- #default-branch-switch -->

{{"component": "modules/components/ExamplesGrid/ExamplesGrid.tsx", "examplesFile": "core-examples.ts"}}
## Featured Examples
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please no loading state, fixing this in #4350.

@@ -9,4 +9,10 @@ title: Examples

<!-- #default-branch-switch -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this

Suggested change
<!-- #default-branch-switch -->

Fixing this in #4350.

Copy link
Member

@oliviertassinari oliviertassinari Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we keep pushing this, we will need to redo those screenshots, they don't work, proof:

SCR-20241226-qmjd

https://deploy-preview-4449--mui-toolpad-docs.netlify.app/toolpad/core/introduction/examples/#featured-examples

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;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is not required

Suggested change
href: string;
href?: string;

Fixing this in #4350.

'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',
Copy link
Member

@oliviertassinari oliviertassinari Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Labels

docs Improvements or additions to the documentation. examples Relating to /examples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants