squiggle/packages/components
Ozzie Gooen 906878f19f
Merge pull request #694 from quantified-uncertainty/tailwind-forms-fix
Fix react-ace/tailwind css collision (fixes #672); fix preflight configuration
2022-06-14 06:26:18 -07:00
..
.storybook scoped tailwind preflight, top-level .squiggle wrapper 2022-06-09 23:57:45 +03:00
public Add prettier and format 2022-03-23 11:38:01 +11:00
src fix react-ace/tailwind css collision (fixes #672) 2022-06-14 11:57:28 +03: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 prettierignore forms css 2022-06-14 12:08:56 +03: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 #694 from quantified-uncertainty/tailwind-forms-fix 2022-06-14 06:26:18 -07:00
postcss.config.js scoped tailwind preflight, top-level .squiggle wrapper 2022-06-09 23:57:45 +03:00
README.md Made Node Packages page in docs just reference github readmes 2022-05-10 17:06:44 -04:00
tailwind.config.js fix react-ace/tailwind css collision (fixes #672) 2022-06-14 11:57:28 +03:00
tsconfig.json Simple line chart for Functions 2022-05-26 14:41:58 -04:00
webpack.config.js scoped tailwind preflight, top-level .squiggle wrapper 2022-06-09 23:57:45 +03: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