Skip to content

Commit 718083f

Browse files
Felix Cantetclaude
andcommitted
Update documentation for v1.3.0
- Bump package version from 1.2.0 to 1.3.0 - Update README.md with current sample structure - Replace outdated references to BasicWebView and UIToolkit Demo - Add comprehensive descriptions for all six samples (01-06) - Organize samples by difficulty with estimated learning times - Add CHANGELOG entry for v1.3.0 - Update README footer with current version and date Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent eac65ba commit 718083f

3 files changed

Lines changed: 87 additions & 29 deletions

File tree

WebViewToolkit/CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.3.0] - 2026-01-29
9+
10+
### Changed
11+
12+
- Updated README documentation to reflect current sample structure
13+
- Removed references to outdated BasicWebView and UIToolkit Demo samples
14+
- Added comprehensive descriptions for all six current samples (01-06)
15+
- Organized samples by difficulty level with estimated learning times
16+
- Improved documentation clarity and accuracy
17+
818
## [1.2.0] - 2026-01-29
919

1020
### Added

WebViewToolkit/README.md

Lines changed: 76 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# WebView Toolkit for Unity - Package Documentation
22

3-
**Version 1.0.0**
3+
**Version 1.3.0**
44

55
Native WebView2 integration for Unity with DirectX 11/12 support. This package provides high-performance, off-screen rendering of modern web content directly to Unity textures.
66

@@ -758,7 +758,7 @@ webView.Navigate(fileUrl);
758758

759759
## Samples
760760

761-
The package includes two comprehensive samples demonstrating different integration approaches.
761+
The package includes six progressive samples that teach you WebViewToolkit from beginner to intermediate level.
762762

763763
### Importing Samples
764764

@@ -767,41 +767,89 @@ The package includes two comprehensive samples demonstrating different integrati
767767
3. Expand the **Samples** section
768768
4. Click **Import** next to the desired sample
769769

770-
### BasicWebView Sample
770+
### Learning Path
771771

772-
**Location:** `Samples~/BasicWebView/`
772+
We recommend completing the samples in order for the best learning experience:
773773

774-
Demonstrates basic WebViewBehaviour usage with traditional Unity UI.
774+
#### 01 - Hello WebView
775+
**Difficulty:** Beginner | **Time:** 5 minutes
776+
777+
Your first WebView! Shows the minimum code needed to display a web page in Unity using UIToolkit.
775778

776779
**What you'll learn:**
777-
- Using WebViewBehaviour component
778-
- Basic navigation controls (Go, Back, Forward, Refresh)
779-
- Handling navigation events
780-
- URL input with Enter key support
781-
- Status display
780+
- Creating a WebViewElement in UXML
781+
- Basic scene setup with UIDocument
782+
- Initial URL configuration
783+
784+
#### 02 - Navigation
785+
**Difficulty:** Beginner | **Time:** 15 minutes
782786

783-
**Key Files:**
784-
- `BasicWebViewSample.cs` - Main sample script
785-
- `BasicWebViewSample.unity` - Demo scene
786-
- `README.md` - Sample-specific instructions
787+
Learn how to navigate between pages, manage history, and respond to navigation events.
787788

788-
### UIToolkit Demo Sample
789+
**What you'll learn:**
790+
- Programmatic navigation with `Navigate()`
791+
- Back/Forward history with `GoBack()`/`GoForward()`
792+
- Checking navigation state with `CanGoBack()`/`CanGoForward()`
793+
- Handling `NavigationCompleted` events
794+
- Enabling/disabling UI based on state
789795

790-
**Location:** `Samples~/UIToolkitDemo/`
796+
#### 03 - JavaScript Bridge
797+
**Difficulty:** Intermediate | **Time:** 30 minutes
791798

792-
Demonstrates WebViewElement and WebViewPanel with UIToolkit.
799+
Master two-way communication between C# and JavaScript. Essential for building interactive web-based UIs.
793800

794801
**What you'll learn:**
795-
- Creating WebViewElement programmatically
796-
- Using WebViewPanel for full browser UI
797-
- Dynamic layout with FlexLayout
798-
- UIToolkit event handling
799-
- Address bar and navigation controls
802+
- Calling JavaScript from C# with `ExecuteScript()`
803+
- Receiving messages from JavaScript via `window.chrome.webview.postMessage()`
804+
- JSON serialization for structured data
805+
- Building game UIs that respond to player actions
806+
- Event-driven communication patterns
807+
808+
#### 04 - Dynamic HTML
809+
**Difficulty:** Intermediate | **Time:** 30 minutes
810+
811+
Generate web content dynamically from C# data. Perfect for inventory systems, quest logs, and leaderboards.
812+
813+
**What you'll learn:**
814+
- Loading HTML strings with `NavigateToString()`
815+
- Building HTML programmatically with C# templates
816+
- Real-time content updates
817+
- Creating data-driven UIs (inventory, quest log, settings)
818+
- HTML templating best practices
819+
820+
#### 05 - Interactive Input
821+
**Difficulty:** Intermediate | **Time:** 20 minutes
822+
823+
Understand how WebView handles mouse and keyboard input, and how to interact with web forms.
824+
825+
**What you'll learn:**
826+
- How WebViewElement forwards mouse events automatically
827+
- Understanding normalized [0-1] coordinate system
828+
- Interacting with web forms (inputs, buttons, checkboxes)
829+
- Mouse hover effects and wheel scrolling
830+
- Debugging input coordinate mapping
831+
832+
#### 06 - Multiple WebViews
833+
**Difficulty:** Intermediate | **Time:** 25 minutes
834+
835+
Learn to manage multiple WebView instances simultaneously for dashboards or split-screen browsers.
836+
837+
**What you'll learn:**
838+
- Creating multiple WebViewElements in one scene
839+
- Proper lifecycle management (creation and disposal)
840+
- Independent navigation for each instance
841+
- Performance considerations and optimization
842+
- Memory management best practices
843+
844+
### Sample Structure
845+
846+
Each sample includes:
847+
- **Unity Scene** - Ready-to-play demo scene
848+
- **C# Scripts** - Thoroughly commented code
849+
- **UXML/USS Files** - UIToolkit layouts and styles
850+
- **README.md** - Detailed walkthrough and explanations
800851

801-
**Key Files:**
802-
- `WebViewUIToolkitDemo.cs` - Main sample script
803-
- `WebViewUIToolkitDemo.unity` - Demo scene
804-
- `README.md` - Sample-specific instructions
852+
For the complete samples overview and additional learning resources, see `Samples~/README.md` after importing.
805853

806854
---
807855

@@ -1163,6 +1211,6 @@ webView.MessageReceived += (msg) => {
11631211

11641212
---
11651213

1166-
**Package Version:** 1.0.0
1167-
**Last Updated:** 2026-01-26
1214+
**Package Version:** 1.3.0
1215+
**Last Updated:** 2026-01-29
11681216
**License:** MIT

WebViewToolkit/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "com.webviewtoolkit.core",
3-
"version": "1.2.0",
3+
"version": "1.3.0",
44
"displayName": "WebView Toolkit",
55
"description": "Native WebView2 integration for Unity UIToolkit with DirectX 11/12 support. Renders web content to textures for use in Unity UI.",
66
"unity": "2021.3",

0 commit comments

Comments
 (0)