Skip to content

Commit

Permalink
docs: update Thumbnails plugin docs
Browse files Browse the repository at this point in the history
  • Loading branch information
igordanchenko committed May 22, 2024
1 parent 524f818 commit 16d9b64
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/plugins/thumbnails.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Thumbnails Plugin

Thumbnails plugin adds thumbnails track to the lightbox.
Thumbnails plugin adds a thumbnail preview to the lightbox. Image and video
slides are supported out of the box. You can specify a thumbnail image for
custom slide types or override the default thumbnail by adding a `thumbnail`
slide prop to your slides.

The plugin comes with an additional CSS stylesheet.

Expand All @@ -10,7 +13,7 @@ import "yet-another-react-lightbox/plugins/thumbnails.css";

## Documentation

Thumbnails plugin adds the following `Lightbox` properties.
Thumbnails plugin adds the following `Lightbox` properties:

<table class="docs">
<tbody>
Expand Down Expand Up @@ -71,10 +74,21 @@ Thumbnails plugin adds the following `Lightbox` properties.
</tbody>
</table>

and the following `Slide` properties:

<table class="docs">
<tbody>
<tr>
<td>thumbnail</td>
<td>string</td>
<td>Thumbnail image.</td>
</tr>
</tbody>
</table>

## Thumbnails Ref

The Thumbnails plugin provides a ref object to control the plugin features
externally.
The plugin provides a ref object to control its features externally.

```jsx
// Thumbnails ref usage example
Expand Down

0 comments on commit 16d9b64

Please sign in to comment.