-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(exoflex): add docs for ActivityIndicator component (#74)
* add docs for ActivityIndicator component * add preview image * remove undefined from default props
- Loading branch information
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# ActivityIndicator | ||
|
||
Activity indicator is used to present progress of some activity in the app. | ||
|
||
### Preview | ||
|
||
![activity_indicator_preview](../assets/activity_indicator_preview.gif) | ||
|
||
### Props | ||
|
||
| Name | Type | Default | Description | | ||
| ------------------ | :----------------------------: | :-------: | -------------------------------------------------------------------- | | ||
| `animating` | `boolean` | `true` | Whether to show the indicator or hide it. | | ||
| `color` | `string` | | The color of the spinner. Will use the primary color from the theme. | | ||
| `size` | `'small' \| 'large' \| number` | `'small'` | Size of the indicator. | | ||
| `hidesWhenStopped` | `boolean` | `true` | Whether the indicator should hide when not animating. | | ||
| `style` | `StyleProp<ViewStyle>` | | Additional style for the container. | | ||
|
||
### Example | ||
|
||
```tsx | ||
<Provider> | ||
<ActivityIndicator /> | ||
|
||
<ActivityIndicator size="large" color="salmon" /> | ||
</Provider> | ||
``` |