Container#

Import#

import { Container } from 'bumbag';

Usage#

A container's max width is fixed, and varies per viewport breakpoint.

A container's max width is defined for viewport widths of tablet (768px) and above. For widths below tablet (768px), a left and right margin is applied.

<Container>
  <Box backgroundColor="whitesmoke" padding="0.5rem">
    Hello world!
  </Box>
</Container>

Fixed width#

A container's max width can be fixed after a certain breakpoint, meaning until that breakpoint has been reached, the width will be 100%.

<Container breakpoint="desktop">
  <Box backgroundColor="whitesmoke" padding="0.5rem">
    Hello world!
  </Box>
</Container>

<Container breakpoint="mobile" marginTop="major-2">
  <Box backgroundColor="whitesmoke" padding="0.5rem">
    Hello world!
  </Box>
</Container>

Alignment#

By default, a container is aligned to the center, however its alignment can be left or right aligned with the align prop.

<Container align="left" breakpoint="mobile">
  <Box backgroundColor="whitesmoke" padding="0.5rem">
    Hello world!
  </Box>
</Container>

<Container align="right" breakpoint="mobile" marginTop="major-2">
  <Box backgroundColor="whitesmoke" padding="0.5rem">
    Hello world!
  </Box>
</Container>

Fluid containers#

A fluid container's width is always 100%, but has a fixed left and right margin of 2rem (2 * root font size 16px). For devices under the tablet (768px) viewport, the margin is 1rem.

<Container isFluid>
  <Box backgroundColor="whitesmoke" padding="major-2">
    Hello world!
  </Box>
</Container>

Container Props#

align "right" | "left" | "center"

Sets the alignment of the container.

breakpoint

(string & {})
  | "tablet"
  | "mobile"
  | "fullHD"
  | "widescreen"
  | "desktop"

Sets the breakpoint width of the container.

isFluid boolean

Indicates if the container is fluid.

isLayout boolean

Indicates if the container is of a layout type.

string
  | (ComponentClass<any, any> & { useProps: any; })
  | (FunctionComponent<any> & { useProps: any; })

string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)

{
  useCSSVariables?: boolean;
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  ... 95 more ...;
  Template?: TemplateThemeConfig;
}

Theming#

import { ThemeProvider } from 'bumbag';
const theme = {
  Container: {
    styles: {
      base: {
        background: "#ffe3a4"
      }
    }
  }
}
<ThemeProvider theme={theme}>...</ThemeProvider>

import { ThemeProvider } from 'bumbag';
const theme = {
  Container: {
    styles: {
      fluid: {
        background: "#ffe3a4"
      }
    }
  }
}
<ThemeProvider theme={theme}>...</ThemeProvider>

import { ThemeProvider } from 'bumbag';
const theme = {
  Container: {
    styles: {
      layout: {
        background: "#ffe3a4"
      }
    }
  }
}
<ThemeProvider theme={theme}>...</ThemeProvider>