Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Toolpad

> [!WARNING]
> At the moment, the maintainers are primarily focused on other projects and are not actively working on Toolpad Core. We may not be able to respond promptly to issues or pull requests.
>
> You can use the **CRUD dashboard template** from the [Material UI React templates page](https://mui.com/material-ui/getting-started/templates/#free-templates) as an easy-to-customize, copy-pastable alternative to the main Toolpad Core components — including dashboard layout and CRUD features.
> You can use the **CRUD dashboard template** from the [Material UI React templates page](https://mui.com/material-ui/getting-started/templates/#free-templates) as an easy-to-customize, copy-pastable alternative to the main Toolpad Core components — including dashboard layout and CRUD features. To share any feedback, please check [this discussion](https://github.com/mui/toolpad/discussions/5011).

Check failure on line 6 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('Material UI' instead of 'Material UI') Raw Output: {"message": "[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('Material UI' instead of 'Material UI')", "location": {"path": "README.md", "range": {"start": {"line": 6, "column": 57}}}, "severity": "ERROR"}

---

Expand Down
4 changes: 4 additions & 0 deletions docs/data/toolpad/core/components/crud/crud.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ components: Crud, CrudProvider, List, Show, Create, Edit, CrudForm

<p class="description">The CRUD component provides UIs to interact with data from any data source.</p>

:::warning
If you are interested in this feature then please check and upvote [this issue](https://github.com/mui/mui-x/issues/20285).
:::

With the `Crud` component and its subcomponents you can easily generate pages where items from your data source can be listed in a table, shown individually in detail, or created and edited with forms. All with minimal configuration from a single data source definition.

## Demo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ components: AppProvider, DashboardLayout, DashboardHeader, ToolbarActions, Theme

<p class="description">The dashboard layout component provides a customizable out-of-the-box layout for a typical dashboard page.</p>

:::info
If this is your first time using Toolpad Core, it's recommended to read about the [basic concepts](/toolpad/core/introduction/base-concepts/) first.
:::warning
If you are interested in this feature then please check and upvote [this issue](https://github.com/mui/material-ui/issues/14519).
:::

The `DashboardLayout` component is a quick, easy way to provide a standard full-screen layout with a header and sidebar to any dashboard page, as well as ready-to-use and easy to customize navigation and branding.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ components: SignInPage, Account, NotificationsProvider, LocalizationProvider

<p class="description">A customizable sign-in UI component that abstracts away the pain needed to wire together a secure authentication page for your application.</p>

:::info
If this is your first time using Toolpad Core, it's recommended to read about the [basic concepts](/toolpad/core/introduction/base-concepts/) first.
:::warning
If you are interested in this feature then please check and upvote [this issue](https://github.com/mui/material-ui/issues/47238).
:::

The `SignInPage` component is a quick way to generate a ready-to-use authentication page with multiple OAuth providers, or a credentials form.
Expand Down
4 changes: 2 additions & 2 deletions docs/data/toolpad/core/components/use-dialogs/use-dialogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ components: DialogsProvider

<p class="description">Imperative APIs to open and interact with dialogs.</p>

:::info
If this is your first time using Toolpad Core, it's recommended to read about the [basic concepts](/toolpad/core/introduction/base-concepts/) first.
:::warning
If you are interested in this feature then please check and upvote [this issue](https://github.com/mui/material-ui/issues/24759).
:::

Toolpad Core offers a set of abstractions that makes interacting with dialogs simpler. It has an imperative API to open and close dialogs, and allows dialogs to be stacked on top of each other.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ components: NotificationsProvider

<p class="description">Imperative APIs to show and interact with application notifications.</p>

:::info
If this is your first time using Toolpad Core, it's recommended to read about the [basic concepts](/toolpad/core/introduction/base-concepts/) first.
:::warning
If you are interested in this feature then please check and upvote [this issue](https://github.com/mui/material-ui/issues/18098).
:::

Toolpad Core offers a set of abstractions that make it easier to interact with notifications. Notifications are used to give short updates to the user about things that are happening during the application lifetime. They appear at the bottom of the screen. The Toolpad API allows for opening multiple notifications concurrenlty.
Expand Down
6 changes: 0 additions & 6 deletions docs/data/toolpad/core/introduction/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ title: Toolpad Overview

<p class="description">A set of components to build dashboards with React.</p>

:::warning
At the moment the maintainers are primarily focused on other projects and are not actively adding new features to Toolpad Core. They may not be able to respond in a timely manner to issues or pull requests.

You can use the **CRUD dashboard template** from the [Material UI React templates page](https://mui.com/material-ui/getting-started/templates/#free-templates) as an easy-to-customize, copy-pastable alternative to the main Toolpad Core components — including dashboard layout and CRUD features.
:::

Toolpad Core is a set of full-stack react components that leverages existing MUI components, and ties them with the commonly-used backend integrations to help you create responsive dashboards and internal tools. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance.

{{"demo": "./Introduction.js", "height": 600, "iframe": true, "hideToolbar": true}}
Expand Down
16 changes: 16 additions & 0 deletions docs/pages/_app.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import { pathnameToLanguage } from 'docs/src/modules/utils/helpers';
import getProductInfoFromUrl from 'docs/src/modules/utils/getProductInfoFromUrl';
import { DocsProvider } from '@mui/docs/DocsProvider';
import { mapTranslations } from '@mui/docs/i18n';
import Box from '@mui/material/Box';
import Banner from '../src/modules/components/Banner';
import toolpadStudioPages from '../data/toolpad/studio/pages';
import toolpadCorePages from '../data/toolpad/core/pages';
import * as config from '../config';
Expand Down Expand Up @@ -169,6 +171,8 @@ function AppWrapper(props) {
const { children, emotionCache, pageProps } = props;

const router = useRouter();
const isDocs = router.asPath.startsWith('/toolpad/');
const isToolpadHome = router.asPath === '/toolpad/studio/' || router.asPath === '/toolpad/';
// TODO move productId & productCategoryId resolution to page layout.
// We should use the productId field from the markdown and fallback to getProductInfoFromUrl()
// if not present
Expand Down Expand Up @@ -279,6 +283,18 @@ function AppWrapper(props) {
<PageContext.Provider value={pageContextValue}>
<ThemeProvider>
<DocsStyledEngineProvider cacheLtr={emotionCache}>
{isDocs && !isToolpadHome ? (
<Box
sx={{
top: 'var(--MuiDocs-header-height)',

mt: 'var(--MuiDocs-header-height)',
ml: { lg: 'var(--MuiDocs-navDrawer-width)' },
}}
>
<Banner />
</Box>
) : null}
{children}
<GoogleAnalytics />
</DocsStyledEngineProvider>
Expand Down
Loading
Loading