Skip to contentShopify logoPolaris

Bleed

Applies negative margin to allow content to bleed out into the surrounding layout.

Alpha

This component is a work in progress and ready for exploratory usage, with breaking changes expected in minor version updates. Please use with caution. Learn more about our component lifecycles.

Content will bleed horizontally into the surrounding layout using the marginInline prop.

import React from 'react';
import {Bleed, Box, Text, Inline} from '@shopify/polaris';


function BleedHorizontalExample() {
  return (
    <Box background="surface" border="base" padding="8">
      <Bleed marginInline="8">
        <Placeholder label="marginInline" />
      </Bleed>
    </Box>
  );
}

const Placeholder = ({label = '', height = 'auto', width = 'auto'}) => {
  return (
    <div
      style={{
        background: 'var(--p-color-text-info)',
        padding: '14px var(--p-space-2)',
        height: height,
        width: width,
      }}
    >
      <Inline gap="4" align="center">
        <div
          style={{
            color: 'var(--p-color-text-on-color)',
          }}
        >
          <Text as="h2" variant="bodyMd" fontWeight="regular">
            {label}
          </Text>
        </div>
      </Inline>
    </div>
  );
};

Props

Want to help make this feature better? Please share your feedback.

interface BleedProps
children?React.ReactNode
marginInline?T | { [Breakpoint in BreakpointsAlias]?: T; }<SpacingSpaceScale>

Negative horizontal space around children.

marginBlock?T | { [Breakpoint in BreakpointsAlias]?: T; }<SpacingSpaceScale>

Negative vertical space around children.

marginBlockStart?T | { [Breakpoint in BreakpointsAlias]?: T; }<SpacingSpaceScale>

Negative top space around children.

marginBlockEnd?T | { [Breakpoint in BreakpointsAlias]?: T; }<SpacingSpaceScale>

Negative bottom space around children.

marginInlineStart?T | { [Breakpoint in BreakpointsAlias]?: T; }<SpacingSpaceScale>

Negative left space around children.

marginInlineEnd?T | { [Breakpoint in BreakpointsAlias]?: T; }<SpacingSpaceScale>

Negative right space around children.

Bleed values

Content should never go beyond the edges of the parent container. Choose a bleed value that works within the containing layout.

  • Bleed props are named following the convention of CSS logical properties, such as 'margin-inline-start' and 'margin-block-start'. Learn more about CSS logicial properties.