Skip to content

Latest commit

 

History

History
129 lines (83 loc) · 6.07 KB

README.md

File metadata and controls

129 lines (83 loc) · 6.07 KB
Raw

Sverto

Sverto is an extension for Quarto that lets you seamlessly write and include Svelte components, like charts and other visuals, in your Quarto website.

Your Svelte components can seamlessly react to your ObservableJS code, making it quick and easy to build visuals that animate in response to user inputs or other changing data in your document.

📋 Prerequisites

You'll need to install two things to run Sverto:

⚙️ Installation

Install the project extension using:

quarto use template jimjam-slam/sverto

Then run:

npm install

This will add the extension itself (which includes some project scripts) to the _extension folder, as well as a few other files.

📦 What's in the box?

When you use the Sverto template in a project, it creates some files for you:

  • example.qmd: an example Quarto doc that uses a Svelte component
  • Circles.svelte: an example Svelte visualisation
  • package.json: this is used to keep track of the dependencies of your Svelte components. You should add this to version control.
  • package-lock.json is created once you run npm install. You should add this to version control.
  • node_modules/: This folder is created once you rum npm install. Don't add it to version control.

🎉 Use

Step 1: add Svelte to your document

In the document frontmatter, add sverto to filters, and add one or more .svelte files to sverto.use:

---
title: "My document"
filters: ["sverto"]
sverto:
  use:
    - example.svelte
---

Step 2: bring your Svelte component to life

Use an Observable JS chunk to construct your Svelte component.

```{ojs}
myChart = new example.default({
  target: document.querySelector("#chart")
})
```

:::{#chart}
:::
  • the target is where it will appear. This needs to be an existing part of the document — you can put a Pandoc div right after this code, or put one anywhere else on the page
  • example is the file name of your Svelte component, without the file extension

Step 3: make your component reactive

If your component has props that allow it to change or transition in response to other OJS code, you can update them by assigning the prop directly.

For example, if we have a dataset called myData in OJS, and a year slider called selectedYear, we might change a prop called chartData whenever the user selects a new year like:

```{ojs}
myChart.chartData = myData.filter(d => d.year == selectedYear)
```

![NOTE] quarto preview won't "live reload" when you modify your Svelte component—but if you modify and save the Quarto doc that imports it, that will trigger a re-render. You may need to hard reload the page in your browser to see the updated Svelte component.

If you want to quickly iterate on the Svelte component, you might find the Svelte Preview extension for VSCode handy.

📦 What's in the box?

When you use the Sverto template in a project, it creates some files for you:

  • example.qmd: an example Quarto doc that uses a Svelte component
  • Circles.svelte: an example Svelte visualisation
  • package.json: this is used to keep track of the dependencies of your Svelte components. You should add this to version control.
  • Once you've run npm install, there'll also be a package-lock.json and a .luarc.json. You should version control these too (although you oughtn't need to edit them manually). You don't need to touch the node_modules folder, either.

See example.qmd to learn how to add Svelte components to your documents and the Svelte tutorial to learn how to create them.

As well as the project format, Sverto ships with document formats (the default is sverto-html). If you need to change document options that would normally go under format: html, use format: sverto-html or format-sverto-revealjs instead.

🛍 Use other libraries in your Svelte component

If you want to refer to other JavaScript libraries in your Svelte component (like d3, for example), add them to the project using npm install package1 [package2 ...]. For example:

npm install d3

💭 Why Sverto?

Quarto helps data scientists and analysts build beautiful documents regardless of their language of choice, and it encourages data analysts and scientists to explore web visualisation by making JavaScript accessible and easy to use.

Quarto makes interactive charts intuitive to write, but animated ones are still a challenge that require either dipping into a high-level JavaScript library or learning a lower-level one like d3.

Svelte is a framework for building charts, web visualisations and even apps in HTML, CSS and JavaScript. Svelte goes out of its way to make writing self-contained components, like charts, comfortable and intuitive.

Svelte has a great playground environment for developing and testing components, but like many web frameworks, the experience is much more complex when you start developing locally.

Sverto aims to make it as easy to build and use animated Svelte charts in Quarto documents as it is to work on them in the Svelte playground: just write a .svelte file, add it to a Quarto document, and Sverto takes care of the rest.

❓ Issues

If you have any problems with the extension, please feel free to create an issue!

Special thanks to Carlos Scheidegger from Posit for his time and guidance getting Sverto working!