Skip to content

Commit

Permalink
[blog] Add post to introduce the Connect plugin (mui#41763)
Browse files Browse the repository at this point in the history
  • Loading branch information
danilo-leal authored and DiegoAndai committed Apr 16, 2024
1 parent 6c6b6fe commit 8ef913a
Show file tree
Hide file tree
Showing 13 changed files with 97 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/data/material/design-resources/connect/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ After you've added your custom tokens, click on **Regenerate theme** to include
Connect can also generate theme styles for customized components, enabling you to completely change their look and feel and create your custom design system from within Figma.

:::info
This feature is currently limited to the Button and Switch components.
This feature is currently limited to the Button, Switch, and Typography components.
Support for more components is coming soon.
:::

Expand Down
1 change: 1 addition & 0 deletions docs/lib/sourcing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ const ALLOWED_TAGS = [
'MUI X',
'MUI System',
'Toolpad',
'Connect',
];

export const getAllBlogPosts = () => {
Expand Down
7 changes: 7 additions & 0 deletions docs/pages/blog/introducing-connect.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import * as React from 'react';
import TopLayoutBlog from 'docs/src/modules/components/TopLayoutBlog';
import { docs } from './introducing-connect.md?muiMarkdown';

export default function Page() {
return <TopLayoutBlog docs={docs} />;
}
68 changes: 68 additions & 0 deletions docs/pages/blog/introducing-connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: 'Introducing Connect: a Figma plugin that exports Material UI code'
description: Connect is a Figma plugin that lets you generate a theme from the Material UI for Figma Design Kit.
date: 2024-04-16T00:00:00.000Z
authors: ['danilo-leal', 'DavidCnoops']
tags: ['Connect', 'Material UI', 'Product']
manualCard: true
---

Over the last few years we've seen designers increasingly seeking out ways to participate more directly and collaborate more effectively in the development process.
The [Material UI Design Kit for Figma](/store/items/figma-react/) was our first attempt to meet those needs by providing designers with one-to-one mockups of Material UI components for implementing custom design systems.
But it doesn't go far enough on its own to bridge the gap between design and code—the developer still need to write the designer's custom styles from scratch.

That got us thinking:
What if designers could generate production-ready code directly from their design software to hand off to developers working with a Material UI codebase?

That's why we created Connect, a Figma plugin for generating styles that can be copied and pasted straight into your Material UI app's theme.
We're happy to share that the beta version is [available now on Figma](https://www.figma.com/community/plugin/1336346114713490235/connect). 🚀

<img src="/static/blog/introducing-connect/card.png" alt="Connect is a Figma plugin that lets you generate a theme from the Material UI for Figma Design Kit." width="1280" height="640" />

Let's take a look at some of its key features:

## Theme customization

Figma's local variables significantly matured the use of design tokens, making it possible to mirror Material UI more closely.
Connect relies on these local variables to generate code corresponding to each element and state.
(As such, it requires [v5.16.0 or later](https://github.com/mui/mui-design-kits/releases/tag/v5.16.0) of the Material UI Design Kit; earlier versions do not support local variables.)

<video preload="metadata" controls muted loop playsinline width="1584" height="1080">
  <source src="/static/blog/introducing-connect/theme-customization.mp4" type="video/mp4">
</video>

Visit the documentation to learn [how to insert the generated code into your theme file](/material-ui/design-resources/connect/#using-the-generated-theme).

## Component customization

You can fully customize a component's appearance across multiple states in the Design Kit and then generate the corresponding theme code.
This is one of the most exciting features because it enables designers to use the visual design tools they're already comfortable with to make changes to the code itself.

<video preload="metadata" controls muted loop playsinline width="1584" height="1080">
  <source src="/static/blog/introducing-connect/custom-component.mp4" type="video/mp4">
</video>

:::warning
While in beta, not all components are supported yet.
We'll expand component coverage progressively in the coming months.
For now you can experiment with the Button, Switch, and Typography.
:::

## Quick Storybook preview

The Connect plugin also bakes in an embedded Storybook preview panel so that you can conveniently play around with your changes and see how they interact with other props and states available in the component API.

<video preload="metadata" autoplay muted loop playsinline width="1584" height="1080">
  <source src="/static/blog/introducing-connect/storybook.mp4" type="video/mp4">
</video>

## Try Connect now

Get the beta version of Connect now, available for free in the [Figma Community](https://www.figma.com/community/plugin/1336346114713490235/connect)!

There's still a lot to do, and we're looking forward to hearing from all of you [who requested this plugin years ago](https://github.com/mui/mui-design-kits/issues/10).

- Check out further documentation for [the Connect plugin](/material-ui/design-resources/connect/) and [the Material UI Design Kit](/material-ui/design-resources/material-ui-for-figma/).
- If you've got any feedback, we'd love to [hear from you](https://mui-connect.canny.io/feedback).

Happy designing! 👨‍🎨
15 changes: 13 additions & 2 deletions docs/pages/careers.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -467,15 +467,26 @@ export default function Careers() {
href={routeUrl}
noLinkStyle
variant="outlined"
sx={{ p: 2, width: '100%', flexGrow: 1 }}
sx={{
p: 2,
width: '100%',
flexGrow: 1,
display: 'flex',
flexDirection: 'column',
}}
>
<Typography variant="body2" fontWeight="bold" sx={{ mb: 0.5 }}>
{title}
</Typography>
<Typography variant="body2" color="text.secondary" sx={{ mb: 1 }}>
{description}
</Typography>
<Typography variant="body2" fontWeight="bold" color="primary">
<Typography
variant="body2"
fontWeight="bold"
color="primary"
sx={{ mt: 'auto' }}
>
Learn more{' '}
<KeyboardArrowRightRounded
fontSize="small"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion docs/src/modules/components/TopLayoutBlog.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,11 @@ export const authors = {
avatar: 'https://avatars.githubusercontent.com/u/16889233',
github: 'DiegoAndai',
},
DavidCnoops: {
name: 'David Cnoops',
avatar: 'https://avatars.githubusercontent.com/u/28001064',
github: 'DavidCnoops',
},
};

const classes = {
Expand Down Expand Up @@ -284,7 +289,7 @@ export default function TopLayoutBlog(props) {
const { canonicalAsServer } = pathnameToLanguage(router.asPath);
const card =
headers.manualCard === 'true'
? `https://mui.com/static/blog/${slug}/card.png`
? `/static/blog/${slug}/card.png`
: `/edge-functions/og-image/?title=${headers.cardTitle || finalTitle}&authors=${headers.authors
.map((author) => {
const { github, name } = authors[author];
Expand Down
2 changes: 1 addition & 1 deletion packages/mui-docs/src/branding/brandingTheme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -905,7 +905,7 @@ export function getThemedComponents(): ThemeOptions {
...(variant === 'outlined' &&
color === 'primary' && {
borderColor: (theme.vars || theme).palette.primary[100],
backgroundColor: (theme.vars || theme).palette.primary[50],
backgroundColor: alpha(theme.palette.primary[100], 0.2),
...theme.applyDarkStyles({
color: (theme.vars || theme).palette.primary[300],
borderColor: alpha(theme.palette.primary[500], 0.2),
Expand Down

0 comments on commit 8ef913a

Please sign in to comment.