@asphalt-react/crater/README.md

Crater

# Crater

![npm](https://img.shields.io/npm/dt/@asphalt-react/crater?style=flat-square)
[![npm version](https://badge.fury.io/js/@asphalt-react%2Fcrater.svg)](https://badge.fury.io/js/@asphalt-react%2Fcrater)

Crater is a container to wrap other components like form elements. Crater comes in three sizes `small`, `medium` & `large`.
You can remove the spacing inside Crater as well.

## Usage

```jsx
import { Crater } from "@asphalt-react/crater"

<Crater>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</Crater>
```

[comment]: # "Crater Props"

## Props

### children

React node to render inside the Crater.

| type | required | default |
| ---- | -------- | ------- |
| node | true     | N/A     |

### bezel

Adds padding on all sides.

| type | required | default |
| ---- | -------- | ------- |
| bool | false    | true    |

### size

Controls size of Crater. Possible values are "s", "m", "l" for small, medium & large respectively.

| type | required | default |
| ---- | -------- | ------- |
| enum | false    | "m"     |