Skip to content

Commit

Permalink
docs: complete tab::Tab
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Jan 7, 2024
1 parent e8dcc5d commit 325f239
Showing 1 changed file with 39 additions and 26 deletions.
65 changes: 39 additions & 26 deletions docs/plugin/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,13 +331,13 @@ prompting plugin developers to create separate namespaces for their plugins to p

### `tab::Mode`

Visual mode status of the current tab.
Visual mode status.

Properties:

- `is_select`: Whether the current tab is in select mode
- `is_unset`: Whether the current tab is in unset mode
- `is_visual`: Whether the current tab is in select or unset mode
- `is_select`: Whether the mode is select
- `is_unset`: Whether the mode is unset
- `is_visual`: Whether the mode is select or unset

Methods:

Expand All @@ -353,27 +353,31 @@ TODO

Properties:

- sort_by
- sort_sensitive
- sort_reverse
- sort_dir_first
- linemode
- show_hidden
- `sort_by`
- `sort_sensitive`
- `sort_reverse`
- `sort_dir_first`
- `linemode`
- `show_hidden`

### `tab::Preview`

TODO

Properties:

- skip
- folder
- `skip`
- `folder`

### `manager::Tabs`
### `folder::Folder`

TODO
### `folder::Files`

### `manager::Tabs`

Properties:

- idx
- `idx`: The index of the active tab

Meta methods:

Expand All @@ -382,27 +386,36 @@ Meta methods:

### `tab::Tab`

TODO

Properties:

- mode
- conf
- parent
- current
- preview
- `mode`: The [tab::Mode](#tabmode) of this tab
- `conf`: The [tab::Config](#tabconfig) of this tab
- `parent`: The parent folder within this tab, which is a [folder::Folder](#folderfolder)
- `current`: The current folder within this tab, which is a [folder::Folder](#folderfolder)
- `preview`: The [tab::Preview](#tabpreview) within this tab

Methods:

- name()
- `name()`: The name of this tab

### `tasks::Tasks`

TODO

Properties:

- progress
- `progress`: The progress of all tasks, which is a table:

```lua
{
-- Number of tasks
total = 0,
succ = 0,
fail = 0,

-- Workload of tasks
found = 0,
processed = 0,
}
```

## Isolate context

Expand Down

0 comments on commit 325f239

Please sign in to comment.