Skip to content

Commit

Permalink
feat!: finalizing update 2.0.0
Browse files Browse the repository at this point in the history
To see the whole scope of changes see the result primary version changelog, here some of the major updates...

BREAKING CHANGE: #512, #519 - Replace ACE editor with CodeJar + PrismJs
BREAKING CHANGE: #525 - rework UIP general livecycle
  • Loading branch information
ala-n committed Sep 26, 2023
1 parent f21d1ec commit 595c3f9
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
3 changes: 2 additions & 1 deletion src/core/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

# UIPPlugin

**UIPPlugin** - base class for all UIP elements. Extending it allows creating custom UIP components.
**UIPPlugin** - base class for all UIP elements.
Should be used as a parent class for all custom plugins of UIP to correctly observe and change UIPModel state.

## Description

Expand Down
4 changes: 3 additions & 1 deletion src/core/preview/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# UIP Preview

**UIPPreview** - custom element, that displays active markup. Extends [UIPPlugin](src/core/README.md#uip-plugin).
**UIPPreview** - is a mandatory UIP custom element that displays active markup. Extends [UIPPlugin](src/core/README.md#uip-plugin).

**UIPPreview** element observes [UIPStateModel](src/core/README.md#uip-state-model) changes, but it doesn't produce them.

The `uip-preview` should be placed inside [UIPRoot](src/core/README.md#uip-root) element.

## Example
```html
<uip-preview></uip-preview>
Expand Down
15 changes: 12 additions & 3 deletions src/plugins/editor/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# UIP Editor

**UIPEditor** - custom element, code editor for changing current markup. It allows user to manually configure
the component inside [UIPPreview](src/core/README.md). Extends [UIPPlugin](src/core/README.md#uip-plugin).
**UIPEditor** - UIP module to provide live-editor for current playground content.
Extends [UIPPlugin](src/core/README.md#uip-plugin).

## Description
**UIPEditor** is based on [Codejar](https://medv.io/codejar/) editor. We also use [Prism.js](https://prismjs.com/) for highlighting.
**UIPEditor** is based on [Codejar](https://medv.io/codejar/) editor.
Use [Prism.js](https://prismjs.com/) for code highlighting by default.

## Example
```html
<uip-root>
<uip-preview></uip-preview>
<uip-editor></uip-editor>
<uip-root>
```

0 comments on commit 595c3f9

Please sign in to comment.