Skip to content

chore(SDK): update SDK README.md Documentation #32192

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.

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

Merged
Merged
Changes from 1 commit
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
fc790db
chore(SDK UVE): Update README.md to reflect SDK changes and improve d…
rjvelazco May 16, 2025
c2c8874
Merge branch 'main' into issue-29560-sdk-update-readmemd-examples-doc…
rjvelazco May 20, 2025
1c2748a
chore(UVE SDK): update README.md
rjvelazco May 20, 2025
758e02d
chore(UVE SDK): update README.md v2
rjvelazco May 20, 2025
5db7d93
chore(UVE SDK): update README.md v3
rjvelazco May 20, 2025
12fbf84
chore(REACT SDK): update README.md
rjvelazco May 20, 2025
91fd606
chore(REACT SDK): update README.md v2
rjvelazco May 20, 2025
5dd6953
chore(REACT SDK): update README.md v3
rjvelazco May 20, 2025
7c83b21
chore(REACT SDK): update README.md v4
rjvelazco May 20, 2025
27a6e5e
chore(REACT SDK): update README.md v5
rjvelazco May 20, 2025
d757b5a
chore(REACT SDK): update README.md v6
rjvelazco May 20, 2025
e6179da
chore(REACT SDK): update README.md v7
rjvelazco May 20, 2025
c4ac163
chore(REACT SDK): update README.md v8
rjvelazco May 20, 2025
1368ed1
chore(CLIENT SDK): update README.md
rjvelazco May 20, 2025
8f96005
chore(CLIENT SDK): update README.md v1
rjvelazco May 20, 2025
ce349b5
chore(CLIENT SDK): update README.md v2
rjvelazco May 20, 2025
5d8eb6f
chore(CLIENT SDK): update README.md v3
rjvelazco May 20, 2025
fd29e11
chore(CLIENT SDK): update README.md v4
rjvelazco May 20, 2025
a87d843
chore(REACT SDK): update README.md v9
rjvelazco May 21, 2025
de32888
chore(REACT SDK): stable readme.md version
rjvelazco May 21, 2025
04de6ea
chore(UVE SDK): stable readme.md version
rjvelazco May 21, 2025
237839c
chore(ANGULAR SDK): stable readme.md version
rjvelazco May 22, 2025
0c3499d
Merge branch 'main' into issue-29560-sdk-update-readmemd-examples-doc…
rjvelazco May 22, 2025
da7dc67
chore(Client SDK): stable readme.md version
rjvelazco May 22, 2025
6091e16
feedback v1
rjvelazco May 22, 2025
936f51b
feedback v2
rjvelazco May 22, 2025
406749c
clean up
rjvelazco May 22, 2025
13ad41e
chore(types SDK): add README.md
rjvelazco May 22, 2025
1d16ce1
chore: Cleanup and Polish Client
rjvelazco May 23, 2025
c3ef2ef
Freddy's feedback v1
rjvelazco May 26, 2025
8605729
Freddy's feedback v2
rjvelazco May 26, 2025
d7c6d50
fix: Correct typos and formatting in Angular and React SDK README files
rjvelazco May 26, 2025
b6a4a04
refactor(README): Revise content for clarity, enhance structure, and …
rjvelazco May 26, 2025
81dbf28
chore(README): Remove unnecessary separators and streamline content i…
rjvelazco May 26, 2025
4711dbf
docs(README): Enhance UVE SDK documentation with detailed API referen…
rjvelazco May 26, 2025
5e502e1
Merge branch 'main' into issue-29560-sdk-update-readmemd-examples-doc…
rjvelazco May 26, 2025
9ed5900
Merge branch 'main' into issue-29560-sdk-update-readmemd-examples-doc…
rjvelazco May 27, 2025
1e3e159
docs(README): Angular and React README.md feedback
rjvelazco May 28, 2025
4ee5049
docs(README): Update dotCMS Client SDK README.md v1
rjvelazco May 28, 2025
7eeb979
docs(README): Update dotCMS Client SDK README.md v2
rjvelazco May 29, 2025
a8d9768
docs(README): Add section on enabling page editing in dotCMS with UVE…
rjvelazco May 29, 2025
16f2e9c
docs: clean up
rjvelazco May 30, 2025
5b68797
docs(README): add a Before You Use `@dotcms/uve` section
rjvelazco May 30, 2025
21d3687
docs(README): Update SDK documentation to standardize terminology and…
rjvelazco May 30, 2025
cc268f9
docs(README): cleanup
rjvelazco May 30, 2025
05894fd
docs(README): update SDK examples to use simplified query methods and…
rjvelazco May 30, 2025
c1a6688
Merge branch 'main' into issue-29560-sdk-update-readmemd-examples-doc…
rjvelazco Jun 2, 2025
53aa086
docs(README): enhance SDK documentation with new image processing lin…
rjvelazco Jun 3, 2025
a8d05b9
docs(README): expand SDK documentation with detailed type hierarchy a…
rjvelazco Jun 3, 2025
837b8e7
docs(README): add section on using dotCMS images with Angular’s NgOpt…
rjvelazco Jun 3, 2025
b84f6fc
Merge branch 'main' into issue-29560-sdk-update-readmemd-examples-doc…
rjvelazco Jun 3, 2025
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
Prev Previous commit
Next Next commit
chore(UVE SDK): update README.md v2
  • Loading branch information
rjvelazco committed May 20, 2025
commit 758e02dd2cc376d732d3a0eef275296f259f1b88
40 changes: 39 additions & 1 deletion core-web/libs/sdk/uve/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
# DotCMS UVE SDK
# dotCMS UVE SDK

A JavaScript library to connect your dotCMS pages with the Universal Visual Editor (UVE) and enable content authors to edit pages in real time.

The UVE SDK is designed as a flexible, high-level library that provides core functionality for custom implementations across any JavaScript project. While you can use this SDK directly in any environment, we also offer framework-specific libraries for popular JavaScript frameworks like Angular and React. These specialized libraries build upon the UVE SDK to provide optimized, streamlined integration with their respective frameworks, reducing development time and ensuring best practices.

Whether you're building a custom solution or working with a specific framework, the UVE SDK provides a robust foundation for creating editable pages with dotCMS.

## Table of Contents

- [Installation](#installation)
- [Examples](#examples)
- [Browser Compatibility](#browser-compatibility)
- [API Reference](#api-reference)
- [1. Editor Initialization](#1-editor-initialization)
- [2. Core UVE Functionality](#2-core-uve-functionality)
- [3. Content Editing](#3-content-editing)
- [4. Navigation & Layout](#4-navigation--layout)
- [5. Communication Utilities](#5-communication-utilities)
- [Contributing](#contributing)
- [Licensing](#licensing)

## Installation

The UVE SDK is automatically included in DotCMS installations. For external usage:
Expand All @@ -17,6 +35,26 @@ yarn add @dotcms/uve-sdk
pnpm add @dotcms/uve-sdk
```

## Examples

To help you get started with the UVE SDK, we provide several example projects demonstrating integration with different frameworks:

- [Angular Example](https://github.com/dotCMS/core/tree/main/examples/angular) - Integration with Angular
- [Next.js Example](https://github.com/dotCMS/core/tree/main/examples/nextjs) - Integration with Next.js
- [Astro Example](https://github.com/dotCMS/core/tree/main/examples/astro) - Integration with Astro

These examples show how to initialize the UVE, handle content editing, and implement navigation synchronization within each framework's specific patterns and lifecycle methods.

## Browser Compatibility

The DotCMS UVE SDK is compatible with:

| Browser | Supported Versions |
|---------|-------------------|
| Chrome | Latest 3 versions |
| Firefox | Latest 3 versions |
| Edge | Latest 3 versions |

## API Reference

### 1. Editor Initialization
Expand Down
Loading