Containers

How they work

Containers are the most basic layout element in CoreUI for React.js and are required when using our default grid system. Containers are used to contain, pad, and (sometimes) center the content within them. While containers can be nested, most layouts do not require a nested container.

CoreUI for React.js comes with three different containers:

• <CContainer>, which sets a max-width at each responsive breakpoint
• <CContainer fluid>, which is width: 100% at all breakpoints
• <CContainer {sm|md|lg|xl}> and <CContainer {...{ '2xl': true }}>, which is width: 100% until the specified breakpoint

The table below illustrates how each container’s max-width compares to the original <CContainer> and <CContainer fluid> across each breakpoint.

Default container

Our default <CContainer> class is a responsive, fixed-width container, meaning its max-width changes at each breakpoint.

<CContainer>
  Content here
</CContainer>

Responsive containers

Responsive containers allow you to specify a class that is 100% wide until the specified breakpoint is reached, after which we apply max-widths for each of the higher breakpoints. For example, <CContainer sm> is 100% wide to start until the sm breakpoint is reached, where it will scale up with md, lg, xl, and 2xl.

<CContainer sm>100% wide until small breakpoint</CContainer>
<CContainer md>100% wide until medium breakpoint</CContainer>
<CContainer lg>100% wide until large breakpoint</CContainer>
<CContainer xl>100% wide until extra large breakpoint</CContainer>
<CContainer {...{ '2xl': true }}>100% wide until extra extra large breakpoint</CContainer>

Fluid containers

Use <CContainer fluid> for a full width container, spanning the entire width of the viewport.

<CContainer fluid>
  Content here
</CContainer>

Customizing

Sass maps

As shown above, CoreUI generates a series of predefined container classes to help you build the layouts you desire. You may customize these predefined container classes by modifying the Sass map (found in _config.scss) that powers them:

$container-max-widths: () !default;
// stylelint-disable-next-line scss/dollar-variable-default
$container-max-widths: defaults(
  (
    sm: 540px,
    md: 720px,
    lg: 960px,
    xl: 1200px,
    2xl: 1440px
  ),
  $container-max-widths
);

Sass mixins

In addition to customizing the Sass, you can also create your own containers with our Sass mixin. The mixin declares the container’s own --cui-gutter-* properties, so the padding follows a gutter override the same way the built-in containers do:

@mixin make-container($gutter: $container-padding-x) {
  --cui-gutter-x: #{$gutter};
  --cui-gutter-y: 0;
  width: 100%;
  padding-inline: calc(var(--cui-gutter-x) * .5);
  margin-inline: auto;
}

// Usage
.custom-container {
  @include make-container();
}

For more information and examples on how to modify our Sass maps and variables, please refer to the Sass section of the Grid documentation.

API

CContainer

import { CContainer } from '@coreui/react-pro'