chore: aligning readmes for react native components #787
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…entation Co-authored-by: george.marshall <[email protected]>
📖 Storybook Preview |
📖 Storybook Preview |
📖 Storybook Preview |
📖 Storybook Preview |
📖 Storybook Preview |
Comment on lines
37
to
69
| ### `shape` | ||
|
|
||
| Optional prop to control the shape of the `AvatarBase`. | ||
|
|
||
| | TYPE | REQUIRED | DEFAULT | | ||
| | :---------------- | :------- | :----------------------- | | ||
| | `AvatarBaseShape` | No | `AvatarBaseShape.Circle` | | ||
|
|
||
| Available shapes: | ||
|
|
||
| - `AvatarBaseShape.Circle` | ||
| - `AvatarBaseShape.Square` | ||
|
|
||
| --- | ||
|
|
||
| ### `fallbackText` | ||
|
|
||
| Optional text to be displayed when the avatar content fails to render. | ||
|
|
||
| | TYPE | REQUIRED | DEFAULT | | ||
| | :------- | :------- | :------ | | ||
| | `string` | No | `null` | | ||
|
|
||
| --- | ||
|
|
||
| ### `fallbackTextProps` | ||
|
|
||
| Optional props to customize the fallback text. | ||
|
|
||
| | TYPE | REQUIRED | DEFAULT | | ||
| | :---------------------------- | :------- | :------ | | ||
| | `Omit<TextProps, 'children'>` | No | `{}` | | ||
|
|
There was a problem hiding this comment.
Add these back to AvatarBase
📖 Storybook Preview |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR standardizes all React Native component README files in `packages/design-system-react-native/src/components/` to follow the standardized template structure defined in `docs/component-readme-examples/react-native-readme-example.md`.
What is the reason for the change?
What is the improvement/solution?
Related issues
Fixes: Background agent task to align React Native Component READMEs with template
Manual testing steps
Screenshots/Recordings
Before
After
Pre-merge author checklist
Pre-merge reviewer checklist