A "welcome" is in order, and let's also set some expectations while we are at it!

An Introduction to Figma, Figmagic, and Design Systems

I hope you are excited! We'll be using some very nice tools and some skeletons I've pre-provided to fast-track our way to a design system!

The course project

Introduction

Let's take care of the essentials first, like setting up a development environment, Git and Node.

Prerequisites

Figma reshaped how millions of people and companies follow the design process. Now, we're going to form our process around it.

An Intro to Figma: Shortcuts, Frames, and Components

Get a spot in the world's biggest (probably!?) JavaScript community—NPM.

How to Set up NPM to Publish JavaScript Packages

Get hooked up with the premier place on the planet to share, build, and discuss code—open source or otherwise.

Setting up GitHub

Next stop is hosting, where we'll use Cloudflare Pages, one of the most exciting tech services around.

Setting up Cloudflare

Last but not least, we need to get our visual inspection platform and Storybook hosting working. For this, we will turn to Chromatic.

Setting up Chromatic

Preparation

Let me introduce you to my take on the concept of "continuous design."

An Intro to Continuous Design: DevOps for Design

Time to set the stage and see what we can do to be a top shop using continuous design principles and tooling.

Build a Continuous Design Workflow With a Design System

A diagram can be the difference between an organization of "petty kings" doing their own thing and having actionable plans built on a shared identity. What we need is some kind of governance.

Build Better Design and Change Governance With Flows

One magic, simple concept (design token) and a one-stop shop to contain our design equal one hell of a powerhouse.

Intro to Design Tokens: How to Communicate in Design Work

Going from static files, private work, and image-based output to a collaborative, real-time component-oriented tool changes everything about the design workflow.

Why Figma? The Pros of Collaborative Design

Figmagic is the last piece in our toolchain that acts as the glue needed to super-charge your productivity.

An Intro to Figmagic, the Figma CLI For Token Design

Enabling 'Continuous Design'

It's high time to get to know the Figma API, one of the real stars of our show.

How to Use the Figma API and Read Figma Documents

Time to get knee-deep in coding, which we will kick-start by using a bit of boilerplate that we're going to scaffold.

How to Scaffold a React Codebase With Degit

It's vital we have a solid grounding for our component workflow if we are to build an entire library of them. In this lesson, we will set up a smooth, component-driven development workflow from code to Storybook.

Build a Component Development Workflow With Storybook

That song with the "I like to move it-move it" lyrics must have been about pushing code to production...right?

Automatically Deploy React Code to GitHub and Cloudflare

While dogfooding does sound yucky, it's a word that connotes the practice of using one's own things, sometimes to build something new. That's what we will do now with the components we've built.

How to Publish a React Component Library to NPM

Putting in the last fixes for our tooling means getting our Continuous Integration operational.

Finishing the CI Setup

Setting up a pipeline for design and code

With all the other hard, boxy stuff behind us, the perspective now moves to the front-end components and Figma.

How to Set up Figmagic to Interact With Figma via CLI

Working effectively with Figmagic means understanding how and what it actually parses from a document.

How Figma Files Are Organized in Figmagic

Getting to know the configuration options is super important if you want to make the best use of Figmagic.

An Intro to Figmagic Command Line Configuration

Getting to know Figmagic

Let's find our way by analyzing our UX sketches before digging into the details and building anything.

UX Sketching and Double Diamonds: Build Atomic Design

Let's move on from basics to the intermediate level and actually make some designs.

How to Create Design Tokens and Styles in Figma

Let's put the Figma-first approach to the test by taking the step to turn a design into code.

How to Break up Designs Into Small, Atomic Components

Starting our design system

And now for some bells and whistles—graphics and icons!

How to Build Icons in Figma and Export Them With Figmagic

Galloping ever onwards, we'll wave our magic wand and summon our low-complexity components.

Flat vs Nested Elements in Figma and Figmagic

Now, we leave the easy flat components for the more detailed nested ones!

How to Create Nested Figma Elements in Figmagic

Code generation with Figmagic 4 will only take you so far. For our most important and complicated components, we will need to do some manual work, composing small bits into more advanced ones. Let's compose one from what we've made so far!

How to Compose Complex Components With Figmagic

Extra credit time—adding the components for the checkout view.

Finishing the Checkout Components (optional)

Building elements and components

Good documentation is vital and shows that you care about your design system and those who will use it. Lacking good documentation practices could spell doom for a design system.

How to Author Quality Design Documentation

The very first documentation step we will take is to describe what we have built so far.

Add Storybook Descriptions For Self-Documenting Designs

Storybook is a brilliant tool for documentation, and we'll make good use of it in several ways.

How to Structure Storybook for Documentation

Documentation and Storybook

We have talked about "continuity" a lot, so it's about time we address how to deal with change in practice.

How to Plan for Design and Component Life Cycles

Things need to be in order before we continue.

Export Components With GitHub Chromatic Actions

Time to fill up our UI platform with our work to date!

A Beginner's Guide to Using Chromatic With Storybook

Communicating and giving feedback on our work is the lifeblood of a design system.

Building a Feedback Loop For Your Design System

Let's automate the release of new components.

Publish New Design Components With GitHub Actions

Time to place the final cherry on the top. Cue up "I've got the power"!

How to Trigger GitHub Actions From a Figma Plugin

The design life cycle

Summary and thank you

Among developers and architects, "continuous integration and delivery/deployment" (CI/CD for short) has increasingly become the norm for almost two decades. And while frontend development has gone through the framework revolution, going from design to code with the speed expected of CI/CD is still a pain. But it doesn't need to be!

This 10-module course is taught by Mikael Vesavuori, an architect and developer who has helped companies like Polestar redefine their technology and design processes, tooling and ways of working.

In the course, we will create a full component-based React-driven application with Figmagic, underpinned by Storybook, good documentation, and with CI and automated testing.

We will bring the dev-designer collaboration to its current state-of-the-art with a DevOps-inspired life cycle, which could be called “continuous design” (after continuous integration/deployment or CI/CD).

While there is a pre-defined, specific toolset that we’ll use, the end goal of the course is to teach you a wider perspective of what it means to work end-to-end with design systems. Nearly all individual tools are exchangeable: we’re more interested in the capabilities enabling our desired way-of-working than the specific tools chosen to get there.

This course is a comprehensive guide to building a React component library based on a well-architectured design system. You’ll create a full component-based React-driven application with Figmagic, underpinned by Storybook, good documentation, and with CI and automated testing. Learn senior-level system architecture skills for frontend React code; skills you can apply broadly in working on any frontend application.

The newline Guide to React Component Design Systems with Figmagic

How to set up a continuous design pipeline from code to CI/CD, using some of the best services out there

What Figma, Figmagic, and design tokens are and how they enable you to be more productive

How design tokens can function as a contract between designers and developers, setting up powerful new ways of working

The history of design/code tooling and how to argue for process and tooling change

Understand the value of documentation, using Storybook and Figma to document your work

Storybook 6 uses the MDX format to allow for some rather extensive possibilities in how you can document and create stories. In this lesson, we are going to do a full house cleaning, setting up the essentials.

Our documentation will be short and more "indicative" than a perfect representation of full documentation. On the other hand, what we've built is also not too complicated, and our domain does not need a lot of elaboration. So, let's get going!

Go through all elements and look at their 

. Save and go to Storybook, and you'll find all elements in their own category.

This is a bit neater and easier to scan and find what you are looking for.

One very smart and easy way to document components is to add prop types to them. I'll guide you through setting up prop docs for the Image element. This is a good use-case, as it has some non-obvious prop names and functionality. Also, it has a mix of required and selective props.

Start Storybook and open up the Image element. You can see the props for the element in both 

 views, but the full description is only in the 

This story is not configured to handle controls.

, meaning, in our case, we are missing data, so it's not going to show anything.

Image.propTypes = {
  /**
   * The URL for the image to use.
   */
  url: PropTypes.string.isRequired,
  /**
   * The height of the element in pixels. Defaults to "296px".
   */
  height: PropTypes.string,
  /**
   * Should this have hard (sharp) corners? Defaults to false (rounded corners).
   */
  hardCorners: PropTypes.bool
};

Image.defaultProps = {
  height: "296px",
  hardCorners: false
};

Because an Image element without an actual image makes no sense, we require the 

 prop. For the other two props, which are only aesthetic in nature, we are setting them as selective and also being explicit with what their defaults are.

Save and switch back to Storybook. Notice how the prop description is now updated with what we just wrote.

You can also see this reflected under the 

---
title: How to Structure Storybook for Documentation
description: Storybook is a brilliant tool for documentation, and we'll make good use of it in several ways.
#privateVideoUrl: https://fullstack.wistia.com/media/xxxxx
isPublicLesson: false
useMdx: true
code: https://gitlab.com/fullstackio/books/newline-course-apps/mikael-vesavuori-react-component-design-systems-with-figmagic-app/-/tree/main/code/module_08/lesson_08.03/App?ref_type=heads
---

Storybook 6 uses the MDX format to allow for some rather extensive possibilities in how you can document and create stories. In this lesson, we are going to do a full house cleaning, setting up the essentials.

Our documentation will be short and more "indicative" than a perfect representation of full documentation. On the other hand, what we've built is also not too complicated, and our domain does not need a lot of elaboration. So, let's get going!

## Organize all elements in an `elements` category

Go through all elements and look at their `<Meta title="{SOMETHING}"...>`. Prefix their respective names with `elements/`. Save and go to Storybook, and you'll find all elements in their own category.

This is a bit neater and easier to scan and find what you are looking for.

![Storybook categorized items](https://d2uusema5elisf.cloudfront.net/courses/newline-guide-to-react-component-design-systems-with-figmagic/module_08/lesson_08.03/public/assets/storybook-categorized-items.png)

## Prop types

One very smart and easy way to document components is to add prop types to them. I'll guide you through setting up prop docs for the Image element. This is a good use-case, as it has some non-obvious prop names and functionality. Also, it has a mix of required and selective props.

Start Storybook and open up the Image element. You can see the props for the element in both **Canvas** and **Docs** views, but the full description is only in the **Docs** tab—go there. You'll find the `onClickEvent` prop at the bottom, in the **ArgsTable**. It might say, `This story is not configured to handle controls.`, meaning, in our case, we are missing data, so it's not going to show anything.

Now, open up `src/elements/Image/Image.js`. Update the prop types object to:

```javascript { actualFilename=./protected/ImageProps.js endChar=398 endLine=19 startChar=0 startLine=1 statedFilename=./protected/ImageProps.js url=https&#x3A;//gitlab.com/fullstackio/books/newline-guide-to-react-component-design-systems-with-figmagic/module_08/lesson_08.03/protected/ImageProps.js }
Image.propTypes = {
  /**
   * The URL for the image to use.
   */
  url: PropTypes.string.isRequired,
  /**
   * The height of the element in pixels. Defaults to "296px".
   */
  height: PropTypes.string,
  /**
   * Should this have hard (sharp) corners? Defaults to false (rounded corners).
   */
  hardCorners: PropTypes.bool
};

Image.defaultProps = {
  height: "296px",
  hardCorners: false
};
```

Because an Image element without an actual image makes no sense, we require the `url` prop. For the other two props, which are only aesthetic in nature, we are setting them as selective and also being explicit with what their defaults are.

Save and switch back to Storybook. Notice how the prop description is now updated with what we just wrote.

![Image props description](https://d2uusema5elisf.cloudfront.net/courses/newline-guide-to-react-component-design-systems-with-figmagic/module_08/lesson_08.03/public/assets/image-canvas.png)