Pluma
About
MCP Server
Getting started
Contributing
Breaking Changes
Changelog
Content
Icons
Motion
Style Utilities
Test Helpers
Tokens
Overview
Status
Accordion
AccordionGroup
Box
Card
CenterBaseline
Divider
EmptyState
Flex
FormLayout
Grid
InlineStack
Panel
Scrollable
Stack
Code
DescriptionList
Emphasis
Heading
List
Paragraph
Strong
Text
TextLabel
Truncated
Avatar
CodeBlock
Coin
Icon
Image
LabelIcon
Breadcrumbs
Link
NavItem
Page
Pagination
PlainLink
SideNav
Tabs
TabNav
Button
ButtonGroup
CloseButton
DropdownMenu
PlainButton
ToggleButton
Checkbox
CheckboxGroup
ColorPicker
Combobox
DatePicker
Form
JsonField
NumberField
OptionCard
OptionCardGroup
Radio
RadioGroup
Search
SegmentedControl
Select
Slider
TextArea
TextField
Toggle
Badge
DataTable
Filters
FormattedDateTime
FormattedRelativeTime
KeyboardShortcut
Label
ProgressBar
ProgressCircle
StatusIndicator
Table
Tag
Banner
PageLoader
SkeletonShape
SkeletonText
Snackbar
Spinner
Blanket
ConfirmationModal
Drawer
Modal
Modal manager
Popover
Tooltip
VisuallyHidden
Anti-patterns
Combobox with Add New
Density
Inline Form Controls
Refinement levers
Search with DropdownMenu
States
Voice
Ember Floating UI
Ember prop spreading
ModalPrimitive
PlumaProvider
PopoverPrimitive
Portal
React Yield
fly-alert
fly-badge
fly-btn
fly-card
fly-close
fly-label
fly-panel
fly-progress
fly-range
fly-spinner
fly-tag
Forms
Lists
Tailwind
Componentsv2.170.1
Iconsv1.15.0
MCPv0.8.18
Tokensv0.34.1

Flex

Github
Storybook
Legacy component

A utility component for creating flex containers.

Importing

The component can be imported via:

import { Flex } from '@customerio/pluma-components/react';
<Flex gap="200">
  <Box backgroundColor="information" p="200" />
  <Box backgroundColor="information" p="200" />
  <Box backgroundColor="information" p="200" />
</Flex>

Usage

The PlumaFlex component is a wrapper around Box for making it easier to create flex containers.

Flex direction

The flex direction can be controlled with the direction prop:

<Flex gap="200" direction="column">
  <Box backgroundColor="information" p="200" />
  <Box backgroundColor="information" p="200" />
  <Box backgroundColor="information" p="200" />
</Flex>

Gap

The gap between items can be controlled with the gap prop, which accepts space token values. rowGap and columnGap are also available for more fine-grained control of the gaps.

<Flex gap="400">
  <Box backgroundColor="information" p="200" />
  <Box backgroundColor="information" p="200" />
  <Box backgroundColor="information" p="200" />
</Flex>

Alignment

Main and cross axis alignment can be controlled with justifyContent and alignItems. For example:

<Flex gap="200" style={{ height: '100px' }} alignItems="stretch">
  <Flex 
    alignItems="start" 
    gap="200" 
    backgroundColor="information-minimal"
  >
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
  </Flex>

  <Flex 
    alignItems="center" 
    gap="200" 
    backgroundColor="information-minimal"
  >
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
  </Flex>

  <Flex 
    alignItems="end" 
    gap="200" 
    backgroundColor="information-minimal"
  >
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
  </Flex>

  <Flex 
    alignItems="stretch" 
    gap="200" 
    backgroundColor="information-minimal"
  >
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
    <Box backgroundColor="information" p="200" />
  </Flex>
</Flex>

Wrap

The flex container can be set to wrap with the wrap prop. It accepts a boolean value, or a wrap or nowrap string;

<Flex gap="200" wrap={true}>
  {[...Array(10)].map((_, index) => (
    <Box backgroundColor="information" p="200" />
  ))}
</Flex>

API

PlumaFlex extends Box

direction  "column" | "row" | undefined

Default:row

The direction of the flex container. MDN Flex Direction

wrap  boolean | "nowrap" | "wrap" | undefined

Default:false

Whether flex items should wrap over multiple lines. MDN Flex Wrap

On this page

Importing
Flex direction
Gap
Alignment
Wrap
API