@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"
36 lines (30 loc) • 1.89 kB
Markdown
# List
To implement List component into your project you'll need to add the import:
```jsx
import List from "@kiwicom/orbit-components/lib/List";
import ListItem from "@kiwicom/orbit-components/lib/List/ListItem";
```
After adding import into your project you can use it simply like:
```jsx
<List>
<ListItem>Hello world!</ListItem>
</List>
```
## Props
Table below contains all types of the props available in List component.
| Name | Type | Default | Description |
| :------------ | :----------------- | :---------- | :------------------------------- |
| children | `Array<ListItem>` | | The content of the List.
| dataTest | `string` | | Optional prop for testing purposes.
| size | [`enum`](#enum) | `"normal"` | The size of the List.
| spaceAfter | `enum` | | Additional `margin-bottom` after component. [See this docs](../common/getSpacingToken)
| type | [`enum`](#enum) | `"primary"` | The color type of the List.
### ListItem Props
Table below contains all types of the props in ListItem component.
| Name | Type | Default | Description |
| :------------ | :---------------------| :-------------- | :------------------------------- |
| **children** | `React.Node` | | The content of the ListItem.
| dataTest | `string` | | Optional prop for testing purposes.
| icon | `React.Node` | `"CircleSmall"` | The displayed Icon or CarrierLogo component. [See Functional specs](#functional-specs)
#### Functional specs
* You can color your icon if you pass some value into `color` or `customColor` prop of the [Icon](./Icon). Be aware of using other components, because they are not styled by default.