loading...

Introducing Playground - A Frontend Demonstration Component

boywithsilverwings profile image Agney Menon Updated on ・2 min read

Playground is a React Component that can be used for demonstrating HTML, CSS and JavaScript code.

Screenshot for Playground

Screenshot of Component. Link to demo at the bottom

It does not load from, or maintain code on any third party sites, there are no restrictions for number, and you don't have to shy away from making a small demo.

Github

Features

  1. Allows bare ES package imports. This means you can add imports for any library that supports ES Module resolution and playground will automatically load it into your code.
  2. Load preview for predefined code.
  3. Autoreloading preview.
  4. See console output in the component itself.
  5. Control tab loaded by default for your use-case.

Applications

  1. Add to static blogs to present your HTML, CSS or JavaScript code.
  2. Allow users to change the code and see the output in real time. This could be big in educational articles and so.

How does module imports work?

If an NPM package exposes an endpoint for "module", then you can direcly import this package by it's name.

import { format } from 'date-fns';

format(new Date(2014, 1, 11), 'yyyy-MM-dd');

Unfortunately, not all packages currently support this feature. You can search through an entire list of packages through pika.dev.

You can use community created packages to replicate the functionality. For eg. React would be:

import React, { createElement } from '@pika/react';
import ReactDOM from '@pika/react-dom';

ReactDOM.render(
  createElement('div', {}, 'Hello World'),
  document.getElementById('app')
);

How do I demo React code with JSX?

import Playground from "@agney/playground";

const App = () => {
  const snippet = {
    markup: `<div id=app />`,
    css: ``,
    javascript: `import React, { createElement } from "@pika/react";
import ReactDOM from "@pika/react-dom";

ReactDOM.render(
  <h1>Hello World</h1>,
  document.getElementById("app")
);`,
  };
  return (
    <Playground
      initialSnippet={snippet}
      defaultEditorTab="javascript"
      transformJs
      presets={["react"]}
    />
  );
};

What about the bundle size?

The component is fairly small at about npm bundle size. You can find the total size and time on Bundle Phobia.

When transforming JavaScript it uses Babel Standalone which adds a considerable size. Playground loads Babel from a CDN so that it can be loaded from browser cache on change.

It uses Chrome's Native Lazy Loading so that the iframes for results are loaded lazily and your pages remain fast.

Live Demo

See Complete Documentation

Posted on Mar 4 by:

boywithsilverwings profile

Agney Menon

@boywithsilverwings

Software Developer at BigBinary. Engineer πŸ‘¨β€πŸ’» Sleeping if not Online πŸ€–

Discussion

markdown guide