Skip to content

Commit 6f51124

Browse files
update README docs / branch differences
1 parent c93cf12 commit 6f51124

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,34 @@
33
Made for use with [DockAltTab](https://dockalttab.netlify.app) (adds window previews to the MacOS dock)... it does so by sending AppleScript commands to AltTab.
44

55

6-
# [AppleScript Dictionary](https://github.com/steventheworker/alt-tab-macos/blob/scriptable/AltTab.sdef)
7-
- coming soon...
6+
# [AppleScript Dictionary / Docs](https://github.com/steventheworker/alt-tab-macos/blob/scriptable/AltTab.sdef)
7+
#### <u>basic commands</u>
8+
- **hide**: Hide Overlay/UI.
9+
- **show**: Show all app windows. (Regular AltTab shortcut)
10+
- **showApp**: Show specific app's windows. (ignores blacklist)
11+
- appBID: The bundle identifier of the app whose windows you want to show.
12+
- x: X-coordinate (optional)
13+
- y: Y-coordinate (optional)
14+
- dockPos: (optional) Helps AltTab know where previews will be positioned / clip, (especially for docks on the right (preview 'panel' width is relevant))
15+
- **trigger**: Goes to the next window, without showing Overlay/UI.
16+
17+
<details>
18+
<summary><u>Miscellaneous / DockAltTab commands</u></summary>
19+
20+
#### <u>Miscellaneous / DockAltTab commands</u>
21+
- **appSetting**: Read settings applied on showApp previews.
22+
- named: Name of the setting. (appsToShow, showHiddenWindows, showFullscreenWindows, showMinimizedWindows, spacesToShow, screensToShow, showTabsAsWindows)
23+
- **countMinimizedWindowsCurrentSpace**: The number of (minimized) windows for an app (FROM the current space, especially useful for keeping minimized windows contained in the space they were originally minimized in).
24+
- appBID
25+
- **countWindows**: The number of windows for an app (in all spaces).
26+
- appBID
27+
- **countWindowsCurrentSpace**: The number of windows for an app (in the current space, especially useful for counting hidden windows (otherwise especially hard to do for the current space)).
28+
- appBID
29+
- **deminimizeFirstMinimizedWindowFromCurrentSpace**: Deminimize app's first minimized window originally minimized on the current space.
30+
- appBID
31+
- **keyState**: Whether a certain key is being pressed (see if AltTab overlay is absorbing modifier keys)
32+
- key: Name of the key you want to check the state of.
33+
</details>
834

935
### example usages:
1036
```tell application "AltTab" to showApp appBID "com.apple.Safari"```
@@ -20,6 +46,7 @@ Some other changes I made out of personal preference / hesitation to submit a pu
2046
- [Screenhint]() floating windows
2147
- Preview button order: Exit is 1st, Quit is last (opposed to vice-versa)
2248
- faster fading (if fading enabled): 111ms for DockAltTab previews, 333ms for regular previews
49+
- auto reopen controls after closing window (allows click spam to repeat close window quickly)
2350

2451
# Contributing
2552
[How to build AltTab on Xcode](https://www.youtube.com/watch?v=iitm_r0BBck) --this youtube video shows how to build the official AltTab from lwouis (but this branch has been normalized to be able to build on m-series/apple silicon, so this may not be necessary)

0 commit comments

Comments
 (0)