You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CODE_OF_CONDUCT.md
+36-17Lines changed: 36 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,45 +2,64 @@
2
2
3
3
## Our Pledge
4
4
5
-
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
5
+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers
6
+
pledge to making participation in our project and our community a harassment-free experience for
7
+
everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level
8
+
of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
9
7
10
## Our Standards
8
11
9
12
Examples of behavior that contributes to creating a positive environment include:
10
13
11
-
* Using welcoming and inclusive language
12
-
* Being respectful of differing viewpoints and experiences
13
-
* Gracefully accepting constructive criticism
14
-
* Focusing on what is best for the community
15
-
* Showing empathy towards other community members
14
+
- Using welcoming and inclusive language
15
+
- Being respectful of differing viewpoints and experiences
16
+
- Gracefully accepting constructive criticism
17
+
- Focusing on what is best for the community
18
+
- Showing empathy towards other community members
16
19
17
20
Examples of unacceptable behavior by participants include:
18
21
19
-
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20
-
* Trolling, insulting/derogatory comments, and personal or political attacks
21
-
* Public or private harassment
22
-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23
-
* Other conduct which could reasonably be considered inappropriate in a professional setting
22
+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23
+
- Trolling, insulting/derogatory comments, and personal or political attacks
24
+
- Public or private harassment
25
+
- Publishing others' private information, such as a physical or electronic address, without explicit
26
+
permission
27
+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24
28
25
29
## Our Responsibilities
26
30
27
-
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
31
+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are
32
+
expected to take appropriate and fair corrective action in response to any instances of unacceptable
33
+
behavior.
28
34
29
-
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
35
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits,
36
+
code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or
37
+
to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate,
38
+
threatening, offensive, or harmful.
30
39
31
40
## Scope
32
41
33
-
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
42
+
This Code of Conduct applies both within project spaces and in public spaces when an individual is
43
+
representing the project or its community. Examples of representing a project or community include
44
+
using an official project e-mail address, posting via an official social media account, or acting as
45
+
an appointed representative at an online or offline event. Representation of a project may be
46
+
further defined and clarified by project maintainers.
34
47
35
48
## Enforcement
36
49
37
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
50
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
51
+
the project team at [email protected]. The project team will review and investigate all complaints, and
52
+
will respond in a way that it deems appropriate to the circumstances. The project team is obligated
53
+
to maintain confidentiality with regard to the reporter of an incident. Further details of specific
54
+
enforcement policies may be posted separately.
38
55
39
-
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
56
+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face
57
+
temporary or permanent repercussions as determined by other members of the project's leadership.
40
58
41
59
## Attribution
42
60
43
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
61
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
Copy file name to clipboardExpand all lines: README.md
+95-47Lines changed: 95 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,8 @@
27
27
28
28
### vx
29
29
30
-
vx is a collection of reusable low-level visualization components. vx combines the power of d3 to generate your visualization with the benefits of react for updating the DOM.
30
+
vx is a collection of reusable low-level visualization components. vx combines the power of d3 to
31
+
generate your visualization with the benefits of react for updating the DOM.
31
32
32
33
<br />
33
34
@@ -57,14 +58,12 @@ vx is a collection of reusable low-level visualization components. vx combines t
57
58
</strong>
58
59
</p>
59
60
60
-
61
61
<palign="center">
62
62
<ahref="https://vx-demo.now.sh/gallery">
63
63
<img src="./assets/vx-gallery.png" />
64
64
</a>
65
65
</p>
66
66
67
-
68
67
## Usage
69
68
70
69
[](https://glitch.com/edit/#!/remix/kind-modem)
@@ -114,9 +113,15 @@ const yScale = scaleLinear({
114
113
});
115
114
116
115
// Compose together the scale and accessor functions to get point functions
@@ -150,86 +155,124 @@ For more examples using `vx`, check out the [gallery](https://vx-demo.now.sh/gal
150
155
151
156
**Goal**
152
157
153
-
The goal is to create a library of components you can use to make both your own reusable chart library or your slick custom one-off chart. vx is largely unopinionated and is meant to be build on top of. Keep your bundle sizes down and use only the packages you need.
158
+
The goal is to create a library of components you can use to make both your own reusable chart
159
+
library or your slick custom one-off chart. vx is largely unopinionated and is meant to be build on
160
+
top of. Keep your bundle sizes down and use only the packages you need.
154
161
155
162
**How?**
156
163
157
-
Under the hood, vx is using d3 for the calculations and math. If you're creating your own awesome chart library on top of vx, it's easy to create a component api that hides d3 entirely. Meaning your team could create charts as easily as using reusable react components.
164
+
Under the hood, vx is using d3 for the calculations and math. If you're creating your own awesome
165
+
chart library on top of vx, it's easy to create a component api that hides d3 entirely. Meaning your
166
+
team could create charts as easily as using reusable react components.
158
167
159
168
**But why?**
160
169
161
-
Mixing two mental models for updating the DOM is never a good time. Copy and pasting d3 code into `componentDidMount()` is just that. This collection of components lets you easily build your own reusable visualization charts or library without having to learn d3. No more selections or `enter()`/`exit()`/`update()`.
170
+
Mixing two mental models for updating the DOM is never a good time. Copy and pasting d3 code into
171
+
`componentDidMount()` is just that. This collection of components lets you easily build your own
172
+
reusable visualization charts or library without having to learn d3. No more selections or
173
+
`enter()`/`exit()`/`update()`.
162
174
163
175
## Status
164
176
165
-
`Beta` We're still in pre v1. Need to add interactions. No breaking changes planned right now [read more](https://github.com/hshoff/vx/issues/156#issuecomment-331318108). Check out [the road to v1](https://github.com/hshoff/vx/projects/1).
177
+
`Beta` We're still in pre v1. Need to add interactions. No breaking changes planned right now
178
+
[read more](https://github.com/hshoff/vx/issues/156#issuecomment-331318108). Check out
179
+
[the road to v1](https://github.com/hshoff/vx/projects/1).
166
180
167
-
If you're a curious coder, feel free to install and play around with the packages. I recommend using `--save-exact` when you `npm install`.
181
+
If you're a curious coder, feel free to install and play around with the packages. I recommend using
182
+
`--save-exact` when you `npm install`.
168
183
169
184
## Roadmap
170
185
171
186
Lots coming soon, check out the [roadmap](./ROADMAP.md).
-[Flaque/data-structures](https://github.com/Flaque/data-structures) ([Interactive explanation of the trie data structure](https://trie.now.sh/))
177
-
-[dylanmoz/trello](https://github.com/DylanMoz/dylanmoz.github.io/blob/source/src/pages/trello/TrelloGraph.js) ([Demo](http://dylanmoz.github.io/trello/)) ([How to Make Beautiful Graphs With vx and React-Motion](https://devblog.classy.org/how-to-make-beautiful-graphs-with-vx-and-react-motion-6ffe7aecf6f3))
- Collapsible tree with [`react-move`](https://github.com/react-tools/react-move) by [@techniq](https://github.com/techniq) ([Demo](https://codesandbox.io/s/n3w687vmqj)) ([Radial demo](https://codesandbox.io/s/vmqwrkl395)) ([More info](https://github.com/hshoff/vx/issues/162#issuecomment-335029517))
180
-
- Bitcoin 30-day price by [@hshoff](https://github.com/hshoff) ([Demo](https://viewsource.now.sh/bitcoin)) ([Github](https://github.com/hshoff/viewsource#1-bitcoin-price-chart)) ([YouTube](https://www.youtube.com/watch?v=oeE2tuspdHg))
181
-
- Ethereum candlestick chart by [@hshoff](https://github.com/hshoff) ([Demo](https://viewsource.now.sh/ethereum)) ([Github](https://github.com/hshoff/viewsource#2-ethereum-candlestick-chart))
182
-
- Song data visualization through spotify by [@bother7](https://github.com/bother7) ([Demo](https://spotalyzer-frontend.herokuapp.com/demo) ([Github](https://github.com/bother7/spotalyzer_frontend))
([How to Make Beautiful Graphs With vx and React-Motion](https://devblog.classy.org/how-to-make-beautiful-graphs-with-vx-and-react-motion-6ffe7aecf6f3))
- Animation with [`react-spring`](https://github.com/drcmda/react-spring/) by [@drcmda](https://github.com/drcmda) ([Demo](https://codesandbox.io/embed/j3x61vjz5v))
216
+
- Animation with [`react-spring`](https://github.com/drcmda/react-spring/) by
- Have a project that's using vx? Open a pull request and we'll add it to the list.
194
226
195
227
## FAQ
196
228
197
229
1. What does `vx` stand for?
198
230
199
-
> vx stands for visualization components.
231
+
> vx stands for visualization components.
200
232
201
233
1. Do you plan on supporting animation/transitions?
202
-
> A common criticism of vx is it doesn't have animation baked in, but this was a concious choice. It's a powerful feature to not bake it in.
203
-
>
204
-
> Imagine your app already bundles `react-motion`, adding a hypothetical `@vx/animation` is bloat. Since vx is react, it already supports all react animation libs.
205
-
>
206
-
> Charting libraries are like style guides. Each org or app will eventually want full control over their own implementation.
207
-
>
208
-
> vx makes this easier for everyone. No need to reinvent the wheel each time.
209
-
>
210
-
> more info: https://github.com/hshoff/vx/issues/6
211
-
>
212
-
> examples:
213
-
> - Collapsible tree with [`react-move`](https://github.com/react-tools/react-move) by [@techniq](https://github.com/techniq) ([Demo](https://codesandbox.io/s/n3w687vmqj)) ([Radial demo](https://codesandbox.io/s/vmqwrkl395))
214
-
> - Animation with `react-spring` by [@drcmda](https://github.com/drcmda) ([Demo](https://codesandbox.io/embed/j3x61vjz5v))
234
+
235
+
> A common criticism of vx is it doesn't have animation baked in, but this was a concious choice.
236
+
> It's a powerful feature to not bake it in.
237
+
>
238
+
> Imagine your app already bundles `react-motion`, adding a hypothetical `@vx/animation` is
239
+
> bloat. Since vx is react, it already supports all react animation libs.
240
+
>
241
+
> Charting libraries are like style guides. Each org or app will eventually want full control
242
+
> over their own implementation.
243
+
>
244
+
> vx makes this easier for everyone. No need to reinvent the wheel each time.
245
+
>
246
+
> more info: https://github.com/hshoff/vx/issues/6
247
+
>
248
+
> examples:
249
+
>
250
+
> - Collapsible tree with [`react-move`](https://github.com/react-tools/react-move) by
1. Do I have to use every package to make a chart?
217
257
218
-
> nope! pick and choose the packages you need.
258
+
> nope! pick and choose the packages you need.
219
259
220
260
1. Can I use this to create my own library of charts for my team?
221
261
222
-
> Please do.
262
+
> Please do.
223
263
224
264
1. Does vx work with [preact](https://preactjs.com/)?
225
265
226
-
> yup! need to alias `react` + `react-dom` and use `preact-compat`. Here's a quick demo: https://vx-preact.now.sh/. [more info](https://preactjs.com/guide/switching-to-preact#how-to-alias-preact-compat)
266
+
> yup! need to alias `react` + `react-dom` and use `preact-compat`. Here's a quick demo:
[lerna](https://github.com/lerna/lerna/) is used to manage versions and dependencies between
234
277
packages in the umbrella vx repo.
235
278
@@ -249,8 +292,9 @@ vx/
249
292
...
250
293
```
251
294
252
-
For easiest development clone or fork vx, install the _root_ dependencies including lerna,
253
-
then have lerna install package dependencies and manage the symlinking between packages for you by using the [`lerna bootstrap`](https://github.com/lerna/lerna#bootstrap) command:
295
+
For easiest development clone or fork vx, install the _root_ dependencies including lerna, then have
296
+
lerna install package dependencies and manage the symlinking between packages for you by using the
./node_modules/.bin/lerna bootstrap # installs all package deps, sym-links within-vx deps
260
304
```
261
305
262
-
Upon modification of a given package you can run `npm run build` from that package's folder to re-build the package with your changes. You can use the local dev server within `packages/vx-demo` to view and iterate on your changes in the gallery. From the `packages/vx-demo` folder run `npm run dev` to start the next server which (if correctly sym-linked with lerna) will also watch for changes you make to other packages.
306
+
Upon modification of a given package you can run `npm run build` from that package's folder to
307
+
re-build the package with your changes. You can use the local dev server within `packages/vx-demo`
308
+
to view and iterate on your changes in the gallery. From the `packages/vx-demo` folder run
309
+
`npm run dev` to start the next server which (if correctly sym-linked with lerna) will also watch
0 commit comments