Skip to content

[docs] Adjust some casings and sections in component docs #4306

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

Merged
prakhargupta1 merged 4 commits into from
Oct 28, 2024
Merged

[docs] Adjust some casings and sections in component docs #4306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63fd530
Adjust casing and sections in component docs
apedroferreira Oct 25, 2024
df26924
Merge branch 'master' into docs-adjustments-25-10-24
apedroferreira Oct 25, 2024
bb3f7b9
fix installation image
prakhargupta1 Oct 28, 2024
984db74
Merge branch 'master' into docs-adjustments-25-10-24
prakhargupta1 Oct 28, 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
4 changes: 2 additions & 2 deletions docs/data/toolpad/core/components/account/account.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ The `Account` component is a quick and easy way to display an account management

## States

### Signed In
### Signed in

If a `session` object is present, the component is rendered as a dropdown containing the user's account details as well as an option to sign out.

{{"demo": "AccountDemoSignedIn.js", "bg": "outlined" }}

### Signed Out
### Signed out

When signed out, the component renders as an inline sign in button within the dashboard layout.

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/core/components/app-provider/app-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export default function App(props) {
}
```

## Client-side Routing
## Client-side routing

The `AppProvider` for React Router includes routing out-of-the-box for projects using [react-router-dom](https://www.npmjs.com/package/react-router-dom).

Expand Down
14 changes: 7 additions & 7 deletions docs/data/toolpad/core/components/dashboard-layout/dashboard-layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The `navigation` prop in the [AppProvider](https://mui.com/toolpad/core/react-ap

The flexibility in composing and ordering these different elements allows for a great variety of navigation structures to fit your use case.

### Navigation Links
### Navigation links

Navigation links can be placed in the sidebar as items with the format:

Expand All @@ -52,7 +52,7 @@ Navigation links can be placed in the sidebar as items with the format:

{{"demo": "DashboardLayoutNavigationLinks.js", "height": 400, "iframe": true}}

### Navigation Headings
### Navigation headings

Navigation headings can be placed in the sidebar as items with the format:

Expand All @@ -62,7 +62,7 @@ Navigation headings can be placed in the sidebar as items with the format:

{{"demo": "DashboardLayoutNavigationHeadings.js", "height": 400, "iframe": true}}

### Navigation Dividers
### Navigation dividers

Dividers can can be placed between items in the sidebar as items with the format:

Expand All @@ -74,7 +74,7 @@ Dividers can can be placed between items in the sidebar as items with the format

{{"demo": "DashboardLayoutNavigationDividers.js", "height": 400, "iframe": true}}

### Nested Navigation
### Nested navigation

Nested navigation structures can be placed in the sidebar as items with the format:

Expand All @@ -84,13 +84,13 @@ Nested navigation structures can be placed in the sidebar as items with the form

{{"demo": "DashboardLayoutNavigationNested.js", "height": 400, "iframe": true}}

### Navigation Actions
### Navigation actions

Navigation links have an optional `action` prop to render any content on the right-side of the respective list item, such as badges with numbers, or buttons to toggle a popover menu.

{{"demo": "DashboardLayoutNavigationActions.js", "height": 400, "iframe": true}}

### Navigation Pattern Matching
### Navigation pattern matching

Navigation links have an optional `pattern` prop to define a pattern to be matched for the item to be marked as selected.
This feature is built on top of the [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library. Some examples:
Expand Down Expand Up @@ -121,7 +121,7 @@ The layout sidebar can be hidden if needed with the `hideNavigation` prop.

{{"demo": "DashboardLayoutSidebarHidden.js", "height": 400, "iframe": true}}

### Full-size content
## Full-size content

The layout content can take up the full available area with styles such as `flex: 1` or `height: 100%`.

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/core/introduction/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,6 @@ yarn dev

and the following page appears when you run the project locally:

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/core/installation-1.png", "alt": "Toolpad Core entry point", "caption": "Starting with Toolpad Core", "zoom": true, "indent": 1 }}
{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/core/bootstrap.png", "srcDark": "/static/toolpad/docs/core/bootstrap-dark.png","alt": "Toolpad Core entry point", "caption": "Starting with Toolpad Core", "zoom": true, "indent": 1 }}

5. Installation is complete! Begin building your project by making edits to `(dashboard/page/page.tsx`. To understand how to leverage Toolpad Core to build dashboards quickly, [see the detailed tutorial](/toolpad/core/introduction/tutorial/).