Skip to content

Commit 094959e

Browse files
committed
docs: Add features section
1 parent 27653fb commit 094959e

File tree

1 file changed

+83
-3
lines changed

1 file changed

+83
-3
lines changed

README.md

Lines changed: 83 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ A simple, easy-to-use, and responsive playlist component with a lightbox for dis
44

55
![npm](https://img.shields.io/npm/v/@codesweetly/react-youtube-playlist) ![NPM](https://img.shields.io/npm/l/@codesweetly/react-youtube-playlist)
66

7+
## Features
8+
9+
- SEO friendly
10+
- Fullscreen support
11+
- Keyboard accessible
12+
- Mobile responsive
13+
- Lightbox with translucent background
14+
- Set column numbers dynamically or manually
15+
- Customizable styles
16+
717
## Live Demo and Tutorial
818

919
Available at: https://codesweetly.com/react-youtube-playlist
@@ -45,7 +55,7 @@ function App() {
4555
}
4656
```
4757

48-
## Required Props
58+
## Props
4959

5060
<table>
5161
<thead>
@@ -77,6 +87,76 @@ function App() {
7787

7888
**Note:** A playlist's ID is the list of characters after the **"list="** in the [URL](https://codesweetly.com/web-address-url)—for instance, `https://www.youtube.com/playlist?list=playlistID`.
7989

90+
</td>
91+
</tr>
92+
<tr>
93+
<td>
94+
95+
[`columnCount`](https://codesweetly.com/css-multi-column-layout-explained#what-is-a-css-column-count-property)
96+
97+
</td>
98+
<td>number or keyword (string)</td>
99+
<td><code>"auto"</code></td>
100+
<td>
101+
102+
(**Optional**) The number of columns.
103+
104+
</td>
105+
</tr>
106+
<tr>
107+
<td>
108+
109+
[`columnWidth`](https://codesweetly.com/css-multi-column-layout-explained#what-is-a-css-column-width-property)
110+
111+
</td>
112+
<td>number or keyword (string)</td>
113+
<td><code>230</code></td>
114+
<td>
115+
116+
(**Optional**) The minimum width of the gallery's columns.
117+
118+
</td>
119+
</tr>
120+
<tr>
121+
<td>
122+
123+
[`gapSize`](https://codesweetly.com/css-gap-property)
124+
125+
</td>
126+
<td>number</td>
127+
<td><code>24</code></td>
128+
<td>
129+
130+
(**Optional**) The gallery's gap size.
131+
132+
</td>
133+
</tr>
134+
<tr>
135+
<td>
136+
137+
`customStyles`
138+
139+
</td>
140+
<td>ImageGalleryStylesType</td>
141+
<td><code>{}</code></td>
142+
<td>
143+
144+
(**Optional**) Custom styles to override the following element's default styles:
145+
146+
- Loader container: `loaderContainer`
147+
- Gallery container: `galleryContainerStyle`
148+
- Gallery image button: `imageBtnStyle`
149+
- Gallery video container: `videoContainerStyle`
150+
- Gallery image element: `videoImageStyle`
151+
- Gallery video caption: `videoCaptionStyle`
152+
- Modal container: `modalContainerStyle`
153+
- Modal slide number: `modalSlideNumberStyle`
154+
- Modal toolbar: `modalToolbarStyle`
155+
- Modal toolbar button: `modalToolbarBtnStyle`
156+
- Modal slideshow section: `modalSlideShowSectionStyle`
157+
- Modal iframe element: `modalIFrameStyle`
158+
- Modal slide button: `modalSlideBtnStyle`
159+
80160
</td>
81161
</tr>
82162
</tbody>
@@ -103,8 +183,8 @@ The [`serverDependenciesToBundle`](https://remix.run/docs/en/1.19.0/file-convent
103183

104184
```diff
105185
+ "use client";
106-
import YouTubePlaylist from "@codesweetly/react-youtube-playlist";
107-
import ImageGallery from "react-image-grid-gallery";
186+
import { YouTubePlaylist } from "@codesweetly/react-youtube-playlist";
187+
import { ImageGallery } from "react-image-grid-gallery";
108188
```
109189

110190
The `"use client"` directive tells NextJS to consider all modules imported into the page as part of the Client Component module graph.

0 commit comments

Comments
 (0)