Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KCL-12190 - Real-time feedback rename #149

Merged
merged 1 commit into from
Jan 30, 2024
Merged

KCL-12190 - Real-time feedback rename #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ commonjs/
coverage/
storybook-static/
debug.log
.DS_Store
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Dependency on @kontent-ai/delivery-sdk for types.
- New iframe message ("update") added to iframe communication.
- Support for custom real-time feedback handler implementation.
- Support for a custom live preview handler implementation.

## [3.1.0] - 2023-08-15

Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,17 +427,17 @@ useEffect(() => {
For even better experience, you can combine the previous two methods and re-fetch content from Delivery Preview API
on the client-side to update affected placed while waiting for the rebuild process to finish.

### Real-time feedback in Web Spotlight
### Live preview in Web Spotlight

> :warning: **Warning:** This feature is in early access meaning that the API is subject to change.

Starting from version 3.2.0-next.0, Smart Link SDK support real-time feedback in Web Spotlight. If your preview website
Starting from version 3.2.0-next.0, Smart Link SDK support live preview in Web Spotlight. If your preview website
uses the supported SDK version, Kontent.ai will send the updated elements to your website via the iframe communication
right after you update them in the in-context editor.

**Please note, that your preview website won't update automatically, and it is up to you to decide how to handle this new event in your application.**

#### Setting up real-time feedback in your app
#### Setting up live preview in your app

```ts
import KontentSmartLink, { KontentSmartLinkEvent } from '@kontent-ai/smart-link';
Expand Down Expand Up @@ -480,7 +480,7 @@ You can find [ElementType](https://github.com/kontent-ai/delivery-sdk-js/blob/v1

#### Current limitations

Since the real-time feedback feature is currently in early access, there are some limitations:
Since the live preview feature is currently in early access, there are some limitations:
- Kontent.ai doesn't notify SDK about the changes in a linked item element or a subpages element.
- Kontent.ai doesn't notify SDK about the changes in a rich-text element if:
- this rich-text element contains a linked item or a content component
Expand Down
Loading