Smithkit documentation

Build static and interactive Smith charts using the same public API. Start with a guide, open a working example, or search for a class, method, option, or phrase. This site follows main; the displayed package version does not imply that every documented change has already been published to npm.

Start here

• Getting started: mount a chart, enable interaction, resize and destroy.
• Configuration: constructor defaults, setOptions() patches, themes and grid controls.
• Traces and markers: object/tuple/packed inputs, identity, display accuracy and accessibility.
• Events and readings: subscriptions, delivery timing, physical units and singular values.
• Scales: independent radial scales and peripheral rulers.
• RF calculations: complex arithmetic, conversions, formatting and renormalization.
• Touchstone: S11/S22 import and .s1p export.
• SVG and PNG export: report dimensions, backgrounds, legends and explicit scale readings.
• Framework integration: React and Angular mounting, updates and cleanup.

API reference

Reference pages are generated from the public package declarations. They include overloads, parameter and return types, option fields and links between types. Private rendering classes are not part of this contract.

Working examples and compatibility

Each integration example includes the executed TypeScript source. Examples use the public library directly; React and Angular components are copyable starting points, not separate wrapper packages.

See the compatibility evidence for browser and compiler targets, the migration guide when upgrading, and the API compatibility policy for the intended 1.x contract. During 0.x, breaking API changes may occur in minor releases.