1 parent fbcb074 commit 3efc141Copy full SHA for 3efc141
1 file changed
lib/README.md
@@ -8,10 +8,31 @@ Renders a react knob component that can be widely customised.
8
9
```
10
npm install @vallsv/rc-knob
11
+pnpm install @vallsv/rc-knob
12
yarn add @vallsv/rc-knob
13
14
-## Examples
15
+## Basic example
16
+
17
+```
18
+import { Knob, Pointer, Arc } from '@vallsv/rc-knob';
19
20
+export default function Example() {
21
+ return <Knob
22
+ size={100}
23
+ angleOffset={225}
24
+ angleRange={270}
25
+ value={33}
26
+ min={0}
27
+ max={100}
28
+ >
29
+ <Arc arcWidth={5} color="#FC5A96" background="#CCCCCC" />
30
+ <Pointer width={5} height={40} radius={10} type="rect" color="#FC5A96" />
31
+ </Knob>
32
+}
33
34
35
+## Documentation and examples
36
37
- https://vallsv.github.io/rc-knob/
38
- https://eskimoblood.github.io/rc-knob/ (older version)
0 commit comments