# structure-view

**Repository Path**: alibaba/structure-view

## Basic Information

- **Project Name**: structure-view
- **Description**: Structure View for ATOM editor, just like Outline view in Eclipse or Structure tool window in IDEA / WebStorm, provides quick navigation for symbols of source code with a tree view. 
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-31
- **Last Updated**: 2026-03-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Structure-View
Structure View for [ATOM](https://atom.io/) editor, just like Outline view in Eclipse or Structure tool window in IDEA / WebStorm, provides quick navigation for symbols of source code with a tree view.

![demo](https://user-images.githubusercontent.com/8896124/30044182-61ee94c6-922e-11e7-8181-10122681a1d9.gif)

*Pull requests are welcomed! Raise an issue [here](https://github.com/alibaba/structure-view/issues) if you have any question.*

## Table of Contents

- [Installation](#installation)
- [Language Support](#language-support)
- [Usage](#usage)
- [Settings](#settings)
- [Contribution](#contribution)
- [License](#license)
- [TODO](#todo)




## Installation

Two ways to install:

- From command line:

```bash
apm install structure-view
```

- From Atom editor:

  Settings/Preferences ➔ Packages ➔ Search for `structure-view`




## Language Support

| Lanuage    | File Extensions                          | AST Parser                               |
| ---------- | ---------------------------------------- | ---------------------------------------- |
| HTML       | `.html` , `.njk` , `.xtpl` , ...         | [htmlparser2](https://github.com/fb55/htmlparser2) |
| CSS        | `.css`                                   | [css](https://github.com/reworkcss/css)  |
| Javascript | `.js`                                    | [esprima](http://esprima.org/) / [jsctags](https://github.com/ramitos/jsctags) |
| Others     | `.coffe` , `.less` , `.scss` , `.sass` , `.yaml` , `.yml` , `.md` , `.markdown` , `.mdown` , `.mkd` , `.mkdown` , `.ron` , `.json` , `.cson` , `.gyp` , `.c` , `.cpp` , `.mm` , `.py`, `.rb` , `.php` , `.module` , `.go` , `.pl` , `.pod` , `.es6` , `.jsx` , `.es` , `.hx` , `.nim` , `.rs` , `.lc` , `.livecodescript` , `.irev` , `.sql` , `.bdy` , `.spc` , `.pls` , `plb` , `.ddl` , `.pks` , `.pkb` , `.sce` , `.sci` , `.m` , `.kla` , `.ini` | [ctags](http://ctags.sourceforge.net/)   |



## Usage

#### Commands

You can find all these commands by [`Command Palette`](http://flight-manual.atom.io/getting-started/sections/atom-basics/).

- `Structure View: Hide`
- `Structure View: Show`
- `Structure View: Toggle`

#### Shortcut

- `Ctrl-o` : `Structure View: Toggle`

#### Operations

- Single click: navigation of tag
- Double click: collapse/expand the tree of selected tag




## Settings

| Feature                        | Description                              | Default |
| ------------------------------ | ---------------------------------------- | ------- |
| Show Variables                 | If you don't need variables in the structure of file, just uncheck this config. | true    |
| Show Properties                | If you don't need properties in the structure of file (such as CSS), just uncheck this config. | true    |
| Double Click To Fold Tree View | If this value is false, then select tag and toggle the tree view would all by single click. | true    |
| Autoscroll from Source (Beta)  | Enable this feature to have Atom automatically move the focus in the Structure View to the node that corresponds to the code where the cursor is currently positioned in the editor. | false   |



## Icon alphabet meaning

##### HTML

- `<>` : Element

##### CSS

- `S` : Selector
- `P` : Property

##### Javascript

- `C` : Class
- `I` : Import
- `F` : Function
- `M` : Method
- `V` : Variable

#### Others

- `U` : Unknown



## TODO

See [`TODO.md`](./TODO.md).



## Contributing

- Universal tag generator comes from [symbols-tree-view](https://github.com/xndcn/symbols-tree-view)




## License

MIT