Skip to content
This repository has been archived by the owner on Aug 21, 2021. It is now read-only.

walmartlabs/layout

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


NOTICE:

This repository has been archived and is not supported.

No Maintenance Intended


NOTICE: SUPPORT FOR THIS PROJECT HAS ENDED

This projected was owned and maintained by Walmart. This project has reached its end of life and Walmart no longer supports this project.

We will no longer be monitoring the issues for this project or reviewing pull requests. You are free to continue using this project under the license terms or forks of this project at your own risk. This project is no longer subject to Walmart's bug bounty program or other security monitoring.

Actions you can take

We recommend you take the following action:

  • Review any configuration files used for build automation and make appropriate updates to remove or replace this project
  • Notify other members of your team and/or organization of this change
  • Notify your security team to help you evaluate alternative options

Forking and transition of ownership

For security reasons, Walmart does not transfer the ownership of our primary repos on Github or other platforms to other individuals/organizations. Further, we do not transfer ownership of packages for public package management systems.

If you would like to fork this package and continue development, you should choose a new name for the project and create your own packages, build automation, etc.

Please review the licensing terms of this project, which continue to be in effect even after decommission.

Layout

Layout is a responsive helper component that we use in our responsive designs at Walmart Labs.

This screenshot shows a simple multi-column layout using the Bootstrap grid.

Simple multi-column layout

In this case it's 3 columns wide in x-small and 4 columns wide in small.

In this next example we show specifying the widths of the individual columns (in 12 column layout values) for both x-small and small.

Layout with column sizes

Running the example

To install and run do:

npm install
npm run showcase

Usage

Default column options are based on a 12 column layout.

Simple Multi-Columns

Using the following props allows you to pass in a number of columns (max 12) (integer) to display the columns at a consistent width.

Each prop type correlates to a breakpoint:

  • x-small - integer Displays at <= 768px
  • small - integer Displays between 768px and 992px
  • medium - integer Displays between 992px and 1200px
  • large - integer Displays above 1200px

Options:

Number of columns: 1, 2, 3, 4, 6, 12

custom column widths at specific breakpoints

Using the following props allows you to pass in an array of column ratios. This is different than the above option.

  • x-small-sizes - Displays each child column at defined widths at <= 768px
  • small-sizes - Displays each child column at defined widths between 768px and 992px
  • medium-sizes - Displays each child column at defined widths between 992px and 1200px
  • large-sizes - Displays each child column at defined widths above 1200px

Options:

Array of width of columns: 1, 2, 3, 4, 6, 12