apexcharts 6.10.0 → 7.0.0

package/README.md

@@ -140,7 +140,19 @@ No more `dynamic(() => import(...), { ssr: false })` workarounds: the chart rend
 
 ## Tree-shaking: ship only what you use
 
-By default `import ApexCharts from 'apexcharts'` includes everything. For smaller bundles, import from `apexcharts/core` and add only what you need:
+`import ApexCharts from 'apexcharts'` gives you every chart type and the
+everyday features. Nine optional features ship outside it and are imported
+explicitly (marked **opt-in** below); each warns in the console if its config is
+set but the feature is absent. Adding one to the default bundle is a single
+line, and the two share one copy of the core:
+
+```js
+import ApexCharts from 'apexcharts'
+import 'apexcharts/features/trellis'
+```
+
+For a smaller bundle still, start from `apexcharts/core` and add only what you
+need:
 
 ```js
 import ApexCharts from 'apexcharts/core'   // bare class: no chart types, no features
@@ -160,19 +172,33 @@ import 'apexcharts/features/toolbar'      // zoom/pan toolbar
 // import 'apexcharts/features/keyboard'     // keyboard navigation
 // import 'apexcharts/features/drilldown'    // hierarchical drill-down
 // import 'apexcharts/features/morph'        // animated chart-type morphs
-// import 'apexcharts/features/history'      // undo/redo (premium)
-// import 'apexcharts/features/perspectives' // shareable view state (premium)
-// import 'apexcharts/features/storyboard'   // scrollytelling, incl. perspectives (premium)
+// import 'apexcharts/features/history'      // undo/redo (premium, opt-in)
+// import 'apexcharts/features/perspectives' // shareable view state (premium, opt-in)
+// import 'apexcharts/features/storyboard'   // scrollytelling, incl. perspectives (premium, opt-in)
 // import 'apexcharts/features/facet'        // design tokens + OS themes
 // import 'apexcharts/features/weave'        // plugin platform
 // import 'apexcharts/features/marks'        // custom series types
-// import 'apexcharts/features/link'         // crossfilter / linked views (premium)
-// import 'apexcharts/features/ink'          // on-chart annotation editing (premium)
-// import 'apexcharts/features/measure'      // measure/delta ruler (premium)
-// import 'apexcharts/features/context-menu' // right-click context menu (premium)
-// import 'apexcharts/features/renderer-canvas' // canvas series renderer
+// import 'apexcharts/features/link'         // crossfilter / linked views (premium, opt-in)
+// import 'apexcharts/features/ink'          // on-chart annotation editing (premium, opt-in)
+// import 'apexcharts/features/measure'      // measure/delta ruler (premium, opt-in)
+// import 'apexcharts/features/context-menu' // right-click context menu (premium, opt-in)
+// import 'apexcharts/features/renderer-canvas' // canvas series renderer (opt-in)
+// import 'apexcharts/features/trellis'     // small multiples (premium, opt-in)
+```
+
+A page without a bundler gets the same choice. `apexcharts.js` stays
+batteries-included, and `apexcharts.core.min.js` is the lean baseline you build
+up from:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/apexcharts/dist/apexcharts.core.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/apexcharts/dist/line.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/apexcharts/dist/features/legend.js"></script>
 ```
 
+Opt-in features work the same way there: load `dist/features/<name>.js` after
+whichever bundle the page already has.
+
 See the [tree-shaking guide](https://apexcharts.com/docs/tree-shaking/) for the complete list of entry points.
 
 ### Shapes for the unit chart
@@ -193,6 +219,18 @@ new ApexCharts(el, {
 
 Shapes are composable (`outlined(heart)` traces it instead of filling it, `heart.with({ order: 'cols' })` changes where each series band lands), and `preview(heart, { series })` renders one to an SVG string with no chart and no DOM, for docs and build-time images. From a script tag, `dist/unit-shapes.js` exposes the same kit as `ApexUnitShapes` and registers every shape by name.
 
+**The shape you want is probably not one of the 39, and it does not have to be.** `positions` takes any function of the marks and the plot rectangle, so there are three ways in, none of which needs a release from us:
+
+```js
+import { shapeFrom, strokeFrom } from 'apexcharts/unit-shapes'
+
+shapeFrom('M 26 71 A 24 21 0 1 1 74 71 …')        // your own outline, packed like ours
+strokeFrom('M 6 76 L 24 44 L 40 60 …', { width: 12 })  // a centreline, for a line
+positions: (objects, rect) => objects.map(…)      // your own rule, no kit at all
+```
+
+Working demo of all three, including the outline-authoring rules (subpaths union, a reverse-wound one cuts a hole): [bring-your-own-shape](samples/vanilla-js/unit/bring-your-own-shape.html).
+
 ## Premium features & licensing
 
 Most of ApexCharts is free and open source. A small set of advanced features are **premium** and require a license key: