Update documentation

forked-project · Apr 18, 2024 · 1134c81 · 1134c81
1 parent c985bd1
commit 1134c81
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,27 @@
 # Changelog
 
+
+## 5.1
+
+_Released 07/04/2024_
+
+### ⚡ Features
+
+- `All` Clear all the cookies (including HttpOnly) with `window.clear_cookies()`. Sponsored by [TBS](https://tbsit360.com/)
+- `All` pywebview event handler can now have an optional `window` parameter that holds an instance of the `Window` object that triggered the event.
+
+### 🚀 Improvements
+
+- `Windows` Add window shadow with `webview.create_window(..., shadow=True)`. Thanks @yllhwa
+
+### 🐞 Bug fixes
+
+- `Cocoa` Fix showing window
+- `QT` Fix fetching cookies in private mode
+- `QT` Fix blank screen in Pop! OS. Thanks @ysfchn.
+- `GTK` Fix frameless windows having a hard-coded minimum size. Thanks @coffeejunk
+
+
 ## 5.0.5
 
 _Released 07/03/2024_

diff --git a/docs/README.md b/docs/README.md
@@ -8,7 +8,7 @@ footer: BSD Licensed | Copyright © 2014–present Roman Sirokov
 ---
 
 <div class='center version'>
-Current version: <strong>5.0.5</strong><br/>
+Current version: <strong>5.1</strong><br/>
 <a href='/changelog.html'>What's new</a>
 </div>
 

diff --git a/docs/guide/api.md b/docs/guide/api.md
@@ -7,7 +7,7 @@
 webview.create_window(title, url=None, html=None, js_api=None, width=800, height=600,
                       x=None, y=None, screen=None, resizable=True, fullscreen=False,
                       min_size=(200, 100), hidden=False, frameless=False,
-                      easy_drag=True, focus=True, minimized=False, maximized=False
+                      easy_drag=True, shadow=False, focus=True, minimized=False, maximized=False,
                       on_top=False, confirm_close=False, background_color='#FFFFFF',
                       transparent=False, text_select=False, zoomable=False,
                       draggable=False, server=http.BottleServer, server_args={},
@@ -31,6 +31,7 @@ Create a new _pywebview_ window and returns its instance. Can be used to create
 * `hidden` - Create a window hidden by default. Default is False
 * `frameless` - Create a frameless window. Default is False.
 * `easy_drag` - Easy drag mode for frameless windows. Window can be moved by dragging any point. Default is True. Note that easy_drag has no effect with normal windows. To control dragging on an element basis, see [drag area](/guide/api.html#drag-area) for details.
+* `shadow` - Add window shadow. Default is False. _Windows only_.
 * `focus` - Create a non-focusable window if False. Default is True.
 * `minimized` - Display window minimized
 * `maximized` - Display window maximized