Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/catppuccin/vscode-icons

🦊 Soothing pastel icons for VSCode/VSCodium
https://github.com/catppuccin/vscode-icons

catppuccin extension hacktoberfest icons theme vscode

Last synced: about 2 months ago
JSON representation

🦊 Soothing pastel icons for VSCode/VSCodium

Host: GitHub
URL: https://github.com/catppuccin/vscode-icons
Owner: catppuccin
License: mit
Created: 2023-02-22T17:08:09.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-06-30T11:40:16.000Z (3 months ago)
Last Synced: 2024-07-02T09:59:06.952Z (3 months ago)
Topics: catppuccin, extension, hacktoberfest, icons, theme, vscode
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=Catppuccin.catppuccin-vsc-icons
Size: 155 MB
Stars: 410
Watchers: 5
Forks: 21
Open Issues: 34
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

Catppuccin Icons for VSCode/VSCodium

## Previews

🌻 Latte

🪴 Frappé

🌺 Macchiato

🌿 Mocha

## Features

- Soothing colors from the Catppuccin palette.
- Ever growing collection of language/technology specific icons.
- Look and feel consistency.
- Custom associations, monochrome icons, and more!

## Usage

> [!TIP]
> We also have [a Catppuccin theme for the rest of VSCode/VSCodium](https://github.com/catppuccin/vscode), as well as [a Catppuccin theme that brings these icons right into GitHub](https://github.com/catppuccin/github-file-explorer-icons). For Jetbrains IDEs we have [catppuccin/Jetbrains-icons](https://github.com/catppuccin/jetbrains-icons).

### Marketplace

Install the extension from one of the following marketplaces.

- [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Catppuccin.catppuccin-vsc-icons)
- [Open-VSX](https://open-vsx.org/extension/Catppuccin/catppuccin-vsc-icons)

### Manual

Download the VSIX from
[the latest GitHub release](https://github.com/catppuccin/vscode-icons/releases/latest).
Open the Command Palette and select "Extensions: Install from VSIX...", then select the file you just downloaded.

## Customization

### Settings

Defaults for each setting are shown below.

```jsonc
{
// Set to `true` to disable folding arrows next to folder icons.
"catppuccin-icons.hidesExplorerArrows": false,

// Set to `false` to only use the default folder icon.
"catppuccin-icons.specificFolders": true,

// Set to `true` to only use the `text` fill color for all icons.
"catppuccin-icons.monochrome": false
}
```

To see all available options, open your settings UI and look for `Extensions > Catppuccin Icons`.

> [!IMPORTANT]
> Changing settings regenerates/rewrites theme files and icons. It may take some time on lower-end computers. You may also be prompted to reload the window for changes to take effect.

### Custom icon associations

You can also associate specific `languagesIds`/`fileExtensions`/`fileNames`/`folderNames` to icons and override the provided defaults.

```jsonc
{
// Files with the language type `typescriptreact` will have the `typescript-react` icon.
"catppuccin-icons.associations.languages": {
"typescriptreact": "typescript-react"
},

// Files with the `spec.ts` extension will have the `typescript-test` icon.
"catppuccin-icons.associations.extensions": {
"spec.ts": "typescript-test"
},

// Files with the name `vite.config.ts` will have the `vite` icon.
"catppuccin-icons.associations.files": {
"vite.config.ts": "vite"
},

// Folders with the name `typings/` will have the `folder_types` icon.
"catppuccin-icons.associations.folders": {
"typings": "folder_types"
}
}
```

> [!NOTE]
> All available icons are listed in the [preview images above](#previews). Custom/external SVGs are not supported, though you may [request icons](#requesting-icons-and-features).

### Commands

We provide a set of commands to interact with the extension and icons if needed.

- `Catppuccin Icons: Factory reset settings`: removes all customization and resets the theme to the defaults.

## Requesting icons and features

To request a new icon or a specific feature, [open an issue](https://github.com/catppuccin/vscode-icons/issues/new/choose) documenting everything needed — the more information provided, the faster your request will be processed.

## Contributing

If you are willing to contribute new icons or features, refer to the [contribution guide](./CONTRIBUTING.md).

## 💝 Thanks to

- [PraZ](https://github.com/prazdevs)
- [thang-nm](https://github.com/thang-nm)