squiggle/packages/components
2022-05-17 14:06:02 -04:00
..
.storybook Run prettier on monorepo + fix crashing playground 2022-04-12 15:41:36 +10:00
public Add prettier and format 2022-03-23 11:38:01 +11:00
src Responded to CR 2022-05-15 15:58:37 -04:00
.gitignore Add documentation and improve components 2022-03-01 10:59:48 +11:00
.npmignore Move to webpack 2022-03-22 10:40:14 +11:00
.prettierignore Change components to return result rather than environment 2022-04-23 15:02:44 -04:00
.prettierrc.json Add prettier and format 2022-03-23 11:38:01 +11:00
netlify.toml gt -> git 2022-04-15 10:41:38 -04:00
package.json Merge pull request #544 from quantified-uncertainty/dependabot/npm_and_yarn/types/node-17.0.34 2022-05-17 14:06:02 -04:00
README.md Made Node Packages page in docs just reference github readmes 2022-05-10 17:06:44 -04:00
tsconfig.json Run prettier on monorepo + fix crashing playground 2022-04-12 15:41:36 +10:00
webpack.config.js Fix build errors for components and lang 2022-04-12 16:21:32 +10:00

npm version License: MIT

Squiggle components

This package contains the react components for squiggle. These can be used either as a library or hosted as a storybook.

The @quri/squiggle-components package offers several components and utilities for people who want to embed Squiggle components into websites.

Usage in a react project

For example, in a fresh create-react-app project

yarn add @quri/squiggle-components

Add to App.js:

import { SquiggleEditor } from "@quri/squiggle-components";
<SquiggleEditor
  initialSquiggleString="x = beta($alpha, 10); x + $shift"
  jsImports={{ alpha: 3, shift: 20 }}
/>;

Build storybook for development

We assume that you had run yarn at monorepo level, installing dependencies.

You need to prepare by building and bundling squiggle-lang

cd ../squiggle-lang
yarn build

If you've otherwise done this recently you can skip those.

Run a development server

yarn start