Skip to content

Commit a527025

Browse files
committed
feat: update documentation for ResourceReaction and add ResourceBookmark component
1 parent fb45a9f commit a527025

File tree

2 files changed

+424
-4
lines changed

2 files changed

+424
-4
lines changed

docs/components/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Custom components are reusable UI elements that encapsulate specific functionali
1818
- **[ImageDropzoneWithCropper](./ImageDropzoneWithCropper.md)** - File upload with cropping capabilities
1919

2020
### Interactive Components
21-
- **[ResourceReaction](./ResourceReaction.md)** - Emoji reaction system for articles and comments
21+
- **[ResourceReaction](./ResourceReaction.md)** - Emoji reaction system for articles and comments (UI implementation of ResourceReactionable)
22+
- **[ResourceBookmark](./ResourceBookmark.md)** - Bookmark button for articles and comments (UI implementation of ResourceBookmarkable)
2223

2324
### Render Props Components
2425
- **[ResourceReactionable](./ResourceReactionable.md)** - Render prop for reaction functionality with optimistic updates
@@ -60,8 +61,8 @@ Components handling images and file uploads:
6061

6162
### Interactive Components
6263
Components providing user interactions:
63-
- ResourceReaction for emoji reactions
64-
- ResourceBookmark for saving content
64+
- ResourceReaction for emoji reactions (UI implementation of ResourceReactionable)
65+
- ResourceBookmark for saving content (UI implementation of ResourceBookmarkable)
6566
- Comment system components
6667

6768
### Render Props Components
@@ -86,7 +87,8 @@ Helper components for specific functions:
8687
| `AppImage` | Optimized images | Cloudinary integration, lazy loading |
8788
| `ImageDropzoneWithCropper` | File uploads | Drag-and-drop, cropping, cloud storage |
8889
| `UserInformationCard` | User profiles | Bio, social info, follow/edit actions |
89-
| `ResourceReaction` | Emoji reactions | Multiple reaction types, real-time updates |
90+
| `ResourceReaction` | Emoji reactions UI | Pre-built UI using ResourceReactionable |
91+
| `ResourceBookmark` | Bookmark button UI | Pre-built UI using ResourceBookmarkable |
9092
| `ResourceReactionable` | Reaction logic | Render props, optimistic updates, auth |
9193
| `ResourceBookmarkable` | Bookmark logic | Render props, state sync, optimistic UI |
9294

0 commit comments

Comments
 (0)