Skip to content

Commit 2161691

Browse files
committed
Create release_notes_3.1.0_beta2.md
1 parent 451e8fa commit 2161691

1 file changed

Lines changed: 88 additions & 0 deletions

File tree

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
## ESP3D-WEBUI
2+
3+
## v3.1.0 - Public Beta 2
4+
5+
6+
*2026-03-29 to 2026-04-17*
7+
8+
This release enhances web connectivity with secure protocol support, improves resource management through compression, and adds flexibility for language and theme customization.
9+
10+
## 📋 Table of Contents
11+
12+
- [🚀 New Features](#new-features)
13+
- [ - HTTPS and WSS Protocol Support](#https-and-wss-protocol-support)
14+
- [ - Language and Theme Pack Manifests](#language-and-theme-pack-manifests)
15+
- [ - Configurable Content Visibility](#configurable-content-visibility)
16+
- [ - Brotli Compression Support](#brotli-compression-support)
17+
- [ - Theme Support for Custom Fonts and JavaScript](#theme-support-for-custom-fonts-and-javascript)
18+
- [🐛 Bug Fixes](#bug-fixes)
19+
- [💪 Improvements](#improvements)
20+
- [📝 Other Changes](#other-changes)
21+
22+
<a id="new-features"></a>
23+
24+
## 🚀 New Features
25+
26+
<a id="https-and-wss-protocol-support"></a>
27+
28+
### HTTPS and WSS Protocol Support
29+
30+
Added automatic detection and support for secure HTTPS and WebSocket Secure (WSS) connections when available. The webui now seamlessly switches to encrypted communication protocols for enhanced security.
31+
32+
<a id="language-and-theme-pack-manifests"></a>
33+
34+
### Language and Theme Pack Manifests
35+
36+
Implemented manifest system for language packs and theme packs, enabling better organization and management of multi-language support and custom UI themes.
37+
38+
<a id="configurable-content-visibility"></a>
39+
40+
### Configurable Content Visibility
41+
42+
Added ability to select visibility on startup for each extra content item individually, providing more granular control over the interface layout on first load.
43+
44+
<a id="brotli-compression-support"></a>
45+
46+
### Brotli Compression Support
47+
48+
Integrated brotli compression support into the build toolchain for more efficient package compression, reducing the size of web assets delivered to the pendant.
49+
50+
<a id="theme-support-for-custom-fonts-and-javascript"></a>
51+
52+
### Theme Support for Custom Fonts and JavaScript
53+
54+
Themes can now include custom fonts and JavaScript, allowing much richer visual and behavioral customization. All theme assets and exports are made available to extensions, so extension developers can rely on the active theme's fonts, styles, and scripts without bundling them separately.
55+
56+
<a id="bug-fixes"></a>
57+
58+
## 🐛 Bug Fixes
59+
60+
- **WebSocket Connection Without Port Specification**: Fixed an issue where WebSocket connections would fail when no explicit port was provided. The pendant now correctly handles default port assignment.
61+
62+
<a id="improvements"></a>
63+
64+
## 💪 Improvements
65+
66+
- **Package Size Calculation**: Updated size calculation logic to account for brotli-compressed packages, providing more accurate estimates of web asset sizes during the build process.
67+
- **CI/CD Pipeline Updates**: Updated build CI workflow to support the new compression and manifest systems.
68+
69+
<a id="other-changes"></a>
70+
71+
## 📝 Other Changes
72+
73+
- **Documentation Cleanup**: Removed working documentation files as part of repository maintenance.
74+
- **Package Rebuild**: Rebuilt packages to include the latest secure protocol support.
75+
- **Theme Documentation** (`docs/themes.md`): Complete documentation covering the new bundle format and all theme capabilities, with application examples:
76+
- *Example 1 — Custom font* (offline base64, online via `@import`, multi-format self-hosted fallback)
77+
- *Example 2 — Variables and JS coupled: dynamic accent colour* (declarative variables, runtime JS, CDN animation library via `scripts`)
78+
- *Example 3 — Replace the ESP3D logo* (CSS-only colour override, full SVG replacement via JS with `MutationObserver`)
79+
- *CSS-only legacy theme* and *full bundle theme* reference examples
80+
- **Language Pack Documentation** (`docs/languagepack.md`): Documentation updated to cover the new `_manifest` fields, including custom font loading for scripts requiring specific typefaces (Arabic, CJK, etc.) and RTL reading direction mode (`rtl: true` sets `dir="rtl"` on `<html>` and propagates into extension iframes automatically), with application examples:
81+
- *Example 1 — RTL language (Arabic) with online font*
82+
- *Example 2 — CJK language (Japanese) with offline font*
83+
- *Example 3 — Standard LTR language (no font needed)*
84+
- **Extension Developer Documentation** (`docs/extensions.md`): New complete reference guide for creating extensions, covering: file format and naming, manifest fields (target, icons, version filtering), `postMessage` communication, sending GCode/ESP commands, HTTP requests (query/upload/download) through the WebUI, UI helpers (toast, sound, modal), WebUI information (capabilities, translation, icon), persistent settings, inter-extension communication, and using WebUI CSS components inside an extension.
85+
86+
87+
---
88+
*Generated by Release Agent on 2026-04-24 12:01*

0 commit comments

Comments
 (0)