Skip to content

Commit 482c418

Browse files
Karthik-B-06kodiakhq[bot]
authored andcommitted
docs(circular-progress): 📝 update circular-progress.md file
1 parent 7859dcc commit 482c418

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

docs/circular-progress.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
AdaptUI provides a component Circular Progress which is used to indicate the
44
progress for determinate and indeterminate processes.
55

6-
There are two types of progress indicators: determinate and indeterminate.
6+
There are two types of progress indicators: `determinate` and `indeterminate`.
77

88
- Determinate progress: fills the circular track with color, as the indicator
99
moves from 0 to 360 degrees.
@@ -40,6 +40,7 @@ export const CircularProgressScreen = () => {
4040

4141
- [Themes](#themes)
4242
- [Size](#size)
43+
- [Customised](#customised)
4344
- [Props](#props)
4445

4546
## Themes
@@ -98,6 +99,40 @@ export const CircularProgressScreen = () => {
9899
99100
```
100101

102+
## Customised
103+
104+
We can easily customise the sizing Circular Progress component with the style
105+
prop and setting a different color to the prop `progressTrackColor`
106+
107+
### Usage
108+
109+
```
110+
import React from "react";
111+
import {
112+
Box,
113+
CircularProgress,
114+
useTheme,
115+
} from "@adaptui/react-native-tailwind";
116+
117+
export const CircularProgressScreen = () => {
118+
const tailwind = useTheme();
119+
return (
120+
<Box
121+
style={tailwind.style(
122+
"flex-1 justify-center items-center px-2 bg-white-900",
123+
)}
124+
>
125+
<CircularProgress
126+
style={tailwind.style("w-48 h-48")}
127+
themeColor="primary"
128+
progressTrackColor={tailwind.getColor("text-green-600")}
129+
/>
130+
</Box>
131+
);
132+
};
133+
134+
```
135+
101136
## Props
102137

103138
> Circular Progress implements Box accepting all `ViewProps`
@@ -112,4 +147,4 @@ export const CircularProgressScreen = () => {
112147
| value | The `value` of the progress indicator, If `null` sets it to `indeterminate` state | number | null |
113148
| min | The minimum value of the progress | number | 0 |
114149
| max | The maximum value of the progress | number | 100 |
115-
| hint | Should the Circular Progress show hint, the hint is displayed inside the circle | boolean | false |
150+
| hint | The hint positioned inside the circle | string | |

0 commit comments

Comments
 (0)