React-pkg-demo NPM

react-pkg-demo

Features

A component for quickly throwing together a react package demo

Install

Install with npm:

 npm i react-pkg-demo -D

Usage

import PkgDemo from 'react-pkg-demo'
...
<PkgDemo
      color={"CBC3E3"}
      packageName={"react-pkg-demo"}
      icon={"⬇️"}
      markdown={"Some markdown content"}
      prompt={"Edit the code below and try it out!"}
      code={
        "() => <button onClick={() => alert('It works!')}>test button</button>"
      }
    />

Properties

Property	Type	Requirement	Description
packageName	string	required	Name of package being demonstrated
color	string	required	Theme color
code	string	required	Live code
scope	{components}	optional	Any component in the demo code
icon	string	optional	Decorative icon
prompt	string	optional	Text in demo to prompt the user to try it
content	string	optional	Markdown content (e.g. copied from your readme)