@potch/html-bin 1.1.2 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+# 2.0.0
+
+Initial public release.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Potch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,30 @@
 # html-bin
 
-wip!
+a codebin widget for embeddable editable live demos built on top of [CodeMirror](https://codemirror.net/)
+
+## API
+
+### `createBin`
+
+create a bin component.
+
+Options:
+
+- `container` (optional Element): will automatically append the bin if provided
+- `sources`: object with optional `{ js, css, html }` strings of source to put
+  in the corresponding editors
+- `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