@kiwicom/orbit-components
Version:
<div align="center"> <a href="https://orbit.kiwi" target="_blank"> <img alt="orbit-components" src="https://orbit.kiwi/wp-content/uploads/2018/08/orbit-components.png" srcset="https://orbit.kiwi/wp-content/uploads/2018/08/orbit-components@2x.png 2x"
97 lines (84 loc) • 3.86 kB
Markdown
# Card
To implement Card component into your project you'll need to the import at least the Card and the [CardContent](#cardcontent):
```jsx
import Card from "@kiwicom/orbit-components/lib/Card";
import CardContent from "@kiwicom/orbit-components/lib/Card/CardContent";
```
After adding import into your project you can use it simply like:
```jsx
<Card>
<CardContent>
Hello World!
</CardContent>
</Card>
```
## Props
Table below contains all types of the props available in ButtonLink component.
| Name | Type | Default | Description |
| :------------ | :---------------------| :-------------- | :------------------------------- |
| children | `React.Node` | | The content of the Card. [See Subcomponents](#sub-components)
| closable | `boolean` | `false` | If `true`, the Close icon will be displayed. [See Functional specs](#functional-specs)
| dataTest | `string` | | Optional prop for testing purposes.
| onClose | `func` | | Function for handling onClick event.
| spaceAfter | `enum` | | Additional `margin-bottom` after component. [See this docs](../common/getSpacingToken)
## Functional specs
* By passing the `closable` prop into Card, you will be able to handle `onClose` function and Close icon will be displayed.
## Subcomponents
Card component offers a good flexibility and many variations in its usage. There are four subcomponents which you may use.
### CardHeader
```jsx
import Card from "@kiwicom/orbit-components/lib/Card";
import CardHeader from "@kiwicom/orbit-components/lib/Card/CardHeader";
```
#### Usage:
```jsx
<Card>
<CardHeader title="Hello World!" />
</Card>
```
#### Props
Table below contains all types of the props in CardHeader component.
| Name | Type | Default | Description |
| :------------ | :---------------------| :-------------- | :------------------------------- |
| dataTest | `string` | | Optional prop for testing purposes.
| icon | `React.Node` | | Displayed icon.
| **title** | `string ` | | The title of the CardHeader.
| subTitle | `string` | | The description of the CardHeader.
### CardContent
```jsx
import Card from "@kiwicom/orbit-components/lib/Card";
import CardContent from "@kiwicom/orbit-components/lib/Card/CardContent";
```
#### Usage:
```jsx
<Card>
<CardContent>
Hello World!
</CardContent>
</Card>
```
#### Props
Table below contains all types of the props in CardContent component.
| Name | Type | Default | Description |
| :------------ | :---------------------| :-------------- | :------------------------------- |
| **children** | `React.Node` | | The content of the CardContent.
| dataTest | `string` | | Optional prop for testing purposes.
### CardSection
```jsx
import Card from "@kiwicom/orbit-components/lib/Card";
import CardSection from "@kiwicom/orbit-components/lib/Card/CardSection";
```
#### Usage:
```jsx
<Card>
<CardSection>
Hello World!
</CardSection>
</Card>
```
#### Props
Table below contains all types of the props in CardContent component.
| Name | Type | Default | Description |
| :------------ | :---------------------| :-------------- | :------------------------------- |
| **children** | `React.Node` | | The content of the CardSection.
| dataTest | `string` | | Optional prop for testing purposes.