Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anseki/vscode-color
Helper with GUI to generate color codes such as CSS color notations.
https://github.com/anseki/vscode-color
cmyk color-notations color-palette color-picker convert css dialog dialog-box gui hex hsb hsl hsv hwb palette picker rgb style vscode vscode-extension
Last synced: 5 days ago
JSON representation
Helper with GUI to generate color codes such as CSS color notations.
- Host: GitHub
- URL: https://github.com/anseki/vscode-color
- Owner: anseki
- License: mit
- Archived: true
- Created: 2016-02-22T10:26:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T03:45:24.000Z (about 2 years ago)
- Last Synced: 2024-08-01T21:49:56.926Z (3 months ago)
- Topics: cmyk, color-notations, color-palette, color-picker, convert, css, dialog, dialog-box, gui, hex, hsb, hsl, hsv, hwb, palette, picker, rgb, style, vscode, vscode-extension
- Language: JavaScript
- Size: 2.16 MB
- Stars: 98
- Watchers: 7
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Color Picker for VS Code
[](https://marketplace.visualstudio.com/items?itemName=anseki.vscode-color) [](https://marketplace.visualstudio.com/items?itemName=anseki.vscode-color) [](https://github.com/anseki/vscode-color/issues) [](package.json) [](LICENSE)
**Now, VS Code has own Color Picker.**
Helper with GUI to generate color codes such as CSS color notations.
And, a command [`Convert Color`](#convert-color) to change the color notation.
A dialog box is shown by pressing `Alt + C P` keys or command `Pick Color`. If a cursor is positioned on a string that is color notation at that time, that string is selected as target for editing.
* Supported color spaces to edit the color: HSB (HSV), RGB, Lab, and CMYK. With alpha channel.
* Supported color notations to output the color: `hsb()`/`hsba()`, `hsl()`/`hsla()`, `hwb()`, `rgb()`/`rgba()`, RGB-Hex 3/4/6/8 digits, CSS Named Color, `device-cmyk()` and `gray()`.
* Custom [color palettes](#color-palettes) supported.
* [`Convert Color`](#convert-color) command to change the color notation supported.
* Multiple cursors supported.
## Install
You need [Node.js](https://nodejs.org/) (including NPM) installed and available in your `$PATH`.
**Note:** If you use a Node Version Manager (e.g. nvm), the Node.js might not be available in a process VS Code will run, until you make it. (Especially in **Windows 10 / Vista**, the NPM might not be available.)
Then, launch the Command Pallete (`Ctrl + Shift + P` or `Cmd + Shift + P`) and type `ext install`, and then look for "Color Picker".
**Note:** If a few NPM modules that the extension uses are not found in your computer, those will be installed automatically. Then, only when first launching, it may take some little time for setting up. (**Please wait for the finish** without closing VS Code.)
**Note:** For alternative NPM (e.g. you are in China and you are using CNPM), see [Manual installation NPM modules](#manual-installation-npm-modules).
## Usage
A dialog box is shown by pressing `Alt + C P` keys (press P after release Alt and C) or command `Pick Color`.
If a cursor is positioned on a string that is color notation at that time, that string is selected as target for editing. The color notation is recognized even if it includes line-breaks and comments.
For example:
```css
background-color: hsl(
136,
77%, /* When it is blurred, change to 32% */
84%
);
```
Multiple cursors also supported.
You can see tooltip information for some controls in the dialog box by hovering a mouse on those.
### Convert Color
When a cursor or multiple cursors are positioned on strings that are color notation, press `Alt + C C` (press C after release Alt and C) keys or run a command `Convert Color`.
Then a list of color notations is shown. The target strings are converted to each color with the notation you chose.
It is converted with the notation you chose and current state of `Pick Color` dialog box.
For example, you turned on an `UC` (upper-case) checkbox of `RGB-Hex` in the dialog box, and you invoked the command `Convert Color` with a string `white` as a target and `RGB-Hex` notation, then that `white` is converted to `#FFF`. If you turned off that checkbox, it is converted to `#fff`.
## Color palettes
You can create custom color palettes. Also, you can specify color palettes that are loaded always, or color palettes that are loaded for only a project.
For example, a color palette as a design theme (or template) for your website is loaded only when that website project is being opened by VS Code.
See [`colorHelper.storeDir`](#colorhelperstoredir) option.
## Options
You can specify following options by User Settings or Workspace Settings.
### `colorHelper.pickerForm`
A name of preset package that switches UI and features.
Allowed values are:
* `"default"`
* `"largePalette"`
* `"simple"`
* `"compact"`
* `"compact2"`
* `"byPalette"`
### `colorHelper.storeDir`
A path to directory that contains your color palettes.
For information about color palettes, see `README.md` that is found in that directory.
### `colorHelper.resident`
Stands by for a quick response.
After the dialog box is opened, it stays in memory even after it is closed until VS Code is exited (or VS Code might unload it).
### `colorHelper.formatsOrder`
An array that indicates the order of formats in UI (e.g. drop-down list).
Allowed items are `"hsb"`, `"hsl"`, `"hwb"`, `"rgb"`, `"hex"`, `"named"`, `"cmyk"` or `"gray"`.
This array doesn't have to contain all formats. The formats that are not contained in the array are moved to the top of the list in UI automatically when it was used. If you want to make the list static, specify all formats in the order you desire, e.g. `["hsb", "hsl", "hwb", "rgb", "hex", "named", "cmyk", "gray"]`.
## Rendering trouble
If your GPU driver has a problem, the dialog box might not be shown correctly. The following options try to avoid the problem.
**Note:** You should **not use these** if there is no problem. Also, it is not a solution to the root of the problem, and it might not solve the problem.
**Steps:**
1. If the dialog box is not shown correctly, set `colorHelper.disableGpu` to `1`.
2. If that wasn't solved yet, set `colorHelper.disableShadow` to `true`.
3. If that wasn't solved yet, set `colorHelper.disableTransparent` to `true`.
4. If that wasn't solved yet, please visit [support page](https://github.com/anseki/vscode-color/issues).
### `colorHelper.disableGpu`
If `1` is specified, disable GPU rendering on Windows. By default (`-1`), it is switched automatically dependent on current platform.
### `colorHelper.disableShadow`
If `true` is specified, disable drop shadow effect of the dialog box.
### `colorHelper.disableTransparent`
If `true` is specified, disable transparent window as the dialog box.
## Manual installation NPM modules
You might be using your favorite alternative NPM. Also, if you're in China, maybe you are using [CNPM](https://github.com/cnpm/cnpm) instead of NPM.
The following steps install NPM modules manually:
1. Install the Color Picker extension (see [Install](#install)), and **don't launch** the extension yet.
2. Command:
`cd /d "%USERPROFILE%\.vscode\extensions\anseki.vscode-color-x.x.x"` (Windows)
`cd ~/.vscode/extensions/anseki.vscode-color-x.x.x` (others)
*The `x.x.x` above is a version of the extension.*
3. Execute installation command. For example, CNPM:
`cnpm install`
4. Launch the extension after the installing NPM modules was finished.