uplot-svelte

Svelte wrapper for uPlot that allows you to work with charts declaratively inside your favorite framework.

Table of Contents

• Motivation
• Svelte
  • Installation
  • How to use
  • Demo
• Documentation

Motivation

While several other uPlot wrappers already exist, all of them have one of the following limitations:

1. They create uPlot instance once, during component mount phase, and expect you to handle all the update logic yourself.
2. They recreate uPlot instance anew whenever the props change, even if the instance can be updated to reflect the changes.

In comparison this library tries it's best not to recreate the uPlot instance once the props change. Instead of recreation it tries to use uPlot public API to keep it up to date with the props.

Svelte

Installation

Install uplot-svelte package with uplot dependency:

• Using npm: $ npm install uplot-svelte uplot
• Using yarn: $ yarn add uplot-svelte uplot

You also need Svelte to be installed inside your project tree. UplotSvelte component is compatible with Svelte and SvelteKit projects.

How to use

<script lang="ts">
    import UplotSvelte from 'uplot-svelte';
    import uPlot from 'uplot';
    import 'uplot/dist/uPlot.min.css';

    ...
</script>

<UplotSvelte {options} {data} onCreate={onCreate} onDelete={onDelete} />

Demo

See the example Svelte example

You can also run the demo app locally:

$ git clone https://github.com/skalinichev/uplot-wrappers.git

$ cd uplot-wrappers && yarn install && yarn run serveSvelte

Documentation

| Parameter | Requirement | Description | | :---------: | :---------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | options | required | Options for uPlot. Passed as the first argument to uPlot constructor: new uPlot(options) | | data | required | Data for uPlot. Passed as the second argument to uPlot constructor: new uPlot(options, data) | | target | optional | Target html element or init function for uPlot. Passed as the third argument to uPlot constructor: new uPlot(options, data, target) A new div target element will be created automatically if none is passed in the props | | onCreate | optional | Callback function, invoked upon uPlot instance creation or recreation | | onDelete | optional | Callback function, invoked before uPlot instance gets destroyed, either because the props has changed so much it's impossible to update the chart or because the component is about to be unmounted | | class | optional | A class name passed over to the automatically created target div element. Class name is ignored when the 'target' prop is used. | | resetScales | optional | Flag controlling whether to reset the scales on data change. Defaults to true. |