Skip to content

Commit 14da09d

Browse files
committed
feat: complete working files docs
1 parent ddd4260 commit 14da09d

File tree

5 files changed

+103
-1
lines changed

5 files changed

+103
-1
lines changed

docs/05-file-management.md

Lines changed: 103 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ When you right-click a tab, a context menu appears which has multiple options so
201201

202202
> These options provide quick access to common file operations directly from the Tab Bar.
203203
204-
#### Git - Tab Bar
204+
### Git - Tab Bar
205205
The Tab Bar displays Git file status indicators, showing which files are **untracked** or **modified**.
206206

207207
![Tab bar Git](./images/fileManagement/tab-bar-git.png "Tab bar Git")
@@ -210,3 +210,105 @@ The Tab Bar displays Git file status indicators, showing which files are **untra
210210
- An **orange marker** indicates a **modified** file.
211211

212212
> These indicators appear only when your project is a Git repository.
213+
214+
---
215+
216+
## Working Files
217+
**Working Files** (also called **Working Tree**) provides another way to view and manage open files. It appears in the sidebar, above the **File Tree**.
218+
219+
![Working Files](./images/fileManagement/working-files.png "Working Files")
220+
221+
Working Files and Tab Bar are synchronized which means that any operation performed on one (closing, reordering, opening files, etc.) is automatically reflected on the other.
222+
223+
Working Files displays the same UI elements as the Tab Bar:
224+
* `` icon for unsaved files
225+
* `×` button to close files
226+
* Parent folder names when multiple files have the same filename
227+
* Tooltip showing full file path on hover
228+
* Git status indicators (green for untracked, orange for modified files)
229+
230+
> See the [Tab Bar](#tab-bar) section for detailed explanations of these features.
231+
232+
> **Note**: Unlike Tab Bar, you cannot control the maximum number of files displayed in Working Files.
233+
234+
### Working Files in Split Panes
235+
When using split panes, each pane maintains its own list of open files in Working Files.
236+
237+
The panes are labeled based on the split orientation:
238+
* **Vertical Split**: *Left* (first pane) and *Right* (second pane)
239+
* **Horizontal Split**: *Top* (first pane) and *Bottom* (second pane)
240+
241+
![Working Files Split Panes](./images/fileManagement/working-files-split-panes.png "Working Files Split Panes")
242+
243+
### Drag-Drop in Working Files
244+
You can reorder files in Working Files by dragging and dropping them, just like in the Tab Bar.
245+
246+
<VideoPlayer
247+
src="https://docs-images.phcode.dev/videos/file-management/drag-drop-working-files.mp4"
248+
/>
249+
250+
### Showing or Hiding Working Files
251+
You can show or hide the Working Files panel in two ways:
252+
253+
#### 1. From the Sidebar
254+
Click the **double-arrow** icon in the top-right corner of the sidebar, then use the `Show Working Files` option in the dropdown to toggle Working Files.
255+
256+
![Disable Working Files](./images/fileManagement/disable-working-files.png "Disable Working Files")
257+
258+
#### 2. From Preferences
259+
You can also toggle Working Files by updating the `showWorkingSet` property in the preferences file.
260+
```json
261+
"showWorkingSet": true
262+
```
263+
Set the value to `false` to hide Working Files.
264+
See [Editing Preferences](./editing-text#editing-preferences) if you need help editing the preferences.
265+
266+
### Working Files Context Menu
267+
When you right-click a file in Working Files, a context menu appears with various file operations.
268+
269+
![Working Files context menu](./images/fileManagement/working-files-context-menu.png "Working Files context menu")
270+
271+
#### Working Files Context Menu Options
272+
273+
* **Save File** — Saves the selected file if it has unsaved changes.
274+
275+
* **Show in File Tree** — Highlights the selected file in the File Tree so you can locate it easily.
276+
277+
* **Open In** — Opens the file or its location in external applications. *This option is available only in Desktop apps.*
278+
- **File Explorer** (Windows) / **File Manager** (Linux): Opens the file's location in the system file browser.
279+
- **Command Prompt** (Windows) / **Terminal** (Linux): Opens a terminal window at the file's directory.
280+
- **Default Application**: Opens the file in the system's default application for that file type.
281+
282+
* **Copy** — Copies the file name to the clipboard.
283+
284+
* **Copy Path** — Copies the file's full path to the clipboard.
285+
286+
* **Duplicate** — Creates a duplicate of the file with the same content. The duplicate is named with `(copy 1)` appended.
287+
*For example: `script.js` becomes `script(copy 1).js`.*
288+
289+
* **Download** — Downloads the file to your local system. *This option is available only in the browser version.*
290+
291+
* **Rename** — Allows you to rename the file. When you choose this option, **Phoenix Code** highlights the file in the File Tree so you can rename it directly.
292+
293+
* **Delete** — Deletes the file from the project and removes it from Working Files.
294+
295+
* **Find in...** — Opens the Find dialog to search for text within the selected file.
296+
297+
* **Replace in...** — Opens the Find and Replace dialog to search and replace text within the selected file.
298+
299+
* **Close** — Closes the selected file and removes it from Working Files.
300+
301+
* **Close Files Above** — Closes all files above the selected one in the Working Files list. *This option is disabled when there are no files above the selected file.*
302+
303+
* **Close Other Files** — Closes all files except the selected one. *This option is disabled when the selected file is the only open file.*
304+
305+
* **Close Files Below** — Closes all files below the selected one in the Working Files list. *This option is disabled when there are no files below the selected file.*
306+
307+
* **Add to .gitignore** — Adds the selected file to the `.gitignore` file, preventing it from being tracked by Git. *This option appears only when your project is a Git repository.*
308+
309+
* **Remove from .gitignore** — Removes the selected file from the `.gitignore` file, allowing it to be tracked by Git again. *This option appears only when your project is a Git repository.*
310+
311+
> These options provide quick access to common file operations directly from Working Files.
312+
313+
314+
102 KB
Loading
85.4 KB
Loading
29.4 KB
Loading
201 KB
Loading

0 commit comments

Comments
 (0)