Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FormidableLabs/component-playground

A component for rendering React components with editable source and live preview
https://github.com/FormidableLabs/component-playground

component-playground javascript jsx react

Last synced: 2 days ago
JSON representation

A component for rendering React components with editable source and live preview

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/FormidableLabs/component-playground.svg?branch=master)](https://travis-ci.org/FormidableLabs/component-playground)

![](https://badge-size.herokuapp.com/FormidableLabs/component-playground/master/dist/component-playground.min.js?compression=gzip)

[![Maintenance Status][maintenance-image]](#maintenance-status)



# component-playground

A component for rendering React Components and ES6 code with editable source and live preview



![Component Playground](http://i.imgur.com/se3avpr.png)



### Installation



```sh

npm install component-playground

```



### Set up



In the head of your html document, either add the css files from the demo or from a CDN like:



```html



```



In your JSX, require the component and use it like this:



```javascript

'use strict';



var React = require('react/addons');

var ReactDOM = require('react-dom');

var Playground = require('component-playground');

var Button = require('./components/button');



var componentExample = require("raw!./examples/component.example");



var Index = React.createClass({

  render() {

    return (

      


        

      


    );

  }

});



ReactDOM.render(, document.getElementById('root'));

```



### Props



#### `codeText`

_React.PropTypes.string.isRequired_



`codeText` takes a string of JSX markup as its value. While you can just pass it a string, I find it is easier to make a separate file and use Webpack's raw loader to load in the raw source. In the example above I use the .example extension, and an examples folder to organize my samples.



An example file would look like:



```js

Hi

```



#### scope

_React.PropTypes.object.isRequired_



When evaluating the JSX, it needs to be provided a scope object. At the very least, React needs to be provided to the scope, if any custom tags aren't being used. See below:



```js



```



Any module/component that is used inside the playground needs to be added to the scope object. See `/demo` for an example of how this works.



### theme

_React.PropTypes.string_



String specifying which CodeMirror theme to initialize with. Defaults to 'monokai'.



### collapsableCode

_React.PropTypes.bool_



Allows the user to collapse the code block.



```js



```



### initiallyExpanded

_React.PropTypes.bool_



Makes collapsable code block initially expanded.



```js



```



### docClass

_React.PropTypes.node_



A component class that will be used to auto-generate docs based on that component's `propTypes`. See `propDescriptionMap` below for how to annotate the generate prop docs.



```js



```



### propDescriptionMap

_React.PropTypes.string_



Annotation map for the docClass. The key is the prop to annotate, the value is the description of that prop.



```js



```



### es6Console

_React.PropTypes.bool_



Turns preview into a simple console for testing out ES6 code. Use `console.log()` in the playground to generate output.



```js



```



### noRender

_React.PropTypes.bool_



Defaults to true. If set to false, allows you bypass the `component-playground`'s component wrapper and render method.

You can use this option to write higher order components directly in your example code and use your

own Render method.

NOTE: This option **requires** that the `React.render` method be in your code



```js

var ComponentExample = React.createClass({

  render: function() {

    return (

        
Hi


    )

  }

});



React.render(, mountNode);

```



### Comparison to [react-live](https://github.com/FormidableLabs/react-live)



There are multiple options when it comes to live, editable React component environments. Formidable actually has **two** first class projects to help you out: [`component-playground`](https://github.com/FormidableLabs/component-playground) and [`react-live`](https://github.com/FormidableLabs/react-live). Let's briefly look at the libraries, use cases, and factors that might help in deciding which is right for you.



Here's a high-level decision tree:



- If you want **fast and easy** setup and integration, then `component-playground` may be the ticket!

- If you want **a smaller bundle**, **SSR**, and **more flexibility**, then `react-live` is for you!



Here are the various factors at play:



- **Build**: `component-playground` uses `babel-standalone`, `react-live` uses `bublé`. (_Note_: `react-live` might make transpiler customizable in the future).

- **Bundle size**: `component-playground` has a larger bundle, but uses a more familiar editor setup. `react-live` is smaller, but more customized editor around `prism`.

- **Ease vs. flexibility**: `react-live` is more modular/customizable, while `component-playground` is easier/faster to set up.

- **SSR**: `component-playground` is not server-side renderable, `react-live` is.

- **Extra features**: `component-playground` supports raw evaluation and pretty-printed output out-of-the-box, while `react-live` does not.

- **Error handling**: `component-playground` might have more predictable error handling than `react-live` in some cases (due to `react-dom`, although this might change with React 16).



## Maintenance Status



 **Archived:** This project is no longer maintained by Formidable. We are no longer responding to issues or pull requests unless they relate to security concerns. We encourage interested developers to fork this project and make it their own!



[maintenance-image]: https://img.shields.io/badge/maintenance-archived-red.svg