v3.0.0-alpha.4

2026-08-05 13:53:43 -07:00 · 2024-02-01 21:09:03 +11:00
parent 6e2bbe31ac
commit 1ec3b4ecab
8 changed files with 109 additions and 26 deletions
@@ -0,0 +1,58 @@
+# Runtime
+
+The Wails runtime is the standard library for Wails applications. It provides a number of features that may
+be used in your applications, including:
+
+- Window management
+- Dialogs
+- Browser integration
+- Clipboard
+- Frameless dragging
+- Tray icons
+- Menu management
+- System information
+- Events
+- Calling Go code
+- Context Menus
+- Screens
+- WML (Wails Markup Language)
+
+The runtime is required for integration between Go and the frontend. There are 2 ways to integrate the runtime:
+
+- Using the `@wailsio/runtime` package
+- Using a pre-built version of the runtime
+
+## Using the `@wailsio/runtime` package
+
+The `@wailsio/runtime` package is a JavaScript package that provides access to the Wails runtime. It is used in by all
+the standard templates and is the recommended way to integrate the runtime into your application. By using the package,
+you will only include the parts of the runtime that you use.
+
+The package is available on npm and can be installed using:
+
+```shell
+npm install --save @wailsio/runtime
+```
+
+## Using a pre-built version of the runtime
+
+Some projects will not use a Javascript bundler and may prefer to use a pre-built version of the runtime. This is
+the default for the examples in `v3/examples`. The pre-built version of the runtime can be generated using the
+following command:
+
+```shell
+wails3 generate runtime
+```
+
+This will generate a `runtime.js` (and `runtime.debug.js`) file in the `frontend` directory of your project. 
+This file can be included in your assets directory and used in your application by adding it to your assets 
+directory (normally `frontend/dist`) and then including it in your HTML:
+
+```html
+<html>
+    <head>
+        <script src="/runtime.js"></script>
+    </head>
+    <!--- ... -->
+</>
+```
@@ -10,7 +10,23 @@ we are aiming to achieve. These are subject to change.

 ## Alpha milestones

-### Current: Alpha 4
+### Current: Alpha 5
+
+#### Goals
+
+- [ ] Get Linux to Alpha 4 parity 
+- [ ] Keyboard shortcuts
+  - Window Level shortcuts
+  - Application Level shortcuts (applies to all windows)
+  - Ensure Keydown/Keyup events are sent to JS if not handled by Go
+
+## Upcoming milestones
+
+## Alpha 6
+
+## Previous milestones
+
+### Alpha 4 - Completed 2024-02-01

 #### Goals

@@ -135,24 +151,6 @@ Examples:

 - [ ] All examples working on Linux

-## Upcoming milestones
-
-### Alpha 4
-
-#### Goals
-
-
-### Alpha 5
-
-#### Goals
-
- [ ] Keyboard shortcuts
-    - Window Level shortcuts
-    - Application Level shortcuts (applies to all windows)
-    - Ensure Keydown/Keyup events are sent to JS if not handled by Go
-
-## Previous milestones
-
 ### Alpha 2

 #### Goals