Skip to content

Commit

Permalink
docs: Delete uniqueName prop
Browse files Browse the repository at this point in the history
  • Loading branch information
oluwatobiss committed Jul 16, 2024
1 parent 370c88d commit e8570f4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 25 deletions.
29 changes: 5 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# React YouTube Playlist

An easy-to-use and responsive React component for displaying YouTube playlists on a web app. Create a beautiful gallery of YouTube videos.
A simple, easy-to-use, and responsive playlist component with a lightbox for displaying a beautiful gallery of YouTube videos in React apps.

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

Expand Down Expand Up @@ -40,7 +40,6 @@ function App() {
<YouTubePlaylist
apiKey="YOUR_YOUTUBE_API_KEY"
playlistId="YOUR_YOUTUBE_PLAYLIST_ID"
uniqueName="THIS_PLAYLIST_INSTANCE_NAME"
/>
);
}
Expand Down Expand Up @@ -78,21 +77,6 @@ function App() {

**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`.

</td>
</tr>
<tr>
<td><code>uniqueName</code></td>
<td>string</td>
<td><code>undefined</code></td>
<td>

**(Required)** A unique name for the `<YouTubePlaylist>` instance.

**Note:**

- No two `<YouTubePlaylist>` on a single page must have the same name.
- Use the [HTML `id` attribute's naming convention](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id) for the `uniqueName` props.

</td>
</tr>
</tbody>
Expand Down Expand Up @@ -133,13 +117,10 @@ The `YouTubePlaylist` package works _only_ as a Client Component because it uses
npm run build
```

## Dependencies

- [fslightbox-react](https://github.com/banthagroup/fslightbox-react)
- [prop-types](https://github.com/facebook/prop-types)
- [react](https://github.com/facebook/react)
- [react-loader-spinner](https://github.com/mhnpd/react-loader-spinner)

## Demo

https://codesweetly.com/react-youtube-playlist

## Support

🍵 [Buy me a coffee](https://www.buymeacoffee.com/codesweetly)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@
"typescript": "^5.5.3"
},
"peerDependencies": {
"react": "^18.2.0"
"react": "^18.3.1"
}
}

0 comments on commit e8570f4

Please sign in to comment.