Awesome
<p align="center"> <img src="https://raw.githubusercontent.com/kettanaito/atomic-layout/master/logo-full.png" width="400" alt="Atomic Layout logo" /> </p> <div align="center"> </div> <br/>Atomic Layout is a spatial distribution library for React. It uses CSS Grid to define layout areas and render them as React components. This pattern encourages separation of elements and spacing, preventing contextual implementations and boosting maintenance of layouts.
import React from 'react'
import { Composition } from 'atomic-layout'
// Define layout areas: visual representation
// of what composes a layout, detached from
// what components are actually rendered.
const areasMobile = `
thumbnail
header
footer
`
// Declare responsive changes of your areas.
// Operate in two dimensions, remove areas
// or introduce new ones.
const areasTablet = `
thumbnail header
thumbnail footer
`
const Card = ({ title, imageUrl, actions }) => (
<Composition areas={areasMobile} areasMd={areasTablet} gap={20}>
{/* Get React components based on provided areas */}
{({ Thumbnail, Header, Footer }) => (
<React.Fragment>
<Thumbnail>
{/* Render anything, including another Composition */}
<img src={imageUrl} alt={title} />
</Thumbnail>
{/* Preserve semantics with polymorphic prop */}
<Header as="h3">{title}</Header>
{/* Responsive props: just suffix with a breakpoint name */}
<Footer padding={10} paddingMd={20}>
{actions}
</Footer>
</React.Fragment>
)}
</Composition>
)
export default Card
Atomic Layout is responsive-first. It uses Bootstrap 4 breakpoints by default, which you can always customize for your needs.
Motivation
Modern layout development is about modularity and composition. Following the best practices of Atomic design, we strive toward independent UI units that gradually compose into more meaningful pieces. While the attention paid to units implementation is thorough, we often overlook how to achieve layout composition that scales. It's as if we forget that spacing defines composition.
When it comes to distributing the spacing things get more difficult. First of all, true contextless spacing is hard. To make things worse, all present solutions couple spacing with UI elements, inevitably making small reusable pieces contextful and, thus, hard to maintain.
Atomic Layout helps you to compose your elements by introducing a dedicated spacing layer called Composition. It encourages you to separate concerns between UI elements' visual appearance and spacing between them. With the first-class responsive support at your disposal you can build gorgeous responsive permutations of your elements without leaving the dedicated spacing layer, keeping UI elements contextless and predictable. Embrace the era of a true layout composition!
Implementations
Atomic Layout has multiple implementations depending on the styling solution:
Package name | Latest version | Styling library |
---|---|---|
atomic-layout | styled-components | |
@atomic-layout/emotion | @emotion/styled |
Documentation
See the Official documentation.
Here are some shortcuts for quick access:
Examples
Although the examples below use
atomic-layout
package, they are fully compatible with other styling implementations of the library (i.e.@atomic-layout/emotion
).
Basics
<table border="0"> <tr> <td width="33%" valign="top"> <a href="https://codesandbox.io/s/basic-composition-5mvlr" target="_blank"> <img src="materials/example-thumbnails/basic-composition.jpg" alt="Basic composition: square and circle" /> <h4>Basic composition</h4> </a> <p>Combine two UI elements into a single one using Composition.</p> </td> <td width="33%" valign="top"> <a href="https://codesandbox.io/s/responsive-props-8m14f" target="_blank"> <img src="materials/example-thumbnails/responsive-props.jpg" alt="Component with responsive props" /> <h4>Responsive props</h4> </a> <p>Change a prop's value depending on a breakpoint.</p> </td> <td width="33%" valign="top"> <a href="https://codesandbox.io/s/nested-composition-8p8pk" target="_blank"> <img src="materials/example-thumbnails/nested-composition.jpg" alt="Composition of other compositions" /> <h4>Nested composition</h4> </a> <p>Any element can be a composition <i>and</i> a composite at the same time.</p> </td> </tr> </table>Intermediate
<table border="0"> <tr> <td width="33%" valign="top"> <a href="https://codesandbox.io/s/conditional-rendering-4k90o" target="_blank"> <img src="materials/example-thumbnails/conditional-rendering.jpg" alt="Conditional rendering" /> <h4>Conditional rendering</h4> </a> <p>Render or display elements conditionally based on breakpoints.</p> </td> <td width="33%" valign="top"> <a href="https://codesandbox.io/s/custom-configuration-d01ku" target="_blank"> <img src="materials/example-thumbnails/custom-configuration.jpg" alt="Custom configuration" /> <h4>Custom configuration</h4> </a> <p>Configure a default measurement unit, custom breakpoints, and responsive behaviors.</p> </td> <td width="33%" valign="top"> <a href="https://codesandbox.io/s/atomic-layout-query-d2mdl" target="_blank"> <img src="materials/example-thumbnails/shorthand-media-query.jpg" alt="Shorthand media query" /> <h4>Shorthand media query</h4> </a> <p>Use a shorthand <code>query</code> function to declare inline media queries in CSS.</p> </td> </tr> </table>Materials
<table border="0"> <tr> <td> <a href="https://www.youtube.com/watch?v=_HrXUB97xQs"> <img width="500" src="https://github.com/kettanaito/atomic-layout/blob/master/materials/react-finland-thumbnail.jpg" alt="Artem speaking at React Finland" /> </a> </td> <td> <h3><a href="https://www.youtube.com/watch?v=_HrXUB97xQs">Creating layouts that last (React Finland, 2019)</a></h3> <p>Find out the main aspects of a layout's maintainability and why spacing plays a crucial role in it. Learn how to wield layout composition as an actual React component–a missing glue for your elements and design systems.</p> <ul> <li><a href="https://codesandbox.io/s/5wwp76310n"><strong>Live demo</strong></a></li> </ul> </td> </tr> <tr> <td> <img width="500" src="https://pbs.twimg.com/profile_images/699140827218649088/mooXwM62_400x400.png" alt="SurviveJS logo" /> </td> <td> <h3><a href="https://survivejs.com/blog/atomic-layout-interview/">Layout composition as a React component (SurviveJS)</a></h3> <p>Read through the extensive interview about how Atomic layout came to be, how it's different from other solutions, and which practices it encourages.</p> </td> </tr> <tr> <td> <a href="https://www.youtube.com/watch?v=x_93DjN_bUA"> <img width="500" src="https://github.com/kettanaito/atomic-layout/blob/master/materials/react-vienna-thumbnail.jpg" alt="The Future of Layouts — Artem Zakharchenko" /> </a> </td> <td> <h3><a href="https://www.youtube.com/watch?v=x_93DjN_bUA">The future of layouts (React Vienna, 2018)</a></h3> <p>Watch Artem discussing the biggest obstacle to achieve maintainable layouts, and showcases a way to combine existing technologies to build clean UI implementations using Atomic layout.</p> <ul> <li><a href="https://codesandbox.io/s/8z6xnmnnnj"><strong>Live demo</strong></a></li> <li><a href="http://future-of-layouts.surge.sh">Slides</a></li> </ul> </td> </tr> </table>Community
Reach out to us to share an awesome project you're building, or ask a question:
Browser support
Atomic Layout's browser support is made by the browser support of underlying technologies the library uses. Pay attention if your project can support CSS Grid to be sure you can use Atomic Layout.
See the Support table for CSS Grid. For Internet Explorer support please read this issue.
Contributing
By contributing to Atomic Layout you shape the way developers create reusable UI.
Please refer to the Contribution guidelines before committing to this project. We are thankful for any kind of contribution you may bring: discussion, issue report, or a pull request.