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

https://github.com/ottojimb/quickchars

VSCode extension: quick access to special characters, symbols, emojis, and code snippets
https://github.com/ottojimb/quickchars

emojis shortcuts snippets special-characters unicode-characters vscode-extension

Last synced: about 2 months ago
JSON representation

VSCode extension: quick access to special characters, symbols, emojis, and code snippets

Awesome Lists containing this project

README

          

# ๐Ÿš€ QuickChars

![QuickChars Logo](./icon.png)

A Visual Studio Code extension that provides quick access to special characters, symbols, emojis, and code snippets through a convenient sidebar panel.

If you enjoy this extension, you can:


Buy Me a Coffee

## ๐Ÿ“ธ Screenshots

Emojis ๐Ÿ‘Œ

Snippets ๐Ÿง‘โ€๐Ÿ’ป

Custom ๐Ÿ”ง

Settings โš™๏ธ

## โœจ Features

- **โšก Quick Character Insertion**: Insert special characters and symbols with a single click
- **๐Ÿ“ Code Snippets**: Insert predefined code snippets with placeholders
- **๐Ÿ“ Collapsible Groups**: Organize items into groups that can be expanded/collapsed
- **๐Ÿ’พ Persistent State**: Groups remember their expanded/collapsed state between sessions
- **๐Ÿ”„ Dual Panel Support**: Available in both Activity Bar and Explorer sidebar
- **๐ŸŽจ Fully Customizable**: Configure your own groups and items through VS Code settings

## ๐Ÿ“ฆ Default Groups

QuickChars comes with these pre-configured example groups:

- **๐Ÿ”ค Special Characters**: Arrows, copyright, checkmarks, currency symbols, mathematical operators
- **๐Ÿ‡ช๐Ÿ‡ธ Spanish Accents**: Accented letters and Spanish punctuation (ยฟ, ยก)
- **๐Ÿ˜€ Emojis**: Common emojis for documentation and comments
- **๐Ÿ’ป Code Snippets**: Console.log and arrow function templates

## ๐ŸŽฏ How to Use

1. **๐Ÿ“ Access the Panel**: Look for the QuickChars icon in the Activity Bar or Explorer sidebar
2. **โœจ Insert Items**: Click any button to insert the character or snippet at your cursor position
3. **๐Ÿ“‚ Expand/Collapse Groups**: Click on group headers to show/hide their contents
4. **๐Ÿ”• Hide Info Banner**: Uncheck "Show Info Banner" in settings once you're familiar with the extension

## โš™๏ธ Customization

### ๐Ÿ“ Adding Your Own Groups and Items

1. Open VS Code Settings (`Ctrl/Cmd + ,`)
2. Search for "QuickChars"
3. Edit the "Groups" configuration

### ๐Ÿ“‹ Configuration Format

```json
{
"quickChars.groups": [
{
"name": "My Custom Group",
"items": [
{ "label": "โœ“", "text": "โœ“" },
{ "label": "My Snippet", "text": "console.log('$1');", "isSnippet": true }
]
}
]
}
```

### ๐Ÿ”ง Configuration Example

```json
{
"quickChars.groups": [
{
"name": "Math Symbols",
"items": [
{ "label": "ฮฑ", "text": "ฮฑ" },
{ "label": "ฯ€", "text": "ฯ€" }
]
},
{
"name": "JS Snippets",
"items": [
{ "label": "Log", "text": "console.log('$1');", "isSnippet": true }
]
}
]
}
```

### ๐Ÿท๏ธ Item Properties

- `label`: Text displayed on the button
- `text`: Text to be inserted
- `isSnippet` (optional): Set to `true` for full-width snippet buttons

### ๐Ÿ“ Placeholder Support

- `$1`, `$2`, etc. for tab stops
- `${1:placeholder}` for default text
- `$0` for final cursor position

## ๐ŸŽฎ Commands

- **QuickChars: Toggle QuickChars in Activity Bar** - Show/hide the Activity Bar panel
- **QuickChars: Toggle QuickChars in Explorer** - Show/hide the Explorer panel

## ๐Ÿ’ก Tips

- ๐Ÿ’พ Groups remember their expanded/collapsed state - your preferred layout persists between sessions
- ๐Ÿ“„ Use `isSnippet: true` for multi-line code templates that need full-width buttons
- ๐Ÿ”ฒ Regular characters work best as square buttons without the `isSnippet` property
- ๐Ÿ”„ You can completely replace the default configuration with your own groups
- ๐Ÿ  The first group is expanded by default, others start collapsed

## ๐Ÿ“‹ Requirements

- Visual Studio Code 1.102.0 or higher

## โšก Extension Settings

This extension contributes the following settings:

* `quickChars.showInfoBanner`: Enable/disable the configuration tips banner
* `quickChars.showInActivityBar`: Show/hide QuickChars in Activity Bar
* `quickChars.showInExplorer`: Show/hide QuickChars in Explorer
* `quickChars.groups`: Define your custom groups and items

## ๐Ÿ“„ License

This extension is provided as-is without warranty. Feel free to modify and distribute according to your needs.