Symbol Navigator README
This is the README for the "Symbol Navigator" extension, which provides an enhanced symbol outline view for VS Code.
Features
This extension improves code navigation by providing a dedicated symbol outline view in VS Code's activity bar. It offers an organized view of all symbols in your code, grouped by their types and easily accessible through a tree view structure.
Key features include:
- Symbol grouping by type (Classes, Methods, Functions, etc.)
- Quick navigation to symbols with a single click
- Real-time symbol updates as you edit
- Filtering capabilities for quick symbol lookup
- Hierarchical view of nested symbols
- Customized icons for different symbol types
The extension displays symbols in the following categories:
- Classes
- Interfaces
- Enums
- Methods
- Functions
- Properties
- Variables
- Constants
- Fields
- And more...
Usage
The Symbol Navigator is accessible through the activity bar:
- Click on the Symbol Navigator icon in the activity bar
- View your code's symbols organized by their types
- Click on any symbol to jump to its location in the code
- Use the filter button (funnel icon) to search for specific symbols
Filtering Symbols
You can filter symbols in two ways:
- By name: Simply type the symbol name you're looking for
- By type: Use the
@:
prefix followed by the type name (e.g., @:class
to show only classes)
Commands
The extension provides the following commands:
symbolOutline.jumpToSymbol
: Jump to the selected symbol in the editor
symbolOutline.filter
: Open the symbol filter input box
View Container
The extension adds a new view container to the activity bar with the following components:
- Symbol Outline view showing all symbols in the current file
- Filter button in the view's title bar for quick symbol filtering
Installation
- Open VS Code
- Go to the Extensions view (
Ctrl+Shift+X
or Cmd+Shift+X
)
- Search for "Symbol Navigator"
- Click Install
Requirements
This extension requires VS Code version 1.95.0 or higher.
Extension Settings
Currently, this extension does not require any additional settings. All features work out of the box.
Known Issues
There are currently no known issues. If you encounter any problems, please report them on the GitHub repository.
Release Notes
1.0.0
Initial release of Symbol Navigator:
- Tree view of symbols grouped by type
- Real-time symbol updates
- Symbol filtering functionality
- Quick navigation to symbols
- Custom icons for different symbol types