@kong-ui-public/analytics-chart 13.2.10 → 13.2.11
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 +13 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
# @kong-ui-public/analytics-chart
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Low-level chart components for Kong analytics.
|
|
4
|
+
|
|
5
|
+
Application consumers must render charts through
|
|
6
|
+
[`DashboardRenderer` or `DashboardTilePreview`](../dashboard-renderer/README.md#consumer-entry-points).
|
|
7
|
+
These entry points own analytics queries, readiness, filters, and loading/error
|
|
8
|
+
states. Do not import or render `AnalyticsChart` directly unless a required
|
|
9
|
+
capability cannot be implemented through either entry point. First investigate
|
|
10
|
+
extending the shared renderer and document the blocker and minimal exception
|
|
11
|
+
in the PR.
|
|
12
|
+
|
|
13
|
+
The primitive API and examples below are references for library internals,
|
|
14
|
+
primitive tests, and justified exceptions. They do not recommend direct use in
|
|
15
|
+
application pages. The API remains available.
|
|
4
16
|
|
|
5
17
|
- [Features](#features)
|
|
6
18
|
- [Requirements](#requirements)
|