@silverpoint/core 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @silverpoint/core
|
|
2
|
+
|
|
3
|
+
The framework-free engine of **silverpoint**: the geometry, scales, interaction and types behind
|
|
4
|
+
every chart. The charts themselves are rendered by the adapters, and this package holds no DOM
|
|
5
|
+
code and no framework code.
|
|
6
|
+
|
|
7
|
+
You rarely install it by hand, because every adapter depends on it:
|
|
8
|
+
|
|
9
|
+
| Framework | Install |
|
|
10
|
+
|---|---|
|
|
11
|
+
| React | `npm install @silverpoint/react @silverpoint/grounds @silverpoint/fonts` |
|
|
12
|
+
| Vue | `npm install @silverpoint/vue @silverpoint/grounds @silverpoint/fonts` |
|
|
13
|
+
| Angular | `npm install @silverpoint/angular @silverpoint/grounds @silverpoint/fonts` |
|
|
14
|
+
|
|
15
|
+
Install it directly when you need its types in your own code:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npm install @silverpoint/core
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import type { ActiveItem, ProviderConfig, SubstrateName } from '@silverpoint/core';
|
|
23
|
+
|
|
24
|
+
export const config: ProviderConfig = { ground: 'silverpoint', substrate: 'cream', mode: 'ink' };
|
|
25
|
+
export const substrates: SubstrateName[] = ['cream', 'green', 'blue', 'ochre'];
|
|
26
|
+
export const describe = (item: ActiveItem) => `${item.seriesKey} #${item.index}: ${item.value}`;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The geometry of the data is exact: the ground's hand-drawn inking only touches strokes that
|
|
30
|
+
carry no data, and it is deterministic for a given seed.
|
|
31
|
+
|
|
32
|
+
See [`@silverpoint/react`](https://www.npmjs.com/package/@silverpoint/react),
|
|
33
|
+
[`@silverpoint/vue`](https://www.npmjs.com/package/@silverpoint/vue) and
|
|
34
|
+
[`@silverpoint/angular`](https://www.npmjs.com/package/@silverpoint/angular) for usage, and the
|
|
35
|
+
[repository](https://github.com/ecrespo/silverpoint) for the specifications.
|
|
36
|
+
|
|
37
|
+
MIT.
|