@amityco/react-native-social-uikit 4.0.0-130c66f.0 → 4.0.0-8373e87.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -196,20 +196,20 @@ You can import and use the following screens individually in your application:
|
|
|
196
196
|
- [AmityStoryTabComponent](#)
|
|
197
197
|
- [AmityExploreComponent](#)
|
|
198
198
|
|
|
199
|
-
> ✅ Make sure your screen component is wrapped with **`AmityPageRenderer`** at the root level.
|
|
199
|
+
> ✅ Make sure your screen component is wrapped with **`AmityPageRenderer`** at the root level.
|
|
200
200
|
>
|
|
201
201
|
> ✅ `AmityPageRenderer` is **only required for screen components**. It is **not needed** when using `AmityUiKitSocial`.
|
|
202
202
|
|
|
203
203
|
### 📝 Component Props
|
|
204
204
|
|
|
205
|
-
| Component
|
|
206
|
-
|
|
207
|
-
| `CommunityHome`
|
|
208
|
-
| `PostDetail` | `defaultPostId: string`
|
|
209
|
-
| `AmityExploreComponent`
|
|
210
|
-
| `UserProfile` | `defaultUserId: string` ,
|
|
211
|
-
| `AmityGlobalFeedComponent` | `isShowStoryTab: boolean`
|
|
212
|
-
| `AmityStoryTabComponent` | `type: AmityStoryTabComponentEnum
|
|
205
|
+
| Component | Required Props | Notes |
|
|
206
|
+
|----------------------------|-------------------------|-------------------------------|
|
|
207
|
+
| `CommunityHome` | `defaultCommunityId: string` | Community to display |
|
|
208
|
+
| `PostDetail` | `defaultPostId: string` | Post Detail page to display |
|
|
209
|
+
| `AmityExploreComponent` | - | Explore page to display |
|
|
210
|
+
| `UserProfile` | `defaultUserId: string` , `isShowBackButton?: boolean` | User profile to display |
|
|
211
|
+
| `AmityGlobalFeedComponent` | `isShowStoryTab: boolean` | default value of `isShowStoryTab` is `true`|
|
|
212
|
+
| `AmityStoryTabComponent` | `type: AmityStoryTabComponentEnum`| This component should be wrapped with ` <AmityGlobalStoryTabWrapper>` The `targetId` is required only when the type is set to `AmityStoryTabComponentEnum.communityFeed`. For the global story tab component, use the type set to `AmityStoryTabComponentEnum.globalFeed` |
|
|
213
213
|
|
|
214
214
|
### Component Usage
|
|
215
215
|
|
|
@@ -242,7 +242,6 @@ export default function App() {
|
|
|
242
242
|
);
|
|
243
243
|
}
|
|
244
244
|
```
|
|
245
|
-
|
|
246
245
|
### Story Tab component Usage
|
|
247
246
|
|
|
248
247
|
```js
|
|
@@ -252,7 +251,7 @@ import {
|
|
|
252
251
|
AmityStoryTabComponent,
|
|
253
252
|
AmityStoryTabComponentEnum,
|
|
254
253
|
AmityStoryTabComponentStyle,
|
|
255
|
-
AmityGlobalStoryTabWrapper
|
|
254
|
+
AmityGlobalStoryTabWrapper
|
|
256
255
|
} from 'amity-react-native-social-ui-kit';
|
|
257
256
|
|
|
258
257
|
export default function App() {
|
|
@@ -266,9 +265,7 @@ export default function App() {
|
|
|
266
265
|
>
|
|
267
266
|
<AmityGlobalStoryTabWrapper>
|
|
268
267
|
<AmityPageRenderer>
|
|
269
|
-
<AmityStoryTabComponent
|
|
270
|
-
type={AmityStoryTabComponentEnum.globalFeed}
|
|
271
|
-
/>
|
|
268
|
+
<AmityStoryTabComponent type={AmityStoryTabComponentEnum.globalFeed} />
|
|
272
269
|
</AmityPageRenderer>
|
|
273
270
|
</AmityGlobalStoryTabWrapper>
|
|
274
271
|
</AmityUiKitProvider>
|
|
@@ -353,8 +350,11 @@ The Dark Mode feature in our UIKit enhances user experience by providing an alte
|
|
|
353
350
|
|
|
354
351
|
### Documentation
|
|
355
352
|
|
|
353
|
+
|
|
356
354
|
Please refer to our online documentation at https://docs.amity.co or contact a Ui-Kit representative at **clientsolutiomns@amity.co** for support.
|
|
357
355
|
|
|
356
|
+
|
|
357
|
+
|
|
358
358
|
## Migration Guide to React Navigation v7
|
|
359
359
|
|
|
360
360
|
1. Upgrade the following dependencies to the exact versions specified in the `package.json` of UIKit:
|