squiggle/packages/components/README.md

47 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

[![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-components.svg)](https://www.npmjs.com/package/@quri/squiggle-components)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/quantified-uncertainty/squiggle/blob/develop/LICENSE)
# Squiggle Components
2022-04-04 06:58:05 +00:00
2022-03-23 14:01:51 +00:00
This package contains all the components for squiggle. These can be used either as a library or hosted as a [storybook](https://storybook.js.org/).
2022-02-27 04:41:30 +00:00
# Usage in a `react` project
For example, in a fresh `create-react-app` project
```sh
yarn add @quri/squiggle-components
```
Add to `App.js`:
```jsx
import { SquiggleEditor } from "@quri/squiggle-components";
<SquiggleEditor initialSquiggleString="x = beta(3, 10); x + 20" />;
```
# Build storybook for development
2022-03-25 00:18:06 +00:00
2022-04-04 06:58:05 +00:00
We assume that you had run `yarn` at monorepo level, installing dependencies.
You need to _prepare_ by building and bundling `squiggle-lang`
```sh
2022-03-25 00:18:06 +00:00
cd ../squiggle-lang
2022-03-23 14:01:51 +00:00
yarn build
```
2022-04-04 06:58:05 +00:00
If you've otherwise done this recently you can skip those.
2022-02-27 04:41:30 +00:00
2022-03-23 14:01:51 +00:00
Run a development server
2022-04-04 06:58:05 +00:00
```sh
2022-03-23 14:01:51 +00:00
yarn start
```
2022-03-24 01:58:53 +00:00
And build artefacts for production,
2022-03-23 14:01:51 +00:00
2022-04-04 06:58:05 +00:00
```sh
2022-03-23 14:01:51 +00:00
yarn build # builds storybook app
```