<commit_before>[ci-img]: https://img.shields.io/travis/ciena-frost/ember-frost-bunsen.svg "Travis CI Build Status"
[ci-url]: https://travis-ci.org/ciena-frost/ember-frost-bunsen
[cov-img]: https://img.shields.io/coveralls/ciena-frost/ember-frost-bunsen.svg "Coveralls Code Coverage"
[cov-url]: https://coveralls.io/github/ciena-frost/ember-frost-bunsen
[npm-img]: https://img.shields.io/npm/v/ember-frost-bunsen.svg "NPM Version"
[npm-url]: https://www.npmjs.com/package/ember-frost-bunsen

# ember-frost-bunsen <br /> [![Travis][ci-img]][ci-url] [![Coveralls][cov-img]][cov-url] [![NPM][npm-img]][npm-url]

 * [Installation](#installation)
 * [API](#api)
 * [Examples](#examples)
 * [Development](#development)

## Installation
```
ember install ember-frost-bunsen
```

## API

### frost-bunsen-detail

| Attribute | Type  | Required | Description |
| --------- | ----  | -------- | ----------- |
| `model` | `Ember.Object` or `object` | Yes | Value definition |
| `renderers` | `Ember.Object` or `object` | No | Custom renderer template helper mappings |
| `value` | `Ember.Object` or `object` | No | Data to render |
| `view` | `Ember.Object` or `object` | No | View definition |

### frost-bunsen-form

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `cancelLabel` | `string` | No | Text for cancel button |
| `inline` | `boolean` | No | Whether or not to render form inline |
| `model` | `Ember.Object` or `object` | Yes | Value definition |
| `onCancel` | `Function` | No | Callback for when form is cancelled |
| `onChange` | `Function` | No | Callback for when form values change |
| `onSubmit` | `Function` | No | Callback for when form is submitted |
| `onValidation` | `Function` | No | Callback for when form is validated |
| `renderers` | `Ember.Object` or `object` | No | Custom renderer template helper mappings |
| `submitLabel` | `string` | No | Text for submit button |
| `validators` | `Array<Function>` | No | List of custom validation functions |
| `value` | `Ember.Object` or `object` | No | Value to initialize form with |
| `view` | `Ember.Object` or `object` | No | View definition |

## Examples

 * [Invocation](#invocation)
 * [Minimal Example](#minimal-example)
 * [Nested Properties Example](#nested-properties-example)
 * [Data Types Example](#data-types-example)
 * [Custom Validation Example](#custom-validation-example)

### Invocation

#### Form View

```handlebars
{{
  frost-bunsen-form
  model=model
  view=view
}}
```
<commit_msg>Fix API in README<commit_after>[ci-img]: https://img.shields.io/travis/ciena-frost/ember-frost-bunsen.svg "Travis CI Build Status"
[ci-url]: https://travis-ci.org/ciena-frost/ember-frost-bunsen
[cov-img]: https://img.shields.io/coveralls/ciena-frost/ember-frost-bunsen.svg "Coveralls Code Coverage"
[cov-url]: https://coveralls.io/github/ciena-frost/ember-frost-bunsen
[npm-img]: https://img.shields.io/npm/v/ember-frost-bunsen.svg "NPM Version"
[npm-url]: https://www.npmjs.com/package/ember-frost-bunsen

# ember-frost-bunsen <br /> [![Travis][ci-img]][ci-url] [![Coveralls][cov-img]][cov-url] [![NPM][npm-img]][npm-url]

 * [Installation](#installation)
 * [API](#api)
 * [Examples](#examples)
 * [Development](#development)

## Installation
```
ember install ember-frost-bunsen
```

## API

### frost-bunsen-detail

| Attribute | Type  | Required | Description |
| --------- | ----  | -------- | ----------- |
| `model` | `Ember.Object` or `object` | Yes | Value definition |
| `renderers` | `Ember.Object` or `object` | No | Custom renderer template helper mappings |
| `value` | `Ember.Object` or `object` | No | Data to render |
| `view` | `Ember.Object` or `object` | No | View definition |

### frost-bunsen-form

| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `cancelLabel` | `string` | No | Text for cancel button |
| `inline` | `boolean` | No | Whether or not to render form inline |
| `model` | `Ember.Object` or `object` | Yes | Value definition |
| `onCancel` | `Function` | No | Callback for when form is cancelled |
| `onChange` | `Function` | No | Callback for when form values change |
| `onSubmit` | `Function` | No | Callback for when form is submitted |
| `onValidation` | `Function` | No | Callback for when form is validated |
| `renderers` | `Ember.Object` or `object` | No | Custom renderer template helper mappings |
| `showAllErrors` | `boolean` | No | Whether or not to show error messages before user interaction occurs |
| `submitLabel` | `string` | No | Text for submit button |
| `validators` | `Array<Function>` | No | List of custom validation functions |
| `value` | `Ember.Object` or `object` | No | Value to initialize form with |
| `view` | `Ember.Object` or `object` | No | View definition |

## Examples

 * [Invocation](#invocation)
 * [Minimal Example](#minimal-example)
 * [Nested Properties Example](#nested-properties-example)
 * [Data Types Example](#data-types-example)
 * [Custom Validation Example](#custom-validation-example)

### Invocation

#### Form View

```handlebars
{{
  frost-bunsen-form
  model=model
  view=view
}}
```

{'fraction_non_alphanumeric': 0.19467133411124077, 'fraction_numerical': 0.0, 'mean_word_length': 3.8381937911571025, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 12, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2508052', 'n_tokens_mistral': 1803, 'n_tokens_neox': 1720, 'n_words': 415}