Skip to content

Commit 37cb63a

Browse files
committed
update docs
1 parent 914549a commit 37cb63a

18 files changed

Lines changed: 203 additions & 45 deletions

side/src/App.css

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +0,0 @@
1-
.App {
2-
text-align: center;
3-
}
4-
5-
.App-logo {
6-
animation: App-logo-spin infinite 20s linear;
7-
height: 40vmin;
8-
}
9-
10-
.App-header {
11-
background-color: #282c34;
12-
min-height: 100vh;
13-
display: flex;
14-
flex-direction: column;
15-
align-items: center;
16-
justify-content: center;
17-
font-size: calc(10px + 2vmin);
18-
color: white;
19-
}
20-
21-
.App-link {
22-
color: #61dafb;
23-
}
24-
25-
@keyframes App-logo-spin {
26-
from {
27-
transform: rotate(0deg);
28-
}
29-
to {
30-
transform: rotate(360deg);
31-
}
32-
}

side/src/App.js

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,13 @@ import ScaleScale from './examples/Scale_Scale'
1212
import PointerCustom from './examples/Pointer_custom'
1313
import ScaleCustom from './examples/Scale_custom'
1414
import ScaleStyled from './examples/Scale_styled'
15+
import ScaleStyled2 from './examples/Scale_styled_2'
1516
import ArcPointerStyled from './examples/Arc_Pointer_styled'
17+
import Filter from './filter'
1618

1719
export default () => (
1820
<div>
21+
<Filter />
1922
<H1>React Knob</H1>
2023
<H2>
2124
<span>Base Components</span>
@@ -52,14 +55,8 @@ export default () => (
5255
<span>Custom Elements</span>
5356
</H2>
5457
<Description>
55-
The <pre>Knob</pre> component and the <pre>Pointer</pre> and{' '}
56-
<pre>Scale</pre> components can also render custom components. All
57-
direct children of the <pre>Knob</pre> get the following props
58-
passed: <pre>percentage</pre> <pre>size</pre>, <pre>value</pre>,
59-
<pre>angleOffset</pre>,<pre>angleRange</pre>,{' '}
60-
<pre>radius: size / 2</pre>,<pre>center: size / 2</pre>,{' '}
61-
<pre>steps</pre>. The children of <pre>Pointer</pre> get{' '}
62-
<pre>width</pre>, <pre>height</pre>, <pre>percentage</pre> passed.
58+
The <pre>Pointer</pre> and <pre>Scale</pre> components can also
59+
render custom components.
6360
</Description>
6461
<Grid>
6562
<PointerCustom />
@@ -68,10 +65,17 @@ export default () => (
6865
<H2>
6966
<span>Styles</span>
7067
</H2>
71-
<Description />
68+
<Description>
69+
The components and the knob itself can be styled by addingthe{' '}
70+
<pre>className</pre> prop. The <pre>Scale</pre> can have an
71+
additional <pre>activeClassname</pre> prop to style the active tick
72+
differently. As all components are SVG you can also use filters in
73+
your styles.
74+
</Description>
7275
<Grid>
7376
<ArcPointerStyled />
7477
<ScaleStyled />
78+
<ScaleStyled2 />
7579
</Grid>
7680
</div>
7781
)

side/src/examples/Arc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const example = `
1010
angleRange={280}
1111
min={0}
1212
max={100}
13+
onChange={value => console.log(value)}
1314
>
1415
<Arc
1516
arcWidth={5}

side/src/examples/Arc_Pointer.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const example = `
1010
angleRange={280}
1111
min={0}
1212
max={100}
13+
onChange={value => console.log(value)}
1314
>
1415
<Arc
1516
arcWidth={5}

side/src/examples/Arc_Pointer_Value.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const example = `
1010
angleRange={280}
1111
min={0}
1212
max={100}
13+
onChange={value => console.log(value)}
1314
>
1415
<Arc
1516
arcWidth={5}

side/src/examples/Arc_Pointer_styled.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import React from 'react'
22
import Example from '../Example'
3-
import colors from '../colors'
43
import { Arc, Pointer } from 'rc-knob'
54

65
const example = `
@@ -10,6 +9,8 @@ const example = `
109
angleRange={280}
1110
min={0}
1211
max={100}
12+
className="styledKnob"
13+
onChange={value => console.log(value)}
1314
>
1415
<Arc
1516
arcWidth={1.5}

side/src/examples/Pointer.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ const example = `
1010
angleRange={280}
1111
min={0}
1212
max={100}
13+
onChange={value => console.log(value)}
1314
>
1415
<Pointer
1516
width={3}

side/src/examples/Pointer_custom.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@ import { Pointer, Arc } from 'rc-knob'
55

66
const example = `
77
const CustomPointer = ({ width, percentage }) => (
8-
<react r={width} fill={\`hsb(\${360 * percentage}, 50%, 50%)\`} />
8+
<rect
9+
r={width}
10+
fill={\`hsb(\${360 * percentage}, 50%, 50%)\`}
11+
/>
912
<Knob
1013
size={100}
1114
angleOffset={220}
1215
angleRange={280}
1316
min={0}
1417
max={100}
18+
onChange={value => console.log(value)}
1519
>
1620
<Pointer
1721
width={3}

side/src/examples/Scale.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const example = `
1111
steps={10}
1212
min={0}
1313
max={100}
14+
onChange={value => console.log(value)}
1415
>
1516
<Scale
1617
tickWidth={2}

side/src/examples/Scale_Pointer.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ const example = `
1111
steps={10}
1212
min={0}
1313
max={100}
14+
onChange={value => console.log(value)}
1415
>
1516
<Scale
1617
tickWidth={2}

0 commit comments

Comments
 (0)