From a849fe1597079d8d56b8c58772f4ca91b9602f9d Mon Sep 17 00:00:00 2001 From: Jon Q Date: Wed, 19 Dec 2018 12:53:14 -0500 Subject: [PATCH] Add docs for beaconIds [skip ci] --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 52e2c93..0b712a8 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ - [In Browser](#in-browser) - [Demo](#demo) - [Props](#props) + - [beaconIds example](#beaconids-example) - [Check out Beacon](#check-out-beacon) @@ -82,9 +83,24 @@ Check out the demo on [Netlify](https://beacon-devtools.netlify.com/)! ``` -| 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` | `[]` | 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' }, +] + +// ... + + +``` ## Check out Beacon