Card
Card is a box of related content usually describing a single object. It can be composed of several subcomponents, we give full overview of those subcomponents below.
Card supports vertical and horizontal orientation which is controlled by CardContext, see examples below.
This component uses a Card from react-bootstrap as a base component and extends it with additional subcomponents.
See React-Bootstrap for additional documentation.
Basic Usage
Card variants
Use variant prop to use Card specific style variant.
Clickable card
You use isClickable prop to add additional hover and focus styling to the Card.
As link
You can also use Card as a link by wrapping it into appropriate component, note that Card will override default
link styling to make its content appear as a regular text.
Header
You may add a header by adding a Card.Header component.
This header displays a title, subtitle, and may contain actions.
Actions
The Card.Header supports custom actions via the actions prop and renders them on the top right of the header.
Sizes
The Card.Header supports two size variants, "sm" and "md".
Add size="sm" for smaller header content and actions.
Section
Card.Section is the main block to display card content. Can include its own title and actions separate from other card components. Multiple sections have a Card.Divider between them.
Footer
Card.Footer is the bottom part of the card. Usually used to outline actions that can be taken on the card object.
Note that Card.Footer has a separate orientation prop which will override the value from CardContext, this was implemented because there are some use cases where you would want to display Card with horizontal orientation containing footer with vertical orientation.
Vertical variant
Horizontal variant
With Image Cap
ImageCap is an image that sits on the top or the left edge of a Card. Can contain an optional logo image.
Horizontal variant
When using horizontal variant Paragon provides additional component Card.Body which acts as a wrapper for content you want to display between ImageCap and Footer. Use it if content contains multiple components.
Card status
Note that in the example below, the content of Card is wrapped inside Card.Body. The d-flex class is added for the horizontal orientation to achieve horizontal variant. The flex-column class is added for the main Card component.
Card Content Block Empty
With image
Without image
Horizontal variant with image
Horizontal variant without image
With Fallback Image
You can specify fallbackSrc image to show in case your main src fails to load.
A fallback source is available for both the main ImageCap component image and the logo.
With loading state
Vertical variant
Horizontal variant
CardGrid
This component displays a collection of Cards as a grid (with customizable responsive behavior), where all cards in a given row have equal height. Try shrinking the width of your browser to view the responsive behavior.
CardDeck
Displays child Card components in a horizontal row with equal height and width, with an appropriate gutter between cards. The width of each child Card component is determined by the (optional) columnSizes prop. If any child Card components overflow beyond the parent's width, they will be hidden but accessible via scrolling horizontally or keyboard navigation.
For accessibility, if the child Card components are interactive (e.g., isClickable), pass the hasInteractiveChildren prop so the CardDeck itself isn't focusable.
CardDeck.Deprecated
Gives any child Card components equal height with an appropriate gutter between cards. Each child Card component's width will be adjusted (e.g., become more narrow) to ensure all Card components fit within its parent's width.
Note: This component is a pass-thru from react-bootstrap.
CardCarousel
Extends CardDeck to support navigating between any overflow Card components via left and right IconButton components as a scrollable carousel.
Includes support for an optional title and subtitle. You may rely on the default styles for the titles (e.g., if passing strings) or alternatively you may also pass custom HTML and JSX.
Theme Variables (SCSS)#
$card-spacer-y: .75rem !default;$card-spacer-x: 1.25rem !default;$card-border-width: $border-width !default;$card-border-radius: $border-radius !default;$card-border-color: rgba($black, .125) !default;$card-border-focus-color: rgba($black, .5) !default;$card-border-focus-color-dark: theme-color("primary", "focus") !default;$card-inner-border-radius: subtract($card-border-radius, $card-border-width) !default;$card-cap-bg: rgba($black, .03) !default;$card-cap-color: null !default;$card-height: null !default;$card-color: null !default;$card-bg: $white !default;$card-bg-dark: $primary-500 !default;$card-bg-muted: $light-200 !default;$card-img-overlay-padding: 1.25rem !default;$card-group-margin: calc($grid-gutter-width / 2) !default;$card-deck-margin: $card-group-margin !default;$card-grid-margin: $card-group-margin !default;$card-deck-margin-bottom: map_get($spacers, 3) !default;$card-grid-margin-bottom: map_get($spacers, 3) !default;$card-columns-count: 3 !default;$card-columns-gap: 1.25rem !default;$card-columns-margin: $card-spacer-y !default;$card-divider-bg: $light-400 !default;$card-divider-margin-y: $card-spacer-y !default;$card-footer-actions-gap: .5rem !default;$card-logo-left-offset: 1.5rem !default;$card-logo-bottom-offset: 1rem !default;$card-logo-left-offset-horizontal: .4375rem !default;$card-logo-bottom-offset-horizontal: .4375rem !default;$card-logo-width: 7.25rem !default;$card-logo-height: 4.125rem !default;$card-image-border-radius: .3125rem !default;$card-logo-border-radius: .25rem !default;$card-footer-text-font-size: $x-small-font-size;$card-image-horizontal-max-width: 240px !default;$card-image-horizontal-min-width: $card-image-horizontal-max-width !default;$card-image-vertical-max-height: 140px !default;$loading-skeleton-spacer: .313rem !default;$card-focus-border-offset: 5px !default;$card-focus-border-width: 2px !default;$card-focus-border-radius: 5px !default;
- actions
nodeDefaultnullOptional node to render on the top right of the card header, i.e. ActionRow or a DropdownMenu.
- className
stringDefaultnullThe class name for the CardHeader component
- title
nodeDefaultnullThe title for the CardHeader component
- size
enum'sm' | 'md'Default'md'The size of the CardHeader component
- subtitle
nodeDefaultnullThe subtitle of the CardHeader component
- skeletonHeight
numberDefault20Specifies height of skeleton in loading state.
- skeletonWidth
numberDefaultnullSpecifies width of skeleton in loading state.
- className
stringThe class name for the CardGrid component
- children
nodeRequiredThe Card components to organize into a responsive grid
- columnSizes
shape{xs:number,sm:number,md:number,lg:number,xl:}number,Default{ sm: 12, lg: 6, xl: 4, }An object containing the desired column size at each breakpoint, following a similar props API as
react-bootstrap/Col
- className
stringSpecifies class name to append to the base element.
- children
nodeDefaultnullSpecifies contents of the component.
- title
nodeSpecifies title of the
Section. - actions
nodeSpecifies node to render on the bottom right of the
Section(i.e.ActionRow). - muted
boolDefaultfalseSpecifies whether to display
Sectionwith muted styling. - skeletonHeight
numberDefault100Specifies height of skeleton in loading state.
- skeletonWidth
numberSpecifies width of skeleton in loading state.
- className
stringSpecifies class name to append to the base element.
- children
nodeSpecifies the content of the component.
- className
stringThe class to append to the base element.
- className
stringSpecifies class name to append to the base element.
- src
stringSpecifies image src.
- fallbackSrc
stringSpecifies fallback image src.
- srcAlt
stringSpecifies image alt text.
- logoSrc
stringSpecifies logo src to put on top of the image.
- fallbackLogoSrc
stringSpecifies fallback image logo src.
- logoAlt
stringSpecifies logo image alt text.
- skeletonHeight
numberDefault140Specifies height of Image skeleton in loading state.
- skeletonWidth
numberSpecifies width of Image skeleton in loading state.
- logoSkeleton
boolDefaultfalseSpecifies whether the cap should be displayed during loading.
- logoSkeletonHeight
numberDefault41Specifies height of Logo skeleton in loading state.
- logoSkeletonWidth
numberSpecifies width of Logo skeleton in loading state.
- children
nodeRequiredSpecifies the content of the component.
- className
stringThe class to append to the base element.
- icon
funcIcon that will be shown in the top-left corner.
- variant
enum'primary' | 'success' | 'danger' | 'warning'Default'warning'Specifies variant to use.
- title
element|stringSpecifies title for the
Card.Status.