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
Nidhi Kumari 7424e98416
Updated all instances of "Component API" to "Props" in storybook documentation (#15324)
* replaced Component API with Props

* replaced Component API with Props in DOCUMENTATION.stories.mdx

* removed base avatar component
2022-07-27 00:22:40 +05:30
..
card.js Dark mode: colors obj UI, GREY, WHITE (#14118) 2022-03-22 12:44:01 -07:00
card.stories.js Dark mode: colors obj UI, GREY, WHITE (#14118) 2022-03-22 12:44:01 -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 Updated all instances of "Component API" to "Props" in storybook documentation (#15324) 2022-07-27 00:22:40 +05:30

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="ui-components-ui-card-card-stories-js--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 { COLORS } from '../../../helpers/constants/design-system';

// To remove the border
<Card border={false} />
// All border related props of the Box component will work

// To remove or change padding
<Card padding={0} />
// All padding related props of the Box component will work

// To change the background color
<Card backgroundColor={COLORS.BACKGROUND_ALTERNATIVE} />
```