Skip to content

Commit

Permalink
Add docs for beaconIds [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Jon Q committed Dec 19, 2018
1 parent 47ee532 commit a849fe1
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [In Browser](#in-browser)
- [Demo](#demo)
- [Props](#props)
- [beaconIds example](#beaconids-example)
- [Check out Beacon](#check-out-beacon)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -82,9 +83,24 @@ Check out the demo on [Netlify](https://beacon-devtools.netlify.com/)!
<BeaconDevTools />
```

| Prop | Type | Default | Description |
| ---------- | --------- | ------- | ----------------------------------- |
| isAutoOpen | `boolean` | `false` | Automatically opens Beacon on load. |
| Prop | Type | Default | Description |
| ---------- | --------------- | ------- | --------------------------------------------------- |
| isAutoOpen | `boolean` | `false` | Automatically opens Beacon on load. |
| beaconIds | `Array<Object>` | `[]` | A collection of Beacon IDs to load into a `select`. |

### beaconIds example

```jsx
const beaconIds = [
{ id: '...', label: 'My Test Beacon 1' },
{ id: '...', label: 'Production Beacon' },
{ id: '...', label: 'Marketing Beacon' },
]

// ...

<BeaconDevTools beaconIds={beaconId} />
```

## Check out Beacon

Expand Down

0 comments on commit a849fe1

Please sign in to comment.