UIP Editor

UIPEditor is a plugin for the UI Playground that provides a live code editor for modifying the HTML or JavaScript of the currently active snippet. It is built on top of CodeJar for editing and uses Prism.js for syntax highlighting.


What It Does

Required minimum markup:

   <uip-root>
     <uip-preview></uip-preview>
     <uip-editor copy collapsible></uip-editor>
   </uip-root>

Common Attributes & Options

Attribute / Prop Type Default Description
source string html Specifies the source type (html or js)
label string Label for the editor, customizable per source
copy boolean false Enables the copy button in the toolbar
editable boolean true Toggles the editor's readonly mode

Events

Event Target Description
uip:change <uip-root> Triggered when the editor content changes
uip:snippet:change <uip-root> Triggered when the active snippet changes

Patterns & Tips

Goal Pattern
Enable live editing Add <uip-editor> to your layout
Prevent editing for JS snippets Use the uip-js-readonly attribute on the snippet or un-isolated mode
Add copy functionality Use the copy attribute on <uip-editor>

Advanced Customization

The UIPEditor can be extended or customized for advanced use cases. For example:


Troubleshooting

Symptom Cause Fix
Editor is readonly unexpectedly Note that the JS editing is enabled only in isolated mode, when your snippet is running in independed iframe Enable isolated mode to have scripts live editing enabled

Example

This example showcases real-time editing capabilities for both HTML and JavaScript code