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.

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] Improve Toolpad Core docs #43796

Merged
merged 20 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
2 changes: 1 addition & 1 deletion docs/data/material/components/app-bar/app-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,4 @@ You can override this behavior by setting the `enableColorOnDark` prop to `true`

oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved
The [DashboardLayout](https://mui.com/toolpad/core/react-dashboard-layout/) component from `@toolpad/core` is the starting point for dashboarding applications. It takes care of application layout, theming, navigation, and more. An example usage of this component:

{{"demo": "DashboardLayoutBasic.js", "height": 400, "iframe": true, "defaultExpanded": false}}
{{"demo": "DashboardLayoutBasic.js", "height": 400, "iframe": true, "bg": "inline", "defaultExpanded": false}}
2 changes: 1 addition & 1 deletion docs/data/material/components/container/container.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ The max-width matches the min-width of the current breakpoint.

The [PageContainer](https://mui.com/toolpad/core/react-page-container/) component in `@toolpad/core` is the ideal wrapper for the content of your dashboard. It makes the Material UI Container navigation-aware and extends it with page title, breadcrumbs, actions, and more.

{{"demo": "../breadcrumbs/PageContainerBasic.js", "height": 400, "defaultExpanded": false}}
{{"demo": "../breadcrumbs/PageContainerBasic.js", "height": 400, "bg": "inline", "defaultExpanded": false}}
8 changes: 4 additions & 4 deletions docs/data/material/components/dialogs/dialogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,14 +172,14 @@ Follow the [Modal accessibility section](/material-ui/react-modal/#accessibility

### useDialogs

You can create and manipulate dialogs imperatively with the [`useDialogs()`](https://mui.com/toolpad/core/react-use-dialogs/) API in `@toolpad/core`. This API provides the following features:
You can create and manipulate dialogs imperatively with the useDialogs() API in @toolpad/core. This hook handles
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

- state management for opening and closing dialogs
- reading data from and passing data to dialogs
- passing data to dialogs and receiving results back from them
- stacking multiple dialogs
- themed alternatives for `window.alert()`, `window.confirm`() and `window.prompt()`
- themed, asynchronous versions of `window.alert()`, `window.confirm()` and `window.prompt()`

The following example demonstrates these features:
The following example demonstrates some of these features:

{{"demo": "ToolpadDialogsNoSnap.js", "defaultCodeOpen": false}}

Expand Down
2 changes: 1 addition & 1 deletion docs/data/material/getting-started/templates/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Looking for something more? You can find complete templates and themes in the <a

[Toolpad Core](https://mui.com/toolpad/core/introduction/) is a set of components designed to build dashboards and internal tools. It leverages the existing suite of components offered by Material UI and ties them together to help you create applications quickly.

{{"demo": "../../components/app-bar/DashboardLayoutBasic.js", "height": 400, "iframe": true, "hideToolbar": true}}
{{"demo": "../../components/app-bar/DashboardLayoutBasic.js", "height": 400, "iframe": true, "defaultExpanded": false, "bg": "inline"}}