mirror of
https://github.com/nvim-tree/nvim-web-devicons
synced 2024-09-16 13:44:06 +02:00
docs: clarify setup overrides
This commit is contained in:
parent
5b1e78d22f
commit
e37bb1feee
1 changed files with 1 additions and 17 deletions
18
README.md
18
README.md
|
@ -106,20 +106,6 @@ require'nvim-web-devicons'.setup {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Note To Plugin Authors
|
|
||||||
|
|
||||||
Please check that nvim-web-devicons has not already been setup first, to prevent clobbering user's overrides e.g.
|
|
||||||
|
|
||||||
```lua
|
|
||||||
local has_devicons, devicons = pcall(require, "nvim-web-devicons")
|
|
||||||
|
|
||||||
if has_devicons then
|
|
||||||
if not devicons.has_loaded() then
|
|
||||||
devicons.setup()
|
|
||||||
end
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
### Get Icon
|
### Get Icon
|
||||||
|
|
||||||
Get the icon for a given file by passing in the `name`, the `extension` and an _optional_ options `table`.
|
Get the icon for a given file by passing in the `name`, the `extension` and an _optional_ options `table`.
|
||||||
|
@ -224,9 +210,7 @@ You can also use `get_icon_name_by_filetype(filetype)` to get the icon name asso
|
||||||
|
|
||||||
### My `setup` Overrides Are Not Applied
|
### My `setup` Overrides Are Not Applied
|
||||||
|
|
||||||
*Cause:* A plugin may be calling nvim-web-devicons `setup` after you do, clobbering your overrides.
|
*Cause:* A plugin may be calling nvim-web-devicons `setup` before you do. Your `setup` call will be ignored.
|
||||||
|
|
||||||
*Solution:* change plugin to check `has_loaded` before calling `setup`.
|
|
||||||
|
|
||||||
*Workaround:* Call nvim-web-devicons `setup` before the plugin's own `setup`.
|
*Workaround:* Call nvim-web-devicons `setup` before the plugin's own `setup`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue