Skip to content

Commit

Permalink
docs: cx.yanked plugin API
Browse files Browse the repository at this point in the history
  • Loading branch information
sxyazi committed Mar 7, 2024
1 parent 089775b commit 6f2337f
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/plugins/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ You can access all app data through the `cx` within [Sync context](./overview#sy
- `cx.active`: The active tab, which is a [tab::Tab](#tabtab)
- `cx.tabs`: All of tabs, which is a [manager::Tabs](#managertabs)
- `cx.tasks`: All of tasks, which is a [tasks::Tasks](#taskstasks)
- `cx.yanked`: The yanked urls, which is a [manager::Yanked](#manageryanked)

### `tab::Mode`

Expand All @@ -92,10 +93,6 @@ Properties:
- `is_unset`: Whether the mode is unset
- `is_visual`: Whether the mode is select or unset

Methods:

- `pending(idx, state)`: TODO

Meta methods:

- `__tostring()`
Expand Down Expand Up @@ -196,3 +193,14 @@ Properties:
processed = 0,
}
```

### `manager::Yanked`

Meta methods:

- `__len()`
- `__pairs()`: Iterate over the yanked [Url](#url)s

Methods:

- `is_cut()`: Whether the yanked urls are cut.

0 comments on commit 6f2337f

Please sign in to comment.