Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nvim-colortils/colortils.nvim

Some color utils for neovim
https://github.com/nvim-colortils/colortils.nvim

Last synced: about 2 months ago
JSON representation

Some color utils for neovim

Host: GitHub
URL: https://github.com/nvim-colortils/colortils.nvim
Owner: nvim-colortils
License: gpl-2.0
Created: 2022-05-30T10:12:43.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-01-10T11:14:34.000Z (5 months ago)
Last Synced: 2024-01-24T09:39:13.563Z (4 months ago)
Language: Lua
Size: 151 KB
Stars: 319
Watchers: 2
Forks: 11
Open Issues: 6
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-neovim - nvim-colortils/colortils.nvim - A plugin providing utils to work with colors (picker, conversion) inside Neovim. (Color / PHP)
awesome-stars - nvim-colortils/colortils.nvim - Some color utils for neovim (Lua)
my-awesome-stars - nvim-colortils/colortils.nvim - Some color utils for neovim (Lua)
awesome-stars - nvim-colortils/colortils.nvim - Some color utils for neovim (Lua)
awesome-stars - nvim-colortils/colortils.nvim - Some color utils for neovim (Lua)
awesome-neovim - nvim-colortils/colortils.nvim - A plugin providing utils to work with colors (picker, conversion) inside Neovim. (Color / Markdown and LaTeX)
awesome-neovim - nvim-colortils/colortils.nvim - A plugin providing utils to work with colors (picker, conversion) inside Neovim. (Color / Markdown and LaTeX)

README

# Colortils.nvim - Neovim color utils

https://user-images.githubusercontent.com/81827001/187237256-e8b736cc-17f3-4521-a2ad-3c814b503481.mov

## ✨ Features
- rgb color picker
- Export in different formats
- rgb
- hex
- hsl
- Transparency support for picking, previewing and exporting
- Lighten and darken colors
- Convert colors to greyscale or something between the color and it's grey version
- Pick a color on a gradient between two colors
- Export from any of the mentioned tools above to other ones
- Replace color under cursor
- Some utilities for css colors
- List Colors

## 📦 Installation

Use you favourite package manager and call the setup function.
```lua
use {
"max397574/colortils.nvim",
cmd = "Colortils",
config = function()
require("colortils").setup()
end,
}
```

## ⚙️ Customization
You can change the settings by passing options to the setup function.
This is the default configuration:
```lua
require("colortils").setup({
-- Register in which color codes will be copied
register = "+",
-- Preview for colors, if it contains `%s` this will be replaced with a hex color code of the color
color_preview = "█ %s",
-- The default in which colors should be saved
-- This can be hex, hsl or rgb
default_format = "hex",
-- Border for the float
border = "rounded",
-- Some mappings which are used inside the tools
mappings = {
-- increment values
increment = "l",
-- decrement values
decrement = "h",
-- increment values with bigger steps
increment_big = "L",
-- decrement values with bigger steps
decrement_big = "H",
-- set values to the minimum
min_value = "0",
-- set values to the maximum
max_value = "$",
-- save the current color in the register specified above with the format specified above
set_register_default_format = "",
-- save the current color in the register specified above with a format you can choose
set_register_cjoose_format = "g",
-- replace the color under the cursor with the current color in the format specified above
replace_default_format = "",
-- replace the color under the cursor with the current color in a format you can choose
replace_choose_format = "g",
-- export the current color to a different tool
export = "E",
-- set the value to a certain number (done by just entering numbers)
set_value = "c",
-- toggle transparency
transparency = "T",
-- choose the background (for transparent colors)
choose_background = "B",
}
})
```

The row on which you are currently is highlighted with `ColortilsCurrentLine`.
You can modify that to change the way the tools look.

## 👀 Tools

### Supported Formats
Supported formats are the following:
- `rgb`/`rgba` (both with percentage and absolute values, e.g. `rgb(255, 255, 0)`/`rgb(100%, 100%, 0%, 0.5)`)
- `hex` (`#FFAB00`)
- `hsl`/`hsla` (`hsl(60, 100%, 50%)`, `hsla(60, 100%, 50%, 0.4)`)
- Css color names (only as argument)

### Usage
You can use the different tools with commands.
Those take the format `Colortils `.
The color can be any of the supported formats.
Notice that symbols like `#`, `%` and space need to be escaped like e.g. this `\#FF00AB`.

If no valid color is provided as argument the color under the cursor (if available) will be used.
If there isn't any found the user will be asked for input (notice that you don't need to escape characters there).

#### Mappings
You can use `h`/`l` and the mappings specified in the config to increment and decrement values or pick a position on a gradient.
With `0` and `$` to go to the minimum and the maximum values instantly.

With `q` you can close the tools.

With most tools you can use `` to save the currently selected color to the register speicified in the config.
If this isn't the case or something is special it will be written below.
You can use `g` to get a prompt in which you can choose the format.

With ``/`g` you can replace the color under the cursor instead of copying into a register.

You can use `E` to export the currently selected color to a different tool and modify it there.

##### Transparency mode
You can use `T` to toggle transparency mode.
This will add another slider where you can choose the transparency.
The preview and the color you'll export will change accordingly.

You can use `B` to change the background which is used to produce the transparent colors.

#### Color Picker
`Colortils picker `

![picker](https://user-images.githubusercontent.com/81827001/176244717-c4a3d4c5-bb95-4abc-93e0-3733bf87ddb0.png)

##### Saving color
You can use `` to save the color into the register specified in the config.
The default format (specified in the config) will be used.

You can use `g` to get prompted to choose a color format in which the color then will be saved to the register.

#### Lighten color
`Colortils lighten `

![lighten](https://user-images.githubusercontent.com/81827001/176244769-0967873c-8782-4bfb-ba7e-79b2d2a60a54.png)

#### Darken color
`Colortils darken `

![darken](https://user-images.githubusercontent.com/81827001/176244817-fa21c4c9-9700-4889-a379-5bbddb576234.png)

#### Color to greyscale
`Colortils greyscale `

![greyscale](https://user-images.githubusercontent.com/81827001/176244870-697a7d17-3b06-4bd1-ba07-9a59177096c4.png)

#### Pick color on gradient
`Colortils gradient `

![gradients](https://user-images.githubusercontent.com/81827001/176244977-3831bc86-f3e7-44fc-b4d9-d615d1ae9d16.png)

#### List css colors
`Colortils css list`

![css_list](https://user-images.githubusercontent.com/81827001/171230907-313fddc8-29e6-4b97-a842-8ea69ed5b6d5.png)

# Similar Plugins
This plugin has some things which are similar to [vim-colortemplate](https://github.com/lifepillar/vim-colortemplate).

## ❤️ Support
If you like the projects I do and they can help you in your life you can support my work with [github sponsors](https://github.com/sponsors/max397574).
Every support motivates me to continue working on my open source projects.