Skip to content

potch/html-bin

Repository files navigation

html-bin

a codebin widget for embeddable editable live demos built on top of CodeMirror

Usage

npm i @potch/html-bin

import { createBin } from "@potch/html-bin";

import { createBin } from "https://unpkg.com/@potch/html-bin/build/index.min.js";

API

createBin(options)

create a bin component.

Options:

  • container (optional Element): will automatically append the bin if provided
  • extraClasses: a string of extra CSS classes to append to the bin element
  • sources: object with optional { js, css, html } strings of source to put in the corresponding editors
  • splitMode: (default true) whether to have the preview in split screen with code tabs.
  • split: number from [0, 1] specifying the ratio between the editor and preview panes. defaults to 0.5
  • width: CSS string to override default --bin-width value. defaults to 100%
  • height: CSS string to override default --bin-height value. defaults to 512px

Returns object with the following fields:

  • el: Element of the outermost HTML element of the bin
  • editors: contains { js, css, html } properties with the CodeMirror instances for each editor tab
  • activeTab: a signal representing the currently active editor tab
  • start: call this function if you did not provide the container option after attaching el to the DOM
  • teardown: call this if you are removing and destroying the bin to disconnect all listeners

About

a codebin widget for embeddable editable live demos, built on top of CodeMirror

Resources

License

Stars

Watchers

Forks