Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
78 commits
Select commit Hold shift + click to select a range
8b7db60
add Connect-related content on the documentation
danilo-leal Jan 29, 2024
8ab0f54
update content and image
danilo-leal Feb 13, 2024
55d31ba
update border color on dark mode
danilo-leal Feb 13, 2024
7e94a1a
iterate on the Design kits paragraph
danilo-leal Feb 13, 2024
36db8ab
Merge branch 'master' into connect-documentation-content
danilo-leal Feb 13, 2024
8e0ce99
add first skeleton of the documentation
danilo-leal Feb 15, 2024
fbffcd9
run pnpm docs:i18n
danilo-leal Feb 15, 2024
d2885a7
add image to the top of the page
danilo-leal Feb 15, 2024
66ca88b
continue iterating on it
danilo-leal Feb 15, 2024
b902cc1
iterating on the existing tokens section
danilo-leal Feb 16, 2024
119888c
trigger CI checks
danilo-leal Feb 19, 2024
52fba0e
add the Material UI design kit docs
danilo-leal Feb 21, 2024
28a3ff9
Merge branch 'master' into connect-documentation-content
danilo-leal Feb 21, 2024
7c8f7f8
run docs:i18n
danilo-leal Feb 21, 2024
e9a8c44
reordering the pages
danilo-leal Feb 21, 2024
db30f41
run docs:i18n
danilo-leal Feb 21, 2024
6ed171b
remove the MUI prefix from Connect
danilo-leal Feb 28, 2024
7241d3b
remove markdown image element changes from this PR
danilo-leal Feb 28, 2024
6073fb5
run docs:i18n
danilo-leal Feb 28, 2024
b8a9d49
Merge branch 'master' into connect-documentation-content
danilo-leal Feb 28, 2024
917be65
Merge branch 'master' into connect-documentation-content
danilo-leal Mar 1, 2024
0650865
update links to remove the "mui" prefix
danilo-leal Mar 1, 2024
4422995
remove dash from "plugin"
danilo-leal Mar 1, 2024
9d1ce9d
fix error regarding the muiMarkdown import
danilo-leal Mar 4, 2024
a0eaa96
add YouTube videos embeds for the design kits
danilo-leal Mar 4, 2024
bb0dcf0
update Connect images
danilo-leal Mar 4, 2024
b55e401
remove the new chip from the design kit page
danilo-leal Mar 4, 2024
43c6070
iterating on the wording
danilo-leal Mar 8, 2024
c4d320d
Sam's first pass
danilo-leal Mar 25, 2024
63d75a7
Merge branch 'next' into connect-documentation-content
danilo-leal Mar 25, 2024
4821dd4
fix Vale brand name CI check
danilo-leal Mar 25, 2024
e5a6857
Merge branch 'next' into connect-documentation-content
danilo-leal Mar 27, 2024
8000746
add beta chip on the nav drawer item
danilo-leal Mar 28, 2024
baf0238
update the Connect page description
danilo-leal Mar 29, 2024
83ec809
lint: fix non-breaking space
danilo-leal Mar 29, 2024
06f85dc
added getting started section
DavidCnoops Apr 4, 2024
cabb22d
Vale lint: non-breaking space
danilo-leal Apr 4, 2024
8dbe6a2
formatting and adjustments
danilo-leal Apr 4, 2024
5702773
edit the design resources page
danilo-leal Apr 4, 2024
4179064
update to the design kits page
danilo-leal Apr 4, 2024
d22046d
Merge branch 'next' into connect-documentation-content
danilo-leal Apr 4, 2024
0acbe09
Vale lint: fix non-breaking space
danilo-leal Apr 4, 2024
f1d2bce
iterate and fix things on the content + add images
danilo-leal Apr 5, 2024
53b589c
add video about component customization
danilo-leal Apr 5, 2024
e0ea786
extra: fix Demo border styles
danilo-leal Apr 5, 2024
7f6457a
add content about code customizations
danilo-leal Apr 5, 2024
6ffb992
rerun CI checks again
danilo-leal Apr 5, 2024
1199a00
rerun CI checks again
danilo-leal Apr 5, 2024
e549426
Sam's Connect page review
danilo-leal Apr 5, 2024
3d28b19
Sam's review of the Material UI Design Kit page
danilo-leal Apr 5, 2024
bd6f6a6
Design Resources page review
danilo-leal Apr 5, 2024
1891e88
ensure there's non-breaking space
danilo-leal Apr 5, 2024
446741c
follow-up edits
danilo-leal Apr 5, 2024
0198a40
update the Connect page
danilo-leal Apr 8, 2024
f54724a
update the Material UI for Figma page
danilo-leal Apr 9, 2024
31e4bc5
update the Design resources page
danilo-leal Apr 9, 2024
41a8875
slightly revise the Material UI for Figma page
danilo-leal Apr 9, 2024
42f81a0
Vale lint: non-breakable space
danilo-leal Apr 9, 2024
1dfc377
various changes and tweaks
DavidCnoops Apr 9, 2024
53de30a
updated connect docs
DavidCnoops Apr 10, 2024
f2b83d9
updates to the Connect page
danilo-leal Apr 10, 2024
77516db
updates to the Material UI page
danilo-leal Apr 10, 2024
2bc570d
remove unused video
danilo-leal Apr 10, 2024
eee0ae0
compress all images
danilo-leal Apr 10, 2024
33852e8
Vale lint: non-breaking space
danilo-leal Apr 10, 2024
e0f36ee
remove changes on the Demo component
danilo-leal Apr 10, 2024
42050a3
rerun CI checks
danilo-leal Apr 10, 2024
ef9506f
small tweaks
DavidCnoops Apr 11, 2024
27c7b4e
fix linting error
DavidCnoops Apr 11, 2024
dfbee60
has selector clarification + removal of last example
DavidCnoops Apr 11, 2024
34b792a
fix linting error
DavidCnoops Apr 11, 2024
6eac877
Connect page updates
danilo-leal Apr 11, 2024
c2819b5
Material UI for Figma updates
danilo-leal Apr 11, 2024
f891ea5
Design Resources updates
danilo-leal Apr 11, 2024
f41058a
additional edits
danilo-leal Apr 11, 2024
6e53321
Vale lint: non-breakable space
danilo-leal Apr 11, 2024
b3df62e
fine-tune images
danilo-leal Apr 11, 2024
7f47327
Vale lint: non-breakable space
danilo-leal Apr 11, 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
Prev Previous commit
Next Next commit
Sam's first pass
  • Loading branch information
danilo-leal committed Mar 25, 2024
commit c4d320d788758595de3a9288b3096f90b6949ddb
43 changes: 22 additions & 21 deletions docs/data/material/design-resources/connect/connect.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,62 @@
# Connect plugin

<p class="description">A Figma plugin that lets you generate a theme from the Material UI Design kit for Figma. </p>
<p class="description">Connect is a Figma plugin that lets you generate a theme from the Material UI Design Kit.</p>

## Introduction

Connect is a Figma plugin that lets you generate a theme from the [Material UI Design kit for Figma](https://www.figma.com/community/file/912837788133317724/material-ui-for-figma-and-mui-x).
You can customize both design tokens and components, export a JSON file with the changes to your theme, and also see them through an embedded Storybook instance.
Connect is a Figma plugin that lets you generate a theme from the [Material UI Design Kit for Figma](https://www.figma.com/community/file/912837788133317724/material-ui-for-figma-and-mui-x).
You can customize design tokens and components, export a JSON file with the changes to your theme, and visualize your customizations through an embedded Storybook instance.

:::warning
The plugin is in beta and doesn't currently support customization to all Material UI components.
This plugin is currently in beta and some Material UI components cannot be customized yet.

Connect only supports the Material UI Design Kit; others, such as the Joy UI Design Kit, are not yet supported.
:::

<img src="/static/material-ui/design-resources/connect.png" style="width: 814px;" alt="A screenshot of Figma together with the Connect plugin running on the side, doing customziations to the Material UI Switch component." width="1628" height="400" />
<img src="/static/material-ui/design-resources/connect.png" style="width: 814px;" alt="A screenshot of Figma together with the Connect plugin running on the side, customizing the Material UI Switch component." width="1628" height="400" />

## Running the plugin

### Pre-requisites

The Connect Figma plugin only currently works on the Material UI Design kit.
It doesn't support other kits, such as Joy UI, at the moment.

### Basics

Test the plugin by starting with [the Community version](https://www.figma.com/community/file/912837788133317724/material-ui-for-figma-and-mui-x).
Then, visit the Store to get access to [the complete version](https://mui.com/r/material-ui-figma-latest/) with all of the Material UI components.

Once you've installed it, go to your copy of the Material UI design kit, click on the "Resources" button, go to the "Plugins" tab, and then click on "Connect".
Once you've installed it, go to your copy of the Material UI Design Kit, click on the **"Resources"** button, go to the **"Plugins"** tab, and then click on **"Connect"**.

<img src="/static/material-ui/design-resources/connect-access.png" style="width: 814px;" alt="A screenshot of Figma showcasing the resources menu, which is where you'd go to access Connect." width="1628" height="400" />

<!-- The image above will be replaced for a better one once the plugin is actually live -->

## Customizing design tokens

Design tokens consist of the styles that are defined through Figma's "Local variables" and "Local styles" features.
Design tokens consist of the styles that are defined through Figma's local variables and local styles.

### Existing tokens

The Material UI design kit comes fully loaded with design tokens that map out to [the React library's default theme](/material-ui/customization/default-theme/).
The Material UI Design Kit comes fully loaded with design tokens that map out to [the default theme of the Material UI React library](/material-ui/customization/default-theme/).

Connect can read all of the existing tokens in the theme.
To customize them using local variables, open the modal by clicking on the filter icon as shown above.
Tweak any of the variables available there as you see fit.
Then open the plugin and click on **Generate theme.**

<img src="/static/material-ui/design-resources/connect-variables.png" style="width: 814px;" alt="A screenshot of Figma showcasing the locals variables menu, which is where all of the design tokens are stored and where you'd go to add new ones." width="1628" height="400" />
After a few seconds, you should be able to see the updated theme with your customizations in the code editor.

To customize them, using the Local variables route as an example, open the modal by clicking on the filter icon, as shown above.
Tweak any of the variables available there as you see fit.
Then, open the plugin and click on "Generate theme".
After a few seconds, you should be able to see the updated theme, with your customizations, in the code editor.
<img src="/static/material-ui/design-resources/connect-variables.png" style="width: 814px;" alt="A screenshot of Figma showcasing the locals variables menu, which is where all of the design tokens are stored and where you'd go to add new ones." width="1628" height="400" />

### Adding new tokens

Adding new tokens (such as new colors, shadows, typography, etc.) to the existing list is also possible.
Ensure you add the new ones within the corresponding category and click "Generate theme" again to see them in the code editor tab.
You can add custom tokens such as new colors, shadows, or typography to the existing list.
Add your custom tokens to the appropriate category and click **Generate theme** again to see them in the code editor tab.

## Customizing the components

You can also customize how a component looks and generate its theme code using Connect.
You can customize how a component looks and generate its theme code using Connect.

:::warning
Currently, the only supported Material UI components are the Button, Switch, and Typography.
:::

## Adding the theme code into your codebase

Expand Down