From 5833f0f109ee8bdee2507f16fc230de3f03fd3f0 Mon Sep 17 00:00:00 2001 From: Lea Anthony Date: Tue, 5 Sep 2023 18:26:10 +1000 Subject: [PATCH] More docs. --- mkdocs-website/Taskfile.yml | 24 +++++++++++++++++++ mkdocs-website/docs/development/status.md | 21 ++++++++--------- mkdocs-website/docs/stylesheets/extra.css | 8 +++++-- mkdocs-website/mkdocs.yml | 8 +++++++ mkdocs-website/requirements.insiders.txt | Bin 0 -> 1680 bytes mkdocs-website/requirements.txt | Bin 617 -> 1482 bytes v3/pkg/application/options_win.go | 27 ++++++++++++++++++---- 7 files changed, 71 insertions(+), 17 deletions(-) create mode 100644 mkdocs-website/requirements.insiders.txt diff --git a/mkdocs-website/Taskfile.yml b/mkdocs-website/Taskfile.yml index a94af273c..3d8aa8b14 100644 --- a/mkdocs-website/Taskfile.yml +++ b/mkdocs-website/Taskfile.yml @@ -12,6 +12,22 @@ tasks: cmds: - python -m pip install -r requirements.txt --user + setup:insiders: + summary: Setup the project (insiders) + preconditions: + - sh: python{{exeExt}} --version + msg: "Looks like Python isn't installed. Python is required to build the documentation: https://www.python.org/downloads/" + cmds: + - python -m pip install -r requirements.insiders.txt --user + + upgrade:insiders: + summary: Upgrade the project (insiders) + preconditions: + - sh: python{{exeExt}} --version + msg: "Looks like Python isn't installed. Python is required to build the documentation: https://www.python.org/downloads/" + cmds: + - python -m pip install -r requirements.insiders.txt --upgrade --user + build: summary: Builds the documentation preconditions: @@ -27,3 +43,11 @@ tasks: msg: "Looks like mkdocs isn't installed. Run `wails3 task setup` or `task setup` in the documentation directory to install it." cmds: - mkdocs serve + + serve:insiders: + summary: Builds the documentation and serves it locally + preconditions: + - sh: mkdocs --version + msg: "Looks like mkdocs isn't installed. Run `wails3 task setup` or `task setup` in the documentation directory to install it." + cmds: + - mkdocs serve --config-file mkdocs.insiders.yml diff --git a/mkdocs-website/docs/development/status.md b/mkdocs-website/docs/development/status.md index 4d8347b5a..18f38cdf7 100644 --- a/mkdocs-website/docs/development/status.md +++ b/mkdocs-website/docs/development/status.md @@ -1,6 +1,6 @@ # Status -Status of features in v3. +Status of features in v3. !!! note @@ -11,7 +11,6 @@ Status of features in v3. - Linux is not yet up to feature parity with Windows/Mac - ## Application Application interface methods @@ -349,19 +348,19 @@ TODO: ## Windows Specific -- [ ] Translucency +- [x] Translucency - [x] Custom Themes ### Windows Options -| Feature | Default | Notes | -|-----------------------------------|---------|---------------------------------------------| -| BackdropType | | | -| DisableIcon | | | -| Theme | | | -| CustomTheme | | | -| DisableFramelessWindowDecorations | | | -| WindowMask | nil | Makes the window the contents of the bitmap | +| Feature | Default | Notes | +|-----------------------------------|---------------|---------------------------------------------| +| BackdropType | Solid | | +| DisableIcon | false | | +| Theme | SystemDefault | | +| CustomTheme | nil | | +| DisableFramelessWindowDecorations | false | | +| WindowMask | nil | Makes the window the contents of the bitmap | ## Linux Specific diff --git a/mkdocs-website/docs/stylesheets/extra.css b/mkdocs-website/docs/stylesheets/extra.css index 296850e20..0426eb97b 100644 --- a/mkdocs-website/docs/stylesheets/extra.css +++ b/mkdocs-website/docs/stylesheets/extra.css @@ -7,7 +7,7 @@ --md-primary-fg-color: #2a2a2a; --md-default-bg-color: #191919; --md-footer-bg-color--dark: #2a2a2a; - --md-default-fg-color: #cccccc; + --md-default-fg-color: #e0e0e0; } .md-header__button.md-logo img, .md-header__button.md-logo svg { @@ -15,4 +15,8 @@ display: block; height: 2rem; width: auto; -} \ No newline at end of file +} + +.md-typeset { + font-weight: 100; +} diff --git a/mkdocs-website/mkdocs.yml b/mkdocs-website/mkdocs.yml index f991499d1..0dfebe14b 100644 --- a/mkdocs-website/mkdocs.yml +++ b/mkdocs-website/mkdocs.yml @@ -1,9 +1,13 @@ site_name: "alpha" site_description: The Wails Project - Build beautiful cross-platform applications using Go +repo_url: https://github.com/wailsapp/wails +edit_uri: edit/v3-alpha/mkdocs-website/docs/ theme: name: material custom_dir: overrides logo: assets/images/wails-logo-horizontal-dark.svg + icon: + repo: fontawesome/brands/github favicon: assets/images/favicon.svg features: - navigation.tabs @@ -18,11 +22,13 @@ theme: - search.suggest - search.highlight + - search.share - content.tabs.link - content.tabs.annotation - content.tabs.copy - content.code.copy + - content.action.edit language: en palette: # Palette toggle for light mode @@ -86,6 +92,8 @@ markdown_extensions: alternate_style: true - pymdownx.highlight: anchor_linenums: true + - pymdownx.tasklist: + custom_checkbox: true - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.details diff --git a/mkdocs-website/requirements.insiders.txt b/mkdocs-website/requirements.insiders.txt new file mode 100644 index 0000000000000000000000000000000000000000..8a109b995789dd264cf553b63cd428408c107b85 GIT binary patch literal 1680 zcmaKsNsrS&5QXcE#DCz9O!i3z32EShgg`>##0h0_7I2)9I5QJ|Jn+4$?l^M*wQMI{ zuU@@cy8rxsXH%P5X_dWU_3f4Q()+nRbIa6D*4W0Dd@DQJj_=-vjvrp|eG`5T(;=ZZ ziLndc0Nj|T&kEd{xChuu(1q2o9&F2AMWkQOB0chxrf%|*b#6bLdBT2=XPj(1e8n<# z9(i}MO5sgH9Eqoh70;Zw!ib@bu(CC|6-3$c6lUSOf5?zy|*stvSos{lI>0-`Ve9ETK?7l|7;>I;E($&L_(!JPy=lLA-~n zh(ZOkYI}_ce&r=h)}DFP;V*bBsgxAv{0FXm>-|~rUhtG)b0w8!ju&d?R6JWpSfl^j zq*d0!qMijk*^%GY>(_V;S@&doa!k#?(5;%Zb$QCBOv8J_ugYH79Z$q~Nk(VP(`ui5;W7gbf zVPYe8Z|LP1&mn8X8rX!L(%%bmo)N9j{)~4o_2B<%N@hh>2u+&8whvJ~&CMQOou_H4 z?<#dWrZpp!hh|lL>ZPV#y^M1u4o&(IHl3@C=v{S4Jrru`XKG8P8?TYD5lftL%5`#9 z)K}V@q&nvB225nX2P2l4_5$p`vK4Q5M>c2gtU7ddrLwiL#hXuU0e|Ei_g{NM>gI_# zme#NKmh<<~*`!cxt;#bTIGzs Y4lZ_a#GUW}cf*9Ny>n3mb-#`B7Z7>+Z~y=R literal 0 HcmV?d00001 diff --git a/mkdocs-website/requirements.txt b/mkdocs-website/requirements.txt index bfed5e978310b35d3237f963f9e230309d69717f..05dbce5b9d3aa8dfbac6688ebb503ae13d6ec36d 100644 GIT binary patch literal 1482 zcmaKsOK%fF5QO`T#7|k|M@Yhf1Gz*(AR%$$gp8jH>$TZkCpJGGsIPm*V_%}xdXwqu zs_LGe`S8?3gKzK!*^(|2z-j=wqMCkB2lrY@oD z#5fY)RJc366Fq_3NVgN)Qs~NBv39oAS|g=D&VnEE@H9$UMCbO)neVke)_a#?JLSSM za~`rsisJA#A$sYd*yx>07YqzVVQm}LR!L>6FKmH|zGNS3#RprcJ20St(m1(%^yn8m z39}JL>nJKgYbrb)sFmN!Ypya@KWe?TpIV=sBjJ#o#*Xq8JB8{y=Ogl28J+sFklyo! zBB)@dx0i_Er!Fwrd*)$>zba#;PT?@uKXvb0-=DR97kZb%=1x*&)(batbv#GkDjNI0 zOW@N(G@y$M?!(5@*TT+N+F7AG;0+Dr1-NLl>A6x)2iyf*I+>#zbbs_@Xwd z2epzDPRK%xoExw)Q*g%lVCL4sETuUlOzhmPFxl0~Sz=CJsuteJj(Sh_Tl>KIKDj!v zqP@SE_ew6K=D0b^-NKoT3Bc<&`=H7F2X6* zdG1Sb27*~VCfD3YQ5TqLQUn$C^;f+kp8Lx@1WU|8c&0nOw3(zh3G8su&o?I7OMB9b lM;ye-BmbbTHhOB^DbsTtjyO%v;vO_18&$eXJz)2X%739k*m(c| literal 617 zcmZ8fyKdYt5bXIcBJ}e4T(C&WAO;M$a%JpMdlG$og{16LzCJ@KO#)n@9nQ|o?%sF0 zuvMy;9e(1%v=(z+Z4PT3l^QGD3(X0r0j=!^`6zop3#H7Z@gX^~<~Jv$2HDG2XlwLM zsk7|lqtL;IM2?hdtuXN=@cMy)#%oB60)>Ym?Lg!jNK>ny2M}?Ci zI6WcX>3_K4dtskV@Oxv2okh|&nvI`fgrulZK&6iS0EI|p$&q!fyE;g;RIXUtWD-Qs z(qihDZFcMn0Bqq@Wj0qQ{MWEWruy`2<+N35ZH-%5f^Q~x;&}Tp&#-yf-o8EmRO$p$ z?b*oLclMv}g%Gu3iD@dvA?dISC7$^X)q3Q!JmVcc`N%ZX(`18Z%nV6U{~_7%=e}R8 WT&&4ja~Y0Qqxhntmnp#N5dQ-j(z@UP diff --git a/v3/pkg/application/options_win.go b/v3/pkg/application/options_win.go index f8d2950ad..f5562a521 100644 --- a/v3/pkg/application/options_win.go +++ b/v3/pkg/application/options_win.go @@ -32,39 +32,58 @@ const ( type WindowsWindow struct { // Select the type of translucent backdrop. Requires Windows 11 22621 or later. + // Only used when window's `BackgroundType` is set to `BackgroundTypeTranslucent`. + // Default: Auto BackdropType BackdropType + // Disable the icon in the titlebar + // Default: false DisableIcon bool - // Theme. Defaults to SystemDefault which will use whatever the system theme is. The application will follow system theme changes. + + // Theme (Dark / Light / SystemDefault) + // Default: SystemDefault - The application will follow system theme changes. Theme Theme - // Custom colours for dark/light mode + + // Specify custom colours to use for dark/light mode + // Default: nil CustomTheme *ThemeSettings // Disable all window decorations in Frameless mode, which means no "Aero Shadow" and no "Rounded Corner" will be shown. // "Rounded Corners" are only available on Windows 11. + // Default: false DisableFramelessWindowDecorations bool // WindowMask is used to set the window shape. Use a PNG with an alpha channel to create a custom shape. - WindowMask []byte + // Default: nil + WindowMask []byte + + // WindowMaskDraggable is used to make the window draggable by clicking on the window mask. + // Default: false WindowMaskDraggable bool // WebviewGpuIsDisabled is used to enable / disable GPU acceleration for the webview + // Default: false WebviewGpuIsDisabled bool // ResizeDebounceMS is the amount of time to debounce redraws of webview2 // when resizing the window + // Default: 0 ResizeDebounceMS uint16 // Disable the menu bar for this window + // Default: false DisableMenu bool - // Event mapping for the window + // Event mapping for the window. This allows you to define a translation from one event to another. + // Default: nil EventMapping map[events.WindowEventType]events.WindowEventType // HiddenOnTaskbar hides the window from the taskbar + // Default: false HiddenOnTaskbar bool // EnableSwipeGestures enables swipe gestures for the window + // Default: false EnableSwipeGestures bool }