@carbon/layout

What is @carbon/layout?

@carbon/layout is a package that provides layout utilities for building responsive and consistent layouts in web applications. It is part of the Carbon Design System, which is IBM's open-source design system for digital products and experiences.

What are @carbon/layout's main functionalities?

Spacing Scale

The spacing scale provides a set of predefined spacing values that can be used to maintain consistent spacing throughout your application. The values are based on a modular scale.

const { spacing } = require('@carbon/layout');
console.log(spacing[3]); // Outputs: '1rem'

Breakpoints

Breakpoints define the various screen sizes at which your layout should adapt. These predefined breakpoints help in creating responsive designs.

const { breakpoints } = require('@carbon/layout');
console.log(breakpoints.md.width); // Outputs: '672px'

Layout Grid

The layout grid provides a set of predefined column widths that can be used to create grid-based layouts. This helps in maintaining a consistent structure across different pages.

const { layout } = require('@carbon/layout');
console.log(layout['2-3']); // Outputs: '66.66667%'

Other packages similar to @carbon/layout

bootstrap

Bootstrap is a popular front-end framework that includes a comprehensive grid system, responsive breakpoints, and utility classes for spacing and layout. It is more feature-rich compared to @carbon/layout but also more complex.

tailwindcss

Tailwind CSS is a utility-first CSS framework that provides low-level utility classes for spacing, layout, and more. It offers more flexibility and customization options compared to @carbon/layout but requires a different approach to styling.

foundation-sites

Foundation is another front-end framework that includes a responsive grid system, breakpoints, and utility classes for layout. It is similar to Bootstrap but with a different design philosophy and set of components.

README

@carbon/layout

Layout helpers for digital and software products using the Carbon Design System

Getting started

To install @carbon/layout in your project, you will need to run the following command using npm:

npm install -S @carbon/layout

If you prefer Yarn, use the following command instead:

yarn add @carbon/layout

Usage

@carbon/layout provides a couple of useful utilities alongside the specification for the grid system for the IBM Design Language. This package includes:

Feature	Description
Breakpoints	Variables and settings for the IBM Design Grid, including gutter and breakpoints. It also includes helpers for working with breakpoints
Unit conversion	Helpers for converting from px to rem or em.
Key heights	Helpers for working with key heights at different breakpoints
Mini unit	Helpers for working in multiples of the mini-unit
Spacing	Provides a spacing scale and helper for using steps in the scale

One important thing to remember is that @carbon/layout is not responsible for the grid itself. If you are looking for a grid implementation to use, definitely check out the @carbon/grid package.

@carbon/layout provides the above features in both Sass and JavaScript. If you're looking for support in a different language, feel free to file an issue proposing the new addition!

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

Licensed under the Apache 2.0 License.

IBM Telemetry

This package uses IBM Telemetry to collect metrics data. By installing this package as a dependency you are agreeing to telemetry collection. To opt out, see Opting out of IBM Telemetry data collection. For more information on the data being collected, please see the IBM Telemetry documentation.