Default hotkeys for moving / resizing windows

Logger object. Can be accessed to set default log level.

Windows captured by this filter are automatically tiled and managed

Number of pixels between tiled windows

Size of the on-screen margin to place off-screen windows

Adds a window to layout and tiles.

• add_window - An hs.window

• The hs.spaces space for added window or nil if window not added.

Removes current window from column and places it to the right

• None

Binds hotkeys for PaperWM

• mapping - A table containing hotkey modifer/key details for the following items:
  • stop_events - Stop automatic tiling
  • refresh_windows - Refresh windows from window filter list
  • toggle_floating - Add or remove window from floating layer
  • focus_left - Focus window to left of current window
  • focus_right - Focus window to right of current window
  • focus_up - Focus window to up of current window
  • focus_down - Focus window to down of current window
  • swap_left - Swap positions of window to the left and current window
  • swap_right - Swap positions of window to the right and current window
  • swap_up - Swap positions of window above and current window
  • swap_down - Swap positions of window below and current window
  • center_window - Move current window to center of screen
  • full_width - Resize width of current window to width of screen
  • cycle_width - Toggle through preset window widths
  • cycle_height - Toggle through preset window heights
  • reverse_cycle_width - Toggle through preset window widths
  • reverse_cycle_height - Toggle through preset window heights
  • slurp_in - Move current window into column to the left
  • barf_out - Remove current window from column and place to the right
  • switch_space_l - Switch to Mission Control space to the left
  • switch_space_r - Switch to Mission Control space to the right
  • switch_space_1 - Switch to Mission Control space 1
  • switch_space_2 - Switch to Mission Control space 2
  • switch_space_3 - Switch to Mission Control space 3
  • switch_space_4 - Switch to Mission Control space 4
  • switch_space_5 - Switch to Mission Control space 5
  • switch_space_6 - Switch to Mission Control space 6
  • switch_space_7 - Switch to Mission Control space 7
  • switch_space_8 - Switch to Mission Control space 8
  • switch_space_9 - Switch to Mission Control space 9
  • move_window_1 - Move current window to Mission Control space 1
  • move_window_2 - Move current window to Mission Control space 2
  • move_window_3 - Move current window to Mission Control space 3
  • move_window_4 - Move current window to Mission Control space 4
  • move_window_5 - Move current window to Mission Control space 5
  • move_window_6 - Move current window to Mission Control space 6
  • move_window_7 - Move current window to Mission Control space 7
  • move_window_8 - Move current window to Mission Control space 8
  • move_window_9 - Move current window to Mission Control space 9

Moves current window to center of screen, without resizing.

• None

Resizes current window by cycling through width or height ratios.

• direction - One of Direction { WIDTH, HEIGHT }
• cycle_direction - One of Direction { ASCENDING, DESCENDING }

Change focus to a nearby window

• direction - One of Direction { LEFT, RIGHT, DOWN, UP }
• focused_index - The coordinates of the current window in the tiling layout

• A boolean. True if a new window was focused. False if no nearby window was found in that direction.

Switch to a Mission Control space to the left or right of current space

• direction - One of Direction { LEFT, RIGHT }

Resizes a window without triggering a windowMoved event

• window - An hs.window
• frame - An hs.geometry.rect for the windows new frame size.

Moves the current window to a new Mission Control space

• index - The space number
• window - Optional window to move

Searches for all windows that match window filter.

• None

• A boolean, true if the layout needs to be re-tiled, false if no change.

Remove window from tiling layout

• remove_window - A hs.window to remove from tiling layout
• skip_new_window_focus - A boolean. True if a nearby window should not be focused after current window is removed.

• The hs.spaces space for removed window.

Resizes current window's width to width of screen, without adjusting height.

• None

Moves current window into column of windows to the left

• None

Start automatic tiling of windows

• None

• The PaperWM object

Stop automatic tiling of windows

• None

• The PaperWM object

Swaps window postions between current window and window in specified direction.

• direction - One of Direction { LEFT, RIGHT, DOWN, UP }

Switch to a Mission Control space

• index - The space number

Tile a column of windows

• windows - A list of hs.windows.
• bounds - An hs.geometry.rect. The area for this column to fill.
• h - The height for each window in column.
• w - The width for each window in column.
• id - A hs.window.id() for a specific window in column.
• h4id - The height for a window matching id in column.

• The width of the column

• The h, w, id, and h4id parameters are optional. The height and width of all windows will be calculated and set to fill column bounds.
• If bounds width is not specified, all windows in column will be resized to width of first window.

Tile all windows within a space

• space - A hs.spaces space.

Add or remove focused window from the floating layer and retile the space

• None