twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-08-02 05:01:51 -07:00
Code Issues Packages Projects Releases Wiki Activity

X.H.DynamicIcons: Update docs

Browse Source
This commit is contained in:
Tomas Janousek
2021-03-22 14:04:59 +00:00
parent 835aeaaffb
commit a0caca5edc
2 changed files with 43 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
XMonad/Doc/Extending.hs
View File

@@ -477,7 +477,8 @@ Here is a list of the modules found in @XMonad.Hooks@:
One-shot and permanent ManageHooks that can be updated at runtime. One-shot and permanent ManageHooks that can be updated at runtime.
* "XMonad.Hooks.DynamicIcons": * "XMonad.Hooks.DynamicIcons":
Dynamic Icons based on Windows in Workspaces Dynamically augment workspace names logged to a status bar via DynamicLog
based on the contents (windows) of the workspace.
* "XMonad.Hooks.DynamicLog": for use with 'XMonad.Core.logHook'; send * "XMonad.Hooks.DynamicLog": for use with 'XMonad.Core.logHook'; send
information about xmonad's state to standard output, suitable for information about xmonad's state to standard output, suitable for

62
XMonad/Hooks/DynamicIcons.hs
View File

@@ -10,7 +10,8 @@
-- Stability : unstable -- Stability : unstable
-- Portability : unportable -- Portability : unportable
-- --
-- Dynamically change workspace text based on the contents of the workspace -- Dynamically augment workspace names logged to a status bar via DynamicLog
-- based on the contents (windows) of the workspace.
----------------------------------------------------------------------------- -----------------------------------------------------------------------------
module XMonad.Hooks.DynamicIcons ( module XMonad.Hooks.DynamicIcons (
@@ -37,33 +38,46 @@ import Data.Traversable (for)
import Control.Monad ((<=<), (>=>)) import Control.Monad ((<=<), (>=>))
-- $usage -- $usage
-- Dynamically changes a 'Workspace's 'WorkspaceId' based on the 'Window's inside the Workspace. -- Dynamically augment Workspace's 'WorkspaceId' as shown on a status bar
-- 'IconSet's describe which icons are shown depending on which windows fit a 'Query'. -- based on the 'Window's inside the Workspace.
-- --
-- To create an 'IconSet' make a 'Query' that returns a ['Icon']. -- Icons are specified by a @Query [String]@, which is something like a
-- 'ManageHook' (and uses the same syntax) that returns a list of 'String's
-- (icons). This 'Query' is evaluated for each window and the results are
-- joined together. 'appIcon' is a useful shortcut here.
-- --
-- 'appIcon' can be used to simplify this process -- For example:
-- For example,
-- --
-- > icons :: IconSet -- > myIcons :: Query [String]
-- > icons = composeAll -- > myIcons = composeAll
-- > [ className =? "discord" --> appIcon "\xfb6e" -- > [ className =? "discord" --> appIcon "\xfb6e"
-- > , className =? "Discord" --> appIcon "\xf268" -- > , className =? "Discord" --> appIcon "\xf268"
-- > , className =? "Firefox" --> appIcon "\63288" -- > , className =? "Firefox" --> appIcon "\63288"
-- > , className =? "Spotify" <||> className =? "spotify" --> appIcon "阮" -- > , className =? "Spotify" <||> className =? "spotify" --> appIcon "阮"
-- > ] -- > ]
-- --
-- then you can add the hook to your config -- then you can add the hook to your config:
-- --
-- > xmonad $ def -- > main = xmonad $ … $ def
-- > { logHook = dynamicLogIconsWithPP icons xmobarPP <> myManageHook -- > { logHook = dynamicLogIconsWithPP icons xmobarPP
-- > } -- > , … }
-- --
-- Here is an example of this -- Here is an example of this
-- --
-- <<https://imgur.com/download/eauPNPz/Dynamic%20Icons%20in%20XMonad>> -- <<https://user-images.githubusercontent.com/300342/111010930-36a54300-8398-11eb-8aec-b3059b04fa31.png>>
-- --
-- NOTE: You can use any string you want here. The example shown here, uses NerdFont Icons to represent open applications -- Note: You can use any string you want here.
-- The example shown here uses NerdFont Icons to represent open applications.
--
-- If you want to customize formatting and/or combine this with other
-- 'PP' extensions like "XMonad.Util.ClickableWorkspaces", here's a more
-- advanced example how to do that:
--
-- > myIconConfig = def{ iconConfigIcons = myIcons, iconConfigFmt = iconsFmtAppend concat }
-- > main = xmonad $ … $ def
-- > { logHook = xmonadPropLog =<< dynamicLogString =<< clickablePP =<<
-- > dynamicIconsPP myIconConfig xmobarPP
-- > , … }
-- | Shortcut for configuring single icons. -- | Shortcut for configuring single icons.
@@ -114,6 +128,8 @@ instance Default IconConfig where
-- First parameter specifies how to concatenate multiple icons. Useful values -- First parameter specifies how to concatenate multiple icons. Useful values
-- include: 'concat', 'unwords', 'wrapUnwords'. -- include: 'concat', 'unwords', 'wrapUnwords'.
-- --
-- ==== __Examples__
--
-- >>> iconsFmtReplace concat "1" [] -- >>> iconsFmtReplace concat "1" []
-- "1" -- "1"
-- --
@@ -131,6 +147,8 @@ iconsFmtReplace cat ws is | null is = ws
-- First parameter specifies how to concatenate multiple icons. Useful values -- First parameter specifies how to concatenate multiple icons. Useful values
-- include: 'concat', 'unwords', 'wrapUnwords'. -- include: 'concat', 'unwords', 'wrapUnwords'.
-- --
-- ==== __Examples__
--
-- >>> iconsFmtAppend concat "1" [] -- >>> iconsFmtAppend concat "1" []
-- "1" -- "1"
-- --
@@ -143,6 +161,8 @@ iconsFmtAppend cat ws is | null is = ws
-- | Join words with spaces, and wrap the result in delimiters unless there -- | Join words with spaces, and wrap the result in delimiters unless there
-- was exactly one element. -- was exactly one element.
-- --
-- ==== __Examples__
--
-- >>> wrapUnwords "{" "}" ["A", "B"] -- >>> wrapUnwords "{" "}" ["A", "B"]
-- "{A B}" -- "{A B}"
-- --