Using React propTypes to bring design and development closer together

In recent years we have seen an explosion of tools that aim to bridge the gap between designers and developers (Bit, Sketch, Zeplin, etc.). Design systems, nowadays, are much more than a static and verbose list of guidelines — they are living systems with actual code components at their core. They are much closer to the product itself and to those who develop it.

UI Component Design System: A Developer’s Guide

JoniSar ・ Oct 23 '19

#design #ui #javascript #frontend

Building a Design System like Uber and Airbnb | Bits and Pieces

Jonathan Saring ・ Apr 11, 2021 ・

Medium

This progression towards a code-oriented design system is a real blessing, mostly since reading long lists of guidelines is an activity most of us would rather avoid. It is tedious and tiresome but worst of all, it makes it very easy to make mistakes. There is no immediate feedback correcting you if you happen to “break one of the styling rules” — you’re simply required to read the guidelines and implement them accordingly.

With today’s component design systems, “following the rules” is much easier. As a developer, you find abstract design rules embedded in your UI component library, stacked with reusable components that have been built according to your organization style guide and approved by all relevant decision-makers.

But, the story is not over yet. There are many things that are not found in the components themselves. In his blog post “Patterns ≠ Components”, Nathan Curtis makes the distinction between patterns and components:

“Components are how something DOES work, inclusive of tradeoffs and constraints realized through a build process. Patterns describe how something SHOULD work under preferred conditions and suggestions of how to cope with tradeoffs.

Components are an interface chunk to be added to an overall layout. whereas patterns may be UI or a variety of other things, like a behavior, flow, application motif or something else.”

For example, your component library may have an accordion component but it does not tell you how it should or shouldn’t be used. You may use the component in a perfectly valid way, code-wise, but fail to follow best practices regarding UI/UX.

Your design team may have strongly advised against using the accordion component to present pieces of content that differ too much in length but nothing in the component itself suggests that.

Using React propTypes

Embedding components with all best practices and guidelines is obviously unrealistic, but there’s much more that we can do in that domain.

For example, we may use React propTypes, to implement the aforementioned guidelines regarding accordion component (propTypes can be used in development and removed from the production build using babel-plugin-transform-react-remove-prop-types):

The data to be presented in the accordion component:

const info = [
  {title: 'Title 1',
  content: 'Lorem ipsum dolor sit amet, consectetur.'},

 {title: 'Title 2',
 content: `Lorem ipsum dolor sit amet, consectetur adipiscing elit,      sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.    Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris  nisi ut aliquip ex ea commodo consequat.   Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.   Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.`}
]

The accordion component with propType custom validation:

The above code serves only as an example for a way in which our validations could incorporate styling rules in UI component libraries. Other validation may test for correct color combinations (e.g. color + background-color) or even component compositions (e.g. a hero component may not include a range component as a child).

Example: Polaris’ color guidelines

Conclusion

Design systems are cross-domain enterprises and as such, they should speak the right language for each stakeholder. When you want to build a design system’s style guide that speaks to developers (let’s be honest, they are not going to read your style guide and refer to it on every decision) you have to find creative ways to communicate your design’s best practices in a way developers can understand and work with.

One such example is using react propTypes to validate the implementation of your design principles in your React components. This way, developers can easily follow the desired rules without having to go overboard. Feel free to give it a try for yourself, and please comment below to share your insights.

Thanks

Learn More

Let Everyone In Your Company Share Your Reusable Components | by Jonathan Saring | Bits and Pieces

Jonathan Saring ・ Aug 26, 2019 ・

Medium

How to Share React UI Components between Projects and Apps | by Jonathan Saring | Bits and Pieces

Jonathan Saring ・ Nov 18, 2020 ・

Medium