Skip to content

Commit d1896de

Browse files
author
Greg B
authored
Update RNProgressBar.ts (#294)
ProgressBar example
1 parent f7b354d commit d1896de

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/components/ProgressBar/RNProgressBar.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@ import { ViewProps, setViewProps } from "../View/RNView";
88
import { RNWidget } from "../config";
99
import { throwUnsupported } from "../../utils/helpers";
1010

11+
/**
12+
* The ProgressBar component provides ability to add and manipulate native progress bar widgets. It is based on
13+
* [NodeGui's QProgressBar](https://docs.nodegui.org/docs/api/generated/classes/qprogressbar/).
14+
* ## Example
15+
* ```javascript
16+
* import React from "react";
17+
* import { Renderer, ProgressBar, Window } from "@nodegui/react-nodegui";
18+
* const App = () => {
19+
* return (
20+
* <Window>
21+
* <ProgressBar value={45} />
22+
* </Window>
23+
* );
24+
* };
25+
* Renderer.render(<App />);
26+
* ```
27+
*/
1128
export interface ProgressBarProps extends ViewProps<QProgressBarSignals> {
1229
value?: number;
1330
minimum?: number;

0 commit comments

Comments
 (0)