1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
metamask-extension/ui/components/ui/card
2023-05-23 13:57:07 -07:00
..
card.js Box types update (#18160) 2023-03-16 13:18:00 -07:00
card.stories.js TEXT_ALIGN to TextAlign in UI folder (#19235) 2023-05-23 13:57:07 -07:00
card.test.js Updating Card ui component and adding story (#12666) 2021-11-15 13:13:54 -05:00
index.js Updating Card ui component and adding story (#12666) 2021-11-15 13:13:54 -05:00
README.mdx Box types update (#18160) 2023-03-16 13:18:00 -07:00

import { Story, Canvas, ArgsTable } from '@storybook/addon-docs';

import Card from '.';

# Card

Cards are used to group related content or actions together.

<Canvas>
  <Story id="components-ui-card--default-story" />
</Canvas>

## Props

The `Card` component extends the `Box` component. See the `Box` component for an extended list of props.

<ArgsTable of={Card} />

## Usage

The following describes the props and example usage for this component.

### Padding, Border and Background Color

The Card component has a set of default props that should meet most card use cases. There is a strong recommendation to not overwrite these to ensure our cards stay consistent across the app.

That being said all props can be overwritten if necessary.

```jsx
import { BackgroundColor, BorderColor, BorderRadius, BorderStyle } from '../../../helpers/constants/design-system';

// To remove the border
<Card border={false} />
// All border related props of the Box component will work
<Card borderColor={BorderColor.primary} />
<Card borderRadius={BorderRadius.LG}>
<Card borderStyle={BorderStyle.dashed}>

// To remove or change padding
<Card padding={0} />
// All padding related props of the Box component will work
<Card paddingTop={4} paddingBottom={4} paddingLeft={8} paddingRight={8} />

// To change the background color
<Card backgroundColor={BackgroundColor.backgroundAlternative} />
```