Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

@soulpicks/atomic-layout

0.6.2 • Public • Published

Package version Build status Test coverage Package size (minzip) Dependencies status Development dependencies status Discord channel


Atomic layout

Atomic layout

Atomic layout is an implementational paradigm that delegates spacial distribution between any layout composites to the dedicated layer. That helps to create declarative, immutable, and maintainable layouts using CSS Grid.


Atomic layout uses Bootstrap 4 breakpoints by default. You can always define custom breakpoints to match your very requirements.

Motivation

Think of how we create layouts today. Most likely we define a set of reusable units (atoms) to combine them into functional compositions. But how do we handle spacing that should describe the position of our units? Usually, we manage CSS properties of those units to make sure the spacing is just right. Not only that results into writing redundant CSS, but it also makes our atoms contextual and, thus, non-maintainable.

Atomic layout solves this problem by exposing a dedicated layer responsible for spacial distribution in a layout, or any of its parts. That allows to reuse atom components in any layout possible without mutating them.

Install

Install the package using any package manager (npm, yarn, etc.):

yarn add atomic-layout

Requires React (15.0+) and styled-components (3.0+) as peer dependencies. Make sure those are installed.

Documentation

See the Official documentation.

Here are some shortcuts to get you started:

Materials

The Future of Layouts (React Vienna)

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.

The Future of Layouts — Artem Zakharchenko

Browser support

See the Support table for CSS Grid. For Internet Explorer support please read through this issue.

Contributing

Thank you to those deciding to contribute! Your involvement makes a significant impact on the library and its future.

After reading the Contribution guidelines, take a look at the issues labeled help wanted or good first issue, those are a good place to start. Feature suggestions or bug reports, discussion, and pull requests are always welcome.

Install

npm i @soulpicks/atomic-layout

DownloadsWeekly Downloads

0

Version

0.6.2

License

MIT

Unpacked Size

757 kB

Total Files

67

Last publish

Collaborators

  • avatar