Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.

Commit

Permalink
chore: generated vimdoc (#100)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] authored Sep 22, 2021
1 parent 58ac1a4 commit 0f3afe2
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions doc/feline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,10 @@ Note that you can also use your |feline-manually-added-providers| the same way



- `icon` (table, string or function): Some inbuilt providers such as `git_branch` provide default icons. If you either don’t have a patched font or don’t like the default icon that Feline provides, or if you want an icon for a component that doesn’t have any default icons, you may set this value to use any icon you want instead. By default, the icon inherits the component’s highlight, but you can also change the highlight specifically for the icon. To do this, you need to pass a table containing `str` and `hl`, where `str` would represent the icon and `hl` would represent the icon highlight. The icon’s highlight works just like the `hl` component’s values. If it’s a function, it can take either the window handler as an argument, or it can take no arguments. For example:
- `icon` (table, string or function): Some inbuilt providers such as `git_branch` provide default icons. If you either don’t have a patched font or don’t like the default icon that Feline provides, or if you want an icon for a component that doesn’t have any default icons, you may set this value to use any icon you want instead.<br><br>
By default, the icon inherits the component’s highlight, but you can also change the highlight specifically for the icon. To do this, you need to pass a table containing `str` and `hl`, where `str` would represent the icon and `hl` would represent the icon highlight. The icon’s highlight works just like the `hl` component’s values.<br><br>
There’s also another value you can set if the value of `icon` is a table, which is `always_visible`. By default, the icon is not shown if the value returned by the provider is empty. If you want the icon to be shown even when the provider string is empty, you need to set `always_visible` to `true`.<br><br>
If the value of `icon` a function, it can take either the window handler as an argument, or it can take no arguments. For example:


>
Expand All @@ -306,7 +309,18 @@ Note that you can also use your |feline-manually-added-providers| the same way
-- Setting icon to a table
icon = {
str = ' ~ ',
hl = { fg = 'orange' },
hl = { fg = 'orange' }
}
-- Making icon always visible
icon = {
str = '',
hl = {
fg = require('feline.providers.vi_mode').get_mode_color(),
bg = 'black',
style = 'bold'
},
always_visible = true
}
<

Expand Down

0 comments on commit 0f3afe2

Please sign in to comment.