@aeriz/chart 1.0.0 → 1.0.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 +20 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
A focused, fast canvas charting library. **21 chart types**, single rendering core, zero dependencies.
|
|
4
4
|
|
|
5
5
|
[](LICENSE)
|
|
6
|
-
[](https://www.npmjs.com/package/@aeriz/chart)
|
|
7
7
|
[](dist/aeriz.min.js)
|
|
8
8
|
|
|
9
9
|
---
|
|
@@ -26,20 +26,20 @@ A focused, fast canvas charting library. **21 chart types**, single rendering co
|
|
|
26
26
|
|
|
27
27
|
```html
|
|
28
28
|
<!-- ✓ Production — pin a specific version (immutable, longest cache) -->
|
|
29
|
-
<script src="https://cdn.jsdelivr.net/npm/
|
|
29
|
+
<script src="https://cdn.jsdelivr.net/npm/@aeriz/chart@1.0.0/dist/aeriz.min.js"></script>
|
|
30
30
|
|
|
31
31
|
<!-- Tracks the latest 1.x — auto-receives patches, never major bumps -->
|
|
32
|
-
<script src="https://cdn.jsdelivr.net/npm/
|
|
32
|
+
<script src="https://cdn.jsdelivr.net/npm/@aeriz/chart@^1.0.0/dist/aeriz.min.js"></script>
|
|
33
33
|
|
|
34
34
|
<!-- Always-newest — convenient for prototyping, NOT for production -->
|
|
35
|
-
<script src="https://cdn.jsdelivr.net/npm/
|
|
35
|
+
<script src="https://cdn.jsdelivr.net/npm/@aeriz/chart@latest/dist/aeriz.min.js"></script>
|
|
36
36
|
|
|
37
37
|
<!-- unpkg alternative (same files, different CDN) -->
|
|
38
|
-
<script src="https://unpkg.com/
|
|
38
|
+
<script src="https://unpkg.com/@aeriz/chart@1.0.0/dist/aeriz.min.js"></script>
|
|
39
39
|
|
|
40
40
|
<!-- ES Module — same versioning rules apply -->
|
|
41
41
|
<script type="module">
|
|
42
|
-
import { BarChart } from 'https://cdn.jsdelivr.net/npm/
|
|
42
|
+
import { BarChart } from 'https://cdn.jsdelivr.net/npm/@aeriz/chart@1.0.0/dist/aeriz.esm.min.js';
|
|
43
43
|
</script>
|
|
44
44
|
```
|
|
45
45
|
|
|
@@ -51,17 +51,17 @@ A focused, fast canvas charting library. **21 chart types**, single rendering co
|
|
|
51
51
|
### npm / yarn / pnpm
|
|
52
52
|
|
|
53
53
|
```bash
|
|
54
|
-
npm install aeriz
|
|
55
|
-
yarn add aeriz
|
|
56
|
-
pnpm add aeriz
|
|
54
|
+
npm install @aeriz/chart
|
|
55
|
+
yarn add @aeriz/chart
|
|
56
|
+
pnpm add @aeriz/chart
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
```js
|
|
60
|
-
import { BarChart, CompositeChart, math, PALETTE } from 'aeriz';
|
|
60
|
+
import { BarChart, CompositeChart, math, PALETTE } from '@aeriz/chart';
|
|
61
61
|
// or, in CommonJS:
|
|
62
|
-
const Aeriz = require('aeriz');
|
|
62
|
+
const Aeriz = require('@aeriz/chart');
|
|
63
63
|
// or, the minified build (smaller install footprint at runtime):
|
|
64
|
-
import * as Aeriz from 'aeriz/min';
|
|
64
|
+
import * as Aeriz from '@aeriz/chart/min';
|
|
65
65
|
```
|
|
66
66
|
|
|
67
67
|
---
|
|
@@ -70,7 +70,7 @@ import * as Aeriz from 'aeriz/min';
|
|
|
70
70
|
|
|
71
71
|
```html
|
|
72
72
|
<div id="chart" style="height:320px"></div>
|
|
73
|
-
<script src="https://cdn.jsdelivr.net/npm/
|
|
73
|
+
<script src="https://cdn.jsdelivr.net/npm/@aeriz/chart@1.0.0/dist/aeriz.min.js"></script>
|
|
74
74
|
<script>
|
|
75
75
|
const chart = new Aeriz.BarChart('#chart', {
|
|
76
76
|
data: [
|
|
@@ -246,7 +246,7 @@ are the ones the docs site demonstrates per chart type.
|
|
|
246
246
|
|
|
247
247
|
```jsx
|
|
248
248
|
import { useEffect, useRef } from 'react';
|
|
249
|
-
import * as Aeriz from 'aeriz';
|
|
249
|
+
import * as Aeriz from '@aeriz/chart';
|
|
250
250
|
|
|
251
251
|
export default function BarChartDemo() {
|
|
252
252
|
const ref = useRef(null);
|
|
@@ -267,7 +267,7 @@ export default function BarChartDemo() {
|
|
|
267
267
|
```vue
|
|
268
268
|
<script setup>
|
|
269
269
|
import { onMounted, onBeforeUnmount, ref } from 'vue';
|
|
270
|
-
import * as Aeriz from 'aeriz';
|
|
270
|
+
import * as Aeriz from '@aeriz/chart';
|
|
271
271
|
|
|
272
272
|
const el = ref(null);
|
|
273
273
|
let chart = null;
|
|
@@ -291,7 +291,7 @@ onBeforeUnmount(() => chart && chart.destroy());
|
|
|
291
291
|
```svelte
|
|
292
292
|
<script>
|
|
293
293
|
import { onMount } from 'svelte';
|
|
294
|
-
import * as Aeriz from 'aeriz';
|
|
294
|
+
import * as Aeriz from '@aeriz/chart';
|
|
295
295
|
|
|
296
296
|
let el;
|
|
297
297
|
onMount(() => {
|
|
@@ -345,7 +345,7 @@ Ext.create('Ext.Component', {
|
|
|
345
345
|
|
|
346
346
|
## TypeScript
|
|
347
347
|
|
|
348
|
-
Types ship in the package — no `@types/
|
|
348
|
+
Types ship in the package — no `@types/aeriz__chart` needed.
|
|
349
349
|
|
|
350
350
|
```ts
|
|
351
351
|
import {
|
|
@@ -355,7 +355,7 @@ import {
|
|
|
355
355
|
RealtimeChart,
|
|
356
356
|
math,
|
|
357
357
|
PALETTE,
|
|
358
|
-
} from 'aeriz';
|
|
358
|
+
} from '@aeriz/chart';
|
|
359
359
|
|
|
360
360
|
const bar = new BarChart('#x', {
|
|
361
361
|
data: [{ label: 'A', value: 5 }],
|
|
@@ -403,7 +403,7 @@ Accepted by every chart that has them:
|
|
|
403
403
|
### Math helpers
|
|
404
404
|
|
|
405
405
|
```js
|
|
406
|
-
import { math, PALETTE } from 'aeriz';
|
|
406
|
+
import { math, PALETTE } from '@aeriz/chart';
|
|
407
407
|
|
|
408
408
|
math.clamp(15, 0, 10); // 10
|
|
409
409
|
math.lerp(0, 1, 0.5); // 0.5
|
|
@@ -437,7 +437,7 @@ dist/
|
|
|
437
437
|
aeriz.min.js # IIFE minified (~58 KB) — CDN default
|
|
438
438
|
aeriz.esm.js # ES module
|
|
439
439
|
aeriz.esm.min.js # ES module minified
|
|
440
|
-
aeriz.cjs # CommonJS — for `require('aeriz')`
|
|
440
|
+
aeriz.cjs # CommonJS — for `require('@aeriz/chart')`
|
|
441
441
|
aeriz.min.cjs # CommonJS minified
|
|
442
442
|
|
|
443
443
|
scripts/
|