Skip to content

Commit

Permalink
feat(docs): pr fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Sisha0 committed Feb 21, 2023
1 parent c34ad66 commit 44d1e28
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
4 changes: 2 additions & 2 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ registerPlugins();
registerSettings();
```

Before using UIP components, you also need to *register* them. The callbacks above do this by themselves.
But if you want to have a custom registration logic, there is a way to register components manually:
The callbacks above register UIP components by themselves. But if you want to have a custom registration logic,
there is a way to register components manually:

```typescript
import {UIPRoot} from '@exadel/ui-playground/esm/registration';
Expand Down
6 changes: 2 additions & 4 deletions src/core/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ class UIPComponent extends UIPPlugin {

You can find a way of getting current markup in [UIPStateModel](src/core/README.md#uip-state-model) section.

To make the long story shorter: we implement "reaction" callback in *_onRootStateChange()* (using markup's getter
mentioned earlier) and every time **UIPStateModel** produces markup updates, we "react" to them!

## Example

```typescript
Expand All @@ -59,7 +56,8 @@ class UIPPreview extends UIPPlugin {
## Description

**UIPRoot** contains [UIPStateModel](src/core/README.md#uip-state-model) getter. It also allows **UIPPlugin** elements
subscribing to model changes (or unsubscribing from them). More details can be found in [UIPPlugin](src/core/README.md#uip-plugin) section.
to subscribe to model changes (or unsubscribe from them). More details can be found in
[UIPPlugin](src/core/README.md#uip-plugin) section.

## Example

Expand Down
2 changes: 1 addition & 1 deletion src/plugins/editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ interface EditorConfig {
- **Wrap** number sets the limit of characters before wrapping. Set to **0** to remove wrapping or **true** for wrapping
on the container's width.
- **MinLines** is a minimum number of lines to be displayed.
- **MaxLines** is a maximum number of lines to be displayed. If the number of lines exceeds this limit, vertical scrool will appear.
- **MaxLines** is a maximum number of lines to be displayed. If the number of lines exceeds this limit, vertical scroll will appear.

We think that these options are the most common, so we made their configuration easier. All you need is to pass an object
to the editor's attribute *editor-config*, like in the example below:
Expand Down
3 changes: 2 additions & 1 deletion src/plugins/header/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
**UIPHeader** - custom element, a container for [UIPSnippets](src/header/snippets/README.md) and [UIPOptions](src/header/options/README.md).

# Description
By default *UIPHeader* initializes *UIPSnippets*, *UIPOptions* and a copy icon inside of it, so you need to add an empty *uip-header* tag only. But you can also manually set what stuff do you want it to render. The following example shows how you can display [UIPSnippets](src/header/snippets/README.md) only:
By default *UIPHeader* initializes *UIPSnippets*, *UIPOptions* and a copy icon inside of it, so you need to add an empty *uip-header* tag only. But you can also manually set what you want it to render. The following example shows
how only [UIPSnippets](src/header/snippets/README.md) can be displayed:

```html
<uip-header>
Expand Down

0 comments on commit 44d1e28

Please sign in to comment.