unovis-ts-skilld
Skill184 starsChanged 37 days agoMITView on GitHub
Use when building charts, network graphs, timelines, or maps with @unovis/ts in vanilla TypeScript or JavaScript. Provides correct container and component setup, accessor and config patterns, update and destroy lifecycle, tooltip, crosshair, and styling rules for Unovis 1.7.x.
- Installs packages
In this repository35 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- floating-ui-vue-skilldSkill
- formkit-core-skilldSkill
- motion-v-skilldSkill
- pinia-colada-skilldSkill
- pinia-skilldSkill
- primevue-skilldSkill
- quasar-skilldSkill
- reka-ui-skilldSkill
- shadcn-vue-skilldSkill
- slidev-cli-skilldSkill
- tanstack-ai-vue-skilldSkill
- tanstack-vue-form-skilldSkill
- tanstack-vue-query-skilldSkill
- tanstack-vue-router-skilldSkill
- tanstack-vue-store-skilldSkill
- tanstack-vue-table-skilldSkill
- tanstack-vue-virtual-skilldSkill
- tresjs-core-skilldSkill
- unhead-vue-skilldSkill
- unovis-vue-skilldSkill
- vee-validate-skilldSkill
- vitepress-skilldSkill
- vue-data-ui-skilldSkill
- vue-i18n-skilldSkill
- vue-router-skilldSkill
- vue-skilldSkill
- vue-test-utils-skilldSkill
- vuetify-skilldSkill
- vueuse-components-skilldSkill
- vueuse-core-skilldSkill
- vueuse-integrations-skilldSkill
- vueuse-math-skilldSkill
- vueuse-motion-skilldSkill
- vueuse-shared-skilldSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 24
If tsconfig.json lists types explicitly, add "topojson-client" to it.
- Very specific: line 96
Always call chart.destroy() when tearing down (SPA route change, test teardown).
- Very specific: line 197
Do not mutate component.config or container.config directly.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
@unovis/ts
Unovis core package for vanilla TypeScript/JavaScript. Version 1.7.0, Apache-2.0,
ES modules only ("type": "module"). Renders SVG (plus Leaflet/MapLibre for maps)
into a DOM element. Source paths cited below are relative to the package root
(node_modules/@unovis/ts/).
Install (per README.md and https://unovis.dev/docs/intro):
npm install -P @unovis/tsTypeScript setup
- Enable
allowSyntheticDefaultImportsincompilerOptions(required by Unovis dependencies). Source: https://unovis.dev/docs/intro - If
tsconfig.jsonliststypesexplicitly, add"topojson-client"to it. Source: https://unovis.dev/docs/intro - Styles are injected at runtime via
@emotion/css(declared inpackage.jsonsideEffects:styles/index.js). Importing any component injects the global CSS variables. Do not import a CSS file; there is none. For strict CSP sites read https://unovis.dev/docs/guides/csp
Architecture
Three building blocks (README.md, index.js):
- Containers own the DOM element, the data, size, and rendering.
XYContainer(element, config, data)— multiple XY components plusxAxis,yAxis,tooltip,crosshair,annotationsslots (containers/xy-container/config.d.ts).SingleContainer(element, config, data)— exactly one component (componentslot), e.g. Graph, Sankey, TopoJSONMap, Donut, Treemap (containers/single-container/config.d.ts).
- Components are constructed with their config:
new Line({ x, y }). They hold no data; the container feeds them the data array. - Standalone components need no container:
LeafletMap,LeafletFlowMap, and the legends (BulletLegend,RollingPinLegend,FlowLegend). Source: https://unovis.dev/docs/intro
Data records are generic (Line<Datum>), read through accessors:
a value or a function (d, i) => value. Types in types/accessor.d.ts:
NumericAccessor, StringAccessor, ColorAccessor, BooleanAccessor,
GenericAccessor.
import { Axis, Line, XYContainer } from '@unovis/ts'
type DataRecord = { x: number; y: number }
const data: DataRecord[] = [
{ x: 0, y: 0 },
{ x: 1, y: 2 },
{ x: 2, y: 1 },
]
const line = new Line<DataRecord>({
x: d => d.x,
y: d => d.y,
})
const chart = new XYContainer(document.getElementById('vis-container')!, {
components: [line],
xAxis: new Axis(),
yAxis: new Axis(),
}, data)Individual imports are tree-shakable and equivalent
(@unovis/ts/containers/xy-container, @unovis/ts/components/line, ...).
Source: https://unovis.dev/docs/quick-start. Heavy parts (Graph layouts,
LeafletMap renderer) load via dynamic import after initialization.
Update lifecycle
Data lives on the container; configs live on components. Update through the
container's public API (containers/xy-container/index.d.ts):
| Method | Purpose |
setData(data, preventRender?) | Replace the data array |
updateContainer(config, preventRender?) | Merge container config |
updateComponents(configs[], preventRender?) | Merge configs, index-aligned with components |
update(containerConfig, componentConfigs?, data?) | All at once |
SingleContainer has updateComponent (singular) instead of
updateComponents (containers/single-container/index.d.ts). Pass
preventRender: true to defer rendering when batching updates.
Always call chart.destroy() when tearing down (SPA route change, test
teardown). It removes the ResizeObserver, DOM node, and timers
(core/container/index.d.ts).
Sizing
Container config width/height accept pixels or CSS units but not %
(core/container/config.d.ts). For percentage sizing, set width/height
via CSS on the container's DOM element instead. sizing controls fit
behavior: Sizing.Fit (default), Sizing.Extend, Sizing.FitWidth
(types/component.d.ts).
Common recipes
Tooltip and crosshair go in the container config, not the components array:
import { Axis, Crosshair, Line, Tooltip, XYContainer } from '@unovis/ts'
const tooltip = new Tooltip()
const crosshair = new Crosshair<DataRecord>({
color: d => d.color ?? null,
template: d => `<div>${d.x}: ${d.y}</div>`,
})
const chart = new XYContainer(el, {
components: [line],
xAxis: new Axis(),
yAxis: new Axis(),
tooltip,
crosshair,
}, data)Stacked bars use one y accessor per stack level:
import { Axis, StackedBar, XYContainer } from '@unovis/ts'
const bar = new StackedBar<DataRecord>({
y: [d => d.a, d => d.b],
})
new XYContainer(el, { components: [bar], xAxis: new Axis(), yAxis: new Axis() }, data)A graph lives in a SingleContainer with { nodes, links } data:
import { Graph, GraphLayoutType, SingleContainer } from '@unovis/ts'
const graph = new Graph<GraphNodeDatum, GraphLinkDatum>({
layoutType: GraphLayoutType.Force,
linkStroke: l => l.color ?? null,
nodeSize: n => n.size ?? 10,
})
const chart = new SingleContainer(el, { component: graph }, {
nodes: [{ id: 'a' }, { id: 'b' }],
links: [{ source: 'a', target: 'b' }],
})Events are declared per-component with CSS selectors exposed as static
selectors on each component class (core/component/config.d.ts):
const area = new Area<DataRecord>({
x: d => d.x,
y: d => d.y,
events: {
[Area.selectors.area]: {
click: d => console.log('clicked', d),
},
},
attributes: { // stable hooks for E2E tests
[Area.selectors.area]: { 'test-value': d => String(d.y) },
},
})Map with bundled TopoJSON (maps.d.ts exports WorldMapTopoJSON,
USATopoJSON, GermanyTopoJSON, UKTopoJSON, FranceTopoJSON,
IndiaTopoJSON, ChinaTopoJSON, USCountiesTopoJSON,
WorldMapSimplestTopoJSON, WorldMap110mAlphaTopoJSON):
import { SingleContainer, TopoJSONMap, WorldMapTopoJSON } from '@unovis/ts'
const map = new TopoJSONMap<AreaDatum, PointDatum>({
topojson: WorldMapTopoJSON,
mapFeatureName: 'countries',
areaColor: d => d.color ?? null,
pointColor: d => d.color ?? null,
longitude: d => d.longitude ?? null,
latitude: d => d.latitude ?? null,
})
new SingleContainer(el, { component: map }, areaData)Rules and pitfalls
- Do not mutate
component.configorcontainer.configdirectly; call theupdate*methods so changes merge with defaults and re-render. Axisinstances forxAxis/yAxisneed notype; the container assigns it (containers/xy-container/config.d.ts). Settypeonly for a standaloneAxisincomponents.- Colors: component
coloraccessors returningnullfall back to the container palette (--vis-color<N>CSS variables). UsecolorKeyson XY components to map series to colors (core/xy-component/config.d.ts). - Animation duration: container
durationoverrides all components; componentduration(default600) applies to data transitions. - Numeric string enums (
CurveType,SymbolType,Position, ...) also accept their raw string values, e.g.curveType: 'monotoneX'. - Package targets browsers. Node usage needs a DOM shim (the library's own
tests run Vitest with jsdom,
package.jsonscripts).
References
- API surface — full export catalog, container and component class API, events/attributes, tooltips.
- Components — per-component key configs, defaults, and data shapes.
- Styling and theming — color palette, CSS variables, dark theme, patterns, testing.
Official documentation: https://unovis.dev/docs/intro — component reference at
https://unovis.dev/docs/components/<Name> (e.g. /docs/components/Line),
containers at /docs/containers/XY_Container and
/docs/containers/Single_Container. Gallery: https://unovis.dev/gallery.
Release notes: https://github.com/f5/unovis/releases (current prepared
version 1.7.0, package.json).
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

