Skip to content

Add clearer documentation about how to query the system appearance mode #1307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ychin merged 1 commit into from
Oct 8, 2022
Merged

Add clearer documentation about how to query the system appearance mode #1307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions runtime/doc/autocmd.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1042,6 +1042,7 @@ OptionSet After setting an option. The pattern is
OSAppearanceChanged After changing the variable |v:os_appearance|.
This change happens only if the OS changes
its appearance and Vim is running with a GUI.
{only in MacVim GUI}

*QuickFixCmdPre*
QuickFixCmdPre Before a quickfix command is run (|:make|,
Expand Down
13 changes: 12 additions & 1 deletion runtime/doc/gui_mac.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ These are the non-standard commands that MacVim supports:
These are the non-standard events that MacVim supports:
|OSAppearanceChanged|

*macvim-internal-variables*
These are the non-standard internal variables that MacVim supports:
|v:os_appearance|

*macvim-find*
Whenever you search for something in Vim (e.g. using "/"), or hit <D-e> when
you have text selected, the search query is copied to the macOS "Find
Expand Down Expand Up @@ -319,7 +323,7 @@ this behaviour set MMLoginShellArgument to "--".
==============================================================================
4. MacVim appearance *macvim-appearance*

MacVim can be used in full screen mode, see 'fullscreen'.
For more configuration options, see the Preferences… → Appearance pane.

*macvim-appearance-mode* *macvim-dark-mode*
MacVim will by default use the system apperance mode (light or dark). However,
Expand All @@ -330,7 +334,14 @@ color scheme while system preferences are configured to use light mode. It's
also the recommended setting when title bar is configured to be "Transparent"
(see |MMTitlebarAppearsTransparent|).

If you would like to query the system apperance mode in Vim (e.g. to change
the color scheme at launch), see |v:os_appearance|. You can also use the
autocommand |OSAppearanceChanged| to be notified when the OS changes its
appearance.

*macvim-full-screen*
MacVim can be used in full screen mode, see 'fullscreen'.

There are two types of full screen modes. By default, MacVim uses macOS'
native full screen functionality, which creates a separate space in Mission
Control. MacVim also provides a non-native full screen mode, which can be set
Expand Down
1 change: 1 addition & 0 deletions runtime/doc/tags
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8389,6 +8389,7 @@ macvim-full-screen gui_mac.txt /*macvim-full-screen*
macvim-gestures gui_mac.txt /*macvim-gestures*
macvim-help-menu gui_mac.txt /*macvim-help-menu*
macvim-hints gui_mac.txt /*macvim-hints*
macvim-internal-variables gui_mac.txt /*macvim-internal-variables*
macvim-international gui_mac.txt /*macvim-international*
macvim-login-shell gui_mac.txt /*macvim-login-shell*
macvim-menus gui_mac.txt /*macvim-menus*
Expand Down