Skip to content

Commit

Permalink
[core] Sync with main repo
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari committed Jan 27, 2024
1 parent dde6e63 commit e73a414
Show file tree
Hide file tree
Showing 41 changed files with 86 additions and 98 deletions.
12 changes: 5 additions & 7 deletions .github/ISSUE_TEMPLATE/1.bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ labels: ['status: waiting for maintainer']
body:
- type: markdown
attributes:
value: |
Please provide a searchable summary of the issue in the title above ⬆️.
Thanks for contributing by creating an issue! ❤️
value: Thanks for contributing by creating an issue! ❤️ Please provide a searchable summary of the issue in the title above ⬆️.
- type: input
attributes:
label: Search keywords
description: Your issue may have already been reported! List the keywords you've used to search the [existing issues](https://github.com/mui/mui-toolpad/issues). This will also make your issue searchable for others.
placeholder: e.g. canvas resizing
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-toolpad/issues).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
- type: checkboxes
Expand Down Expand Up @@ -47,7 +45,7 @@ body:
- type: textarea
attributes:
label: Context
description: What are you trying to accomplish? How has this issue affected you? Providing context helps us come up with a solution that is more useful in the real world.
description: What are you trying to accomplish? Providing context helps us come up with a solution that is more useful in the real world.
- type: textarea
attributes:
label: Your environment
Expand Down
20 changes: 9 additions & 11 deletions .github/ISSUE_TEMPLATE/2.feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,15 @@ labels: ['status: waiting for maintainer']
body:
- type: markdown
attributes:
value: |
Please provide a searchable summary of the issue in the title above ⬆️.
Thanks for contributing by creating an issue! ❤️
- type: checkboxes
value: Thanks for contributing by creating an issue! ❤️ Please provide a searchable summary of the issue in the title above ⬆️.
- type: input
attributes:
label: Duplicates
description: Please [search the history](https://github.com/mui/mui-toolpad/issues) to see if an issue already exists for the same problem.
options:
- label: I have searched the existing issues
required: true
label: Search keywords
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-toolpad/issues).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
- type: checkboxes
attributes:
label: Latest version
Expand All @@ -33,4 +31,4 @@ body:
- type: textarea
attributes:
label: Motivation
description: What are you trying to accomplish? How has the lack of this feature affected you? Providing context helps us come up with a solution that is more useful in the real world.
description: What are you trying to accomplish? Providing context helps us come up with a solution that is more useful in the real world.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/3.rfc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ body:
- type: textarea
attributes:
label: What's the problem?
description: Write a short paragraph or bulleted list to briefly explain what you're trying to do, what outcomes you're aiming for, and any other relevant details to help us understand the motivation behind this RFC.
description: Write a short paragraph or bulleted list to briefly explain what you're trying to do, what outcomes you're aiming for.
- type: textarea
attributes:
label: What are the requirements?
Expand All @@ -35,4 +35,4 @@ body:
- type: textarea
attributes:
label: Resources and benchmarks
description: Attach any issues, PRs, links, documents, etc… that might be relevant to the RFC
description: Attach any issues, PRs, links, documents, etc… that might be relevant to the RFC.
14 changes: 5 additions & 9 deletions .github/ISSUE_TEMPLATE/4.docs-feedback.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@ title: '[docs] '
body:
- type: markdown
attributes:
value: |
Please provide a searchable summary of the issue in the title above ⬆️.
Thanks for contributing by creating an issue! ❤️
value: Thanks for contributing by creating an issue! ❤️ Please provide a searchable summary of the issue in the title above ⬆️.
- type: input
attributes:
label: Search keywords
description: Your issue may have already been reported! List the keywords you've used to search the [existing issues](https://github.com/mui/mui-toolpad/issues). This will also make your issue searchable for others.
placeholder: e.g. datagrid column resizing
description: |
Your issue may have already been reported! First search for duplicates among the [existing issues](https://github.com/mui/mui-toolpad/issues).
If your issue isn't a duplicate, great! Please list the keywords you used so people in the future can find this one more easily:
validations:
required: true
- type: input
Expand All @@ -40,9 +38,7 @@ body:
label: Issue description
description: |
Let us know what went wrong when you were using this documentation and what we could do to improve it.
value: |
I was looking for ... and it appears that ...
- type: textarea
attributes:
label: Context
description: What are you trying to accomplish? What brought you to this page? Your context can help us to come up with solutions that benefit the community as a whole.
description: What are you trying to accomplish? Providing context helps us come up with a solution that is more useful in the real world.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ Chart component improvements, add scrolling to pages in app sidebar, Windows fix
- &#8203;<!-- 11 -->Remove some Next.js leftovers around monaco-editor (#2437) @Janpot
- &#8203;<!-- 10 -->Improve rest test flakyness (#2438) @Janpot
- &#8203;<!-- 09 -->Remove logging of RPC errors (#2410) @Janpot
- &#8203;<!-- 08 -->Scope MUI X license to builtin components only (#2427) @Janpot
- &#8203;<!-- 08 -->Scope MUI X license to builtin components only (#2427) @Janpot
- &#8203;<!-- 07 -->Clean up worker communication with devserver (#2418) @Janpot
- &#8203;<!-- 06 -->Add note about why we need usePolling (#2426) @Janpot
- &#8203;<!-- 05 -->Adjust timeout and import node-fetch in create-toolpad-app test (#2414) (#2419) @Kirera-Wainaina
Expand Down Expand Up @@ -1940,7 +1940,7 @@ Fixes and improvements all around, banner prompting to upgrade Toolpad
- &#8203;<!-- 15 -->Fix naive content-type sniffing implementation (#940) @Janpot
- &#8203;<!-- 14 -->Format function source on save (#942) @Janpot
- &#8203;<!-- 13 -->Allow recreating data grid columns from existing data (#914) @apedroferreira
- &#8203;<!-- 12 -->Port MUI X renovate.json (#933) @Janpot
- &#8203;<!-- 12 -->Port MUI X renovate.json (#933) @Janpot
- &#8203;<!-- 11 -->Run yarn upgrade (#923) @apedroferreira
- &#8203;<!-- 10 -->Try enabling renovate again (#913) @Janpot
- &#8203;<!-- 09 -->Make sure to always assign the overlayroot (#915) @Janpot
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Local development

If you would like to hack on MUI Toolpad or want to run the latest version, you can follow these steps:
If you would like to hack on MUI Toolpad or want to run the latest version, you can follow these steps:

_If you're looking into contributing to the docs, follow the [instructions](#building-and-running-the-documentation) down below_

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- markdownlint-disable-next-line -->
<p align="center">
<a href="https://mui.com/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/logo.svg" alt="MUI logo"></a>
<a href="https://mui.com/" rel="noopener" target="_blank"><img width="150" src="https://mui.com/static/logo.svg" alt="MUI Toolpad logo"></a>
</p>

<h1 align="center">MUI Toolpad</h1>
<h1 align="center">MUI Toolpad</h1>

<div align="center">

Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trades who want to save time building internal applications.
Quickly build internal tools. MUI Toolpad is a self-hosted low-code internal tools builder designed to extend the [MUI](https://mui.com/) React components. It's designed for developers of all trades who want to save time building internal applications.

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)

Expand Down Expand Up @@ -35,7 +35,7 @@ A [big change](https://github.com/mui/mui-toolpad/discussions/1748) is coming: w

## Notice

MUI Toolpad is in its beta stages of development. Feel free to run this application to try it out for your use cases, and share any feedback, bug reports or feature requests that you come across.
MUI Toolpad is in its beta stages of development. Feel free to run this application to try it out for your use cases, and share any feedback, bug reports or feature requests that you come across.

## Quick setup locally

Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MUI Toolpad docs
# MUI Toolpad docs

This is the documentation website of MUI Toolpad.
This is the documentation website of MUI Toolpad.

To start the docs site in development mode, from the project root, run:

Expand All @@ -12,7 +12,7 @@ If you do not have yarn installed, select your OS and follow the instructions on

_DO NOT USE NPM, use Yarn to install the dependencies._

Visit the [MUI Toolpad documentation](https://mui.com/toolpad/getting-started/).
Visit the [MUI Toolpad documentation](https://mui.com/toolpad/getting-started/).

## How can I add a new demo to the documentation?

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/components/datagrid/datagrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Demo

Toolpad builds on top of the [MUI X Data Grid](https://mui.com/x/react-data-grid/) to add faster customisation and integration with your internal tools.
Toolpad builds on top of the [MUI X Data Grid](https://mui.com/x/react-data-grid/) to add faster customisation and integration with your internal tools.

{{"demo": "DataGrid.js", "hideToolbar": true, "bg": "inline"}}

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/concepts/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ In order to provide a customised styling to the components used in your pages, y

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/concepts/theming/theme-3.png", "alt": "Add sx prop", "caption": "Adding custom styles via the sx prop", "aspectRatio": 2.5 }}

Once you click on the `sx` prop, add style overrides in the JSON editor. Any value that is accepted by the MUI System [sx](https://mui.com/system/getting-started/the-sx-prop/) prop is acceptable here.
Once you click on the `sx` prop, add style overrides in the JSON editor. Any value that is accepted by the MUI System [sx](https://mui.com/system/getting-started/the-sx-prop/) prop is acceptable here.

{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/concepts/theming/theme-4.png", "alt": "Add custom styles", "caption": "Styling the Image component" }}
4 changes: 2 additions & 2 deletions docs/data/toolpad/getting-started/first-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<p class="description">Learn the fundamentals of building with Toolpad by creating a small application.</p>

This guide will walk you through the process of creating a small Toolpad application.
You'll use the MUI X Data Grid component to display a list of dog breeds from the [Dog API](https://dog.ceo/dog-api/).
When you click on the name of a breed, a random photo of the breed will be displayed using the Material UI Image component.
You'll use the MUI X Data Grid component to display a list of dog breeds from the [Dog API](https://dog.ceo/dog-api/).
When you click on the name of a breed, a random photo of the breed will be displayed using the Material UI Image component.

## Purpose

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/getting-started/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ The roadmap does not represent a commitment, obligation, or promise to deliver a

## Global roadmap

To learn more about our plans for MUI in general, visit the [global roadmap](/material-ui/discover-more/roadmap/).
To learn more about our plans for Material UI in general, visit the [global roadmap](/material-ui/discover-more/roadmap/).
2 changes: 1 addition & 1 deletion docs/data/toolpad/getting-started/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Toolpad uses GitHub issues to track bug reports and feature requests.

If you think you've found a bug in the codebase, or you have an idea for a new feature, please [search the issues on GitHub](https://github.com/mui/mui-toolpad/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aclosed) before opening a new one, to ensure you're not creating a duplicate.

- [Open an issue on MUI Toolpad](https://github.com/mui/mui-toolpad/issues/new/choose) for issues or feature requests.
- [Open an issue on MUI Toolpad](https://github.com/mui/mui-toolpad/issues/new/choose) for issues or feature requests.
- [Start a GitHub discussion](https://github.com/mui/mui-toolpad/discussions) for a broad topic. Here you can engage with the team and the discussion would likely result in one or more GitHub issues.

#### New issue guidelines
Expand Down
4 changes: 2 additions & 2 deletions docs/data/toolpad/getting-started/why-toolpad.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## TL;DR

- **Higher-level API**. Toolpad operates at a higher abstraction level than Material UI. It sets healthy UI constraints that prevent common pitfalls and anti-patterns.
- **Higher-level API**. Toolpad operates at a higher abstraction level than Material UI. It sets healthy UI constraints that prevent common pitfalls and anti-patterns.
- **Drag-and-drop builder**. Toolpad comes with a drag-and-drop builder to simplify UI building. The builder saves the UI as a YAML file, so you can even modify and version the visual output on your file system.
- **Less boilerplate** so you can focus on the essential parts of the app.
- **Run alongside existing code**. Toolpad integrates well with your existing code. You can use your database models, client libraries, secrets, and bespoke components directly.
Expand Down Expand Up @@ -75,7 +75,7 @@ Addressing the problems mentioned above leads to a better developer experience.

### Drag-and-drop builder

Toolpad works as a drag-and-drop UI builder and uses MUI's own Material UI components. Material UI includes all of the foundational components required for internal use cases. Toolpad currently supports 16 of them, and we're continuously adding more.
Toolpad works as a drag-and-drop UI builder and uses MUI's own Material UI components. Material UI includes all of the foundational components required for internal use cases. Toolpad currently supports 16 of them, and we're continuously adding more.

Toolpad supports adding any number of custom React components for other use cases. The drag-and-drop builder enables you to quickly assemble a minimum viable UI that's endlessly customizable, ensuring the best of both worlds: speed _and_ flexibility.

Expand Down
2 changes: 1 addition & 1 deletion docs/data/toolpad/how-to-guides/customize-datagrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ By default, you can connect any JSON data to a Toolpad data grid and it will att

## Customizing cell rendering

However, if the default column options are not sufficient, Toolpad allows you to customize your data grid with custom components, using the powerful features of the <a href="https://mui.com/x/react-data-grid/">MUI X Data Grid</a>.
However, if the default column options are not sufficient, Toolpad allows you to customize your data grid with custom components, using the powerful features of the <a href="https://mui.com/x/react-data-grid/">MUI X Data Grid</a>.

### Creating a custom component

Expand Down
4 changes: 2 additions & 2 deletions docs/data/toolpad/reference/components/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<p class="description">API docs for the Toolpad Autocomplete component.</p>

A text input with autocomplete suggestions. Uses the Material UI [Autocomplete](https://mui.com/material-ui/react-autocomplete/) under the hood
A text input with autocomplete suggestions. Uses the Material UI [Autocomplete](https://mui.com/material-ui/react-autocomplete/) under the hood

## Properties

Expand All @@ -21,4 +21,4 @@ A text input with autocomplete suggestions. Uses the Material UI [Autocomplete](
| <span class="prop-name">name</span> | <span class="prop-type">string</span> | | Name of this input. Used as a reference in form data. |
| <span class="prop-name">isRequired</span> | <span class="prop-type">boolean</span> | <span class="prop-default">false</span> | Whether the input is required to have a value. |
| <span class="prop-name">isInvalid</span> | <span class="prop-type">boolean</span> | <span class="prop-default">false</span> | Whether the input value is invalid. |
| <span class="prop-name">sx</span> | <span class="prop-type">object</span> | | The [`sx` prop](https://mui.com/system/getting-started/the-sx-prop/) is used for defining custom styles that have access to the theme. All MUI System properties are available via the `sx` prop. In addition, the `sx` prop allows you to specify any other CSS rules you may need. |
| <span class="prop-name">sx</span> | <span class="prop-type">object</span> | | The [`sx` prop](https://mui.com/system/getting-started/the-sx-prop/) is used for defining custom styles that have access to the theme. All MUI System properties are available via the `sx` prop. In addition, the `sx` prop allows you to specify any other CSS rules you may need. |
Loading

0 comments on commit e73a414

Please sign in to comment.