Skip to content

Commit

Permalink
README.md html, not markdown for property table
Browse files Browse the repository at this point in the history
Try to get it rendering properly on npm
  • Loading branch information
jossmac committed Sep 10, 2015
1 parent 1965570 commit 5409a74
Showing 1 changed file with 53 additions and 11 deletions.
64 changes: 53 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,56 @@ Then open [`localhost:8000`](http://localhost:8000) in a browser.

## Options

Property | Type | Description
:-----------------------|:--------------|:--------------------------------
backdropClosesModal | bool | Allow users to exit the lightbox by clicking the backdrop
enableKeyboardInput | bool | Supports keyboard input - `esc`, `arrow left`, and `arrow right`
initialImage | number | The index of the first image to display
height | number | Maximum height of the carousel; defaults to 600px
images | array | An array of image `url`s
isOpen | bool | Whether or not the lightbox is displayed
onClose | func | Handle closing of the lightbox
showCloseButton | bool | Optionally display a close button under the carousel
width | number | Maximum width of the carousel; defaults to 900px
<table><thead>
<tr>
<th align="left">Property</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead><tbody>
<tr>
<td align="left">backdropClosesModal</td>
<td align="left">bool</td>
<td align="left">Allow users to exit the lightbox by clicking the backdrop</td>
</tr>
<tr>
<td align="left">enableKeyboardInput</td>
<td align="left">bool</td>
<td align="left">Supports keyboard input - <code>esc</code>, <code>arrow left</code>, and <code>arrow right</code></td>
</tr>
<tr>
<td align="left">initialImage</td>
<td align="left">number</td>
<td align="left">The index of the first image to display</td>
</tr>
<tr>
<td align="left">height</td>
<td align="left">number</td>
<td align="left">Maximum height of the carousel; defaults to 600px</td>
</tr>
<tr>
<td align="left">images</td>
<td align="left">array</td>
<td align="left">An array of image <code>url</code>s</td>
</tr>
<tr>
<td align="left">isOpen</td>
<td align="left">bool</td>
<td align="left">Whether or not the lightbox is displayed</td>
</tr>
<tr>
<td align="left">onClose</td>
<td align="left">func</td>
<td align="left">Handle closing of the lightbox</td>
</tr>
<tr>
<td align="left">showCloseButton</td>
<td align="left">bool</td>
<td align="left">Optionally display a close button under the carousel</td>
</tr>
<tr>
<td align="left">width</td>
<td align="left">number</td>
<td align="left">Maximum width of the carousel; defaults to 900px</td>
</tr>
</tbody></table>

0 comments on commit 5409a74

Please sign in to comment.