Giter Club home page Giter Club logo

code-live-sandbox's Introduction

中文

code-live-sandbox

A React code sandbox in the browser. Useful for component library documentation, code execution, React playgrounds, and more.

Comparison with Similar Products

  • Maintains consistency with React's mechanisms, ensuring that lifecycle methods and hooks work as expected.

  • Strong extensibility, with support for custom transforms.

  • Supports both inline and mounted modes.

  • The most concise code.

Usage

pnpm add @swc/wasm-web code-live-sandbox
import { LivePreview, LiveProvider, useLiveContext } from 'code-live-sandbox';
// Requirements for the Editor component, implement an editable container. For example: MirrorCode, vscode, etc.
import Editor from '../Editor'

const Live = useMemo(() => {
      let node;
      try {
          node = !showView ? <Editor /> : <LivePreview />;
      } catch (err) {
          node = <Editor />;
      }
      return (
          <LiveProvider
              code={value}
              scope={{
                  ...scope,
                  data: props,
              }}
          >
              <Error />
              {node}
          </LiveProvider>
      );
  }, [props, value, showView]);

Using SWC as the Default Transformer, with Support for Custom Bundlers.

import { setDrive } from 'code-live-sandbox';
import { transform as _transform } from 'sucrase';

setDrive((code: string) => {
  return _transform(code, {
    transforms: ['jsx', 'typescript', 'imports'],
    production: true,
  }).code.substring(13); // remove leading `"use strict";`
});

Default configurations can be inspected with TypeScript types, and custom configurations are supported.

import { changeTransform } from 'code-live-sandbox';
import { merge } from 'lodash';
// Set custom compilation rules for components
changeTransform((config) => {
  return merge(
    {
      jsc: {
        transform: {
          react: { development: process.env.NODE_ENV === 'development' },
        },
      },
    },
    config
  );
});

Inline and Mounted Modes

  • Inline mode: Integrates seamlessly into the current React app.

  • Mounted mode: Mounted under a separate DOM container, allowing multiple React instances to run on the same page.

<LiveProvider code={value} alone={true}...

Roadmap

  • A code sandbox with automatic npm dependency importation.

code-live-sandbox's People

Contributors

mrxyy avatar

Stargazers

 avatar Barış Kaya avatar

Watchers

 avatar  avatar

Forkers

ringotc

code-live-sandbox's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.