emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/kind-icon e3eade50c1 1/3: Update README.md


From: ELPA Syncer
Subject: [elpa] externals/kind-icon e3eade50c1 1/3: Update README.md
Date: Mon, 19 Jun 2023 12:59:32 -0400 (EDT)

branch: externals/kind-icon
commit e3eade50c176e77505f69736230c8786318356e4
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>

    Update README.md
---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 500a1b0f0b..a331efb84f 100644
--- a/README.md
+++ b/README.md
@@ -65,7 +65,8 @@ The configuration defaults should work fine, but `kind-icon` 
can be customized t
 - `kind-icon-use-icons`: If non-nil (the default), prefer icons for prefix 
badges.  Otherwise, use text labels.  Individual kind entries can also have 
their icons disabled by removing the `:icon` property in the mapping (see 
below).  If `svg-lib` is unable to download a named icon and it is not cached 
on disk, text labels for that kind will be used as a fallback. 
 
 - `kind-icon-mapping`: This is the top level configuration mapping 
`:company-kind` "types" like `'variable` and `'function`.  Each item in this 
list has the format `(sym short-text :keyword value ...)` where `sym` is the 
kind (a symbol), and `short-text` is the abbreviated text to display (if icons 
are not used), both of which must be present.  The rest of the list is a 
property list with optional keys `:icon` and `:face`.  The latter will be used 
to set the text foreground and (possibly [...]
-**Update** as of v0.2, additional keywords supported by svg-lib can be added, 
including `:collection`, which allows the use of other icon libraries, 
including, in recent svg-lib versions, vscode-icons. Please note that **only 
monochrome icons are supported**; if you configure icons which have hard-coded 
colors in the SVG file (as some vscode-icons do), they will not be displayed 
correctly.   If you want to switch the collection for _all_ icons, add (e.g) 
`:collection "octicon"` to `kind- [...]
+
+**Update**: As of kind-icon v0.2, additional keywords supported by svg-lib can 
be utilized, including `:collection`, which allows the use of other icon 
libraries, including, in recent svg-lib versions, vscode-icons. Please note 
that **only monochrome icons are supported**; if you configure icons which have 
hard-coded colors in the SVG file (as some vscode-icons do), they will not be 
displayed correctly.   If you want to switch the collection for _all_ icons, 
add (e.g) `:collection "octic [...]
 
 - `kind-icon-default-face`: A face from which the icon background color will 
be taken and blended with the `:face` foreground color in the mapping table to 
create a custom background color.  If not set, the frame default background 
color will be used for this purpose.  Similarly, the foreground color for this 
face, if set, will be used if a `:face` foreground is missing from the mapping. 
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]