Skip to content

Enhance Editor File API Docs with pinned state features #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
UnschooledGamer wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Enhance Editor File API Docs with pinned state features #65

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1cae2ff
Enhance Editor File API with pinned state features
UnschooledGamer Mar 31, 2026
82797b0
Update docs/editor-components/editor-file.md
UnschooledGamer Mar 31, 2026
644251d
Update docs/editor-components/editor-file.md
UnschooledGamer Mar 31, 2026
9e6617c
Update docs/editor-components/editor-file.md
UnschooledGamer Mar 31, 2026
d3c9c3d
Update docs/editor-components/editor-file.md
UnschooledGamer Mar 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions docs/editor-components/editor-file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Editor File API provides functionality to create, manage, interact with files/tabs in the Acode editor. It handles file operations, state management, editor session control, custom editor tab, etc.

::: tip
This API is defined in the [Acode source code (src/lib/editorFile.js)](https://github.com/Acode-Foundation/Acode/blob/52bf3a59c4aebe422d8cfdecf5c85191ed6f6004/src/lib/editorFile.js).
This API is defined in the [Acode source code (src/lib/editorFile.js)](https://github.com/Acode-Foundation/Acode/blob/228a339296a3869fff7ff84e0898378a438931b8/src/lib/editorFile.js).
:::

## Import
Expand Down Expand Up @@ -68,6 +68,7 @@ Both methods are equivalent and accept & return the same parameters.
| uri | `string` | File location on the device |
| eol | `'windows' \| 'unix'` | End of line character |
| editable | `boolean` | Whether file can be edited |
| pinned | `boolean` | Whether the file is pinned |
| isUnsaved | `boolean` | Whether file has unsaved changes |
| name | `string` | File name (for plugin compatibility) |
| cacheFile | `string` | Cache file URL |
Expand All @@ -90,6 +91,7 @@ Both methods are equivalent and accept & return the same parameters.
| uri | `string` | Set file location |
| eol | `'windows' \| 'unix'` | Set end of line character |
| editable | `boolean` | Set file editability |
| pinned | `boolean` | Set file pinned state |
| readOnly | `boolean` | Set file readonly state |

## Methods
Expand All @@ -110,11 +112,18 @@ Saves the file to a new location.
await file.saveAs();
```

#### [remove(force = false)](#removeforce--false)
#### [remove(force = false, options = { ignorePinned = false, silentPinned = false })](#removeforce--false)
Removes and closes the file.

```js
await file.remove(true); // Force close without save prompt

// Attempt to close a pinned tab, bypassing the pinned check
// Attempt to close a pinned tab, bypassing the pinned check
await file.remove(false, { ignorePinned: true });

// Attempt to close a pinned tab silently (toast suppressed)
await file.remove(false, { silentPinned: true });
```

#### [makeActive()](#makeactive)
Expand All @@ -131,6 +140,23 @@ Removes active state from the file.
file.removeActive();
```

#### [setPinnedState(value: boolean, options = { reorder = false, emit = true })](#setpinnedstate)
Updates Pinned State for the file, triggers reorder (if true), emits Events (editorManager `update` event with `pin-tab` as the first argument and affected File - second argument )

```js
file.setPinnedState(false, {})

editorManager.on("update", (action, file) => {
if(action === "pin-tab") doSomething();
});
```

#### [togglePinned()](#togglepinned)
Toggles the pinned State of the file

```js
file.togglePinned();

### Editor Operations

#### [setMode(mode)](#setmodemode)
Expand Down
Loading