mirror of https://github.com/Hilbis/Hilbish
72 lines
1.5 KiB
Markdown
72 lines
1.5 KiB
Markdown
---
|
|
title: Hilbish
|
|
description:
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "Signals"
|
|
---
|
|
|
|
## hilbish.exit
|
|
Sent when Hilbish is going to exit.
|
|
|
|
#### Variables
|
|
This signal returns no variables.
|
|
|
|
<hr>
|
|
|
|
## hilbish.vimMode
|
|
Sent when the Vim mode of Hilbish is changed (like from insert to normal mode).
|
|
This can be used to change the prompt and notify based on Vim mode.
|
|
|
|
#### Variables
|
|
`string` **`modeName`**
|
|
The mode that has been set.
|
|
Can be these values: `insert`, `normal`, `delete` or `replace`
|
|
|
|
<hr>
|
|
|
|
## hilbish.cancel
|
|
Sent when the user cancels their command input with Ctrl-C
|
|
|
|
#### Variables
|
|
This signal returns no variables.
|
|
|
|
<hr>
|
|
|
|
## hilbish.notification
|
|
Thrown when a [notification](../../features/notifications) is sent.
|
|
|
|
#### Variables
|
|
`table` **`notification`**
|
|
The notification. The properties are defined in the link above.
|
|
|
|
<hr>
|
|
|
|
## hilbish.cd
|
|
Sent when the current directory of the shell is changed (via interactive means.)
|
|
If you are implementing a custom command that changes the directory of the shell,
|
|
you must throw this hook manually for correctness.
|
|
|
|
#### Variables
|
|
`string` **`path`**
|
|
Absolute path of the directory that was changed to.
|
|
|
|
`string` **`oldPath`**
|
|
Absolute path of the directory Hilbish *was* in.
|
|
|
|
<hr>
|
|
|
|
## hilbish.vimAction
|
|
Sent when the user does a "vim action," being something like yanking or pasting text.
|
|
See `doc vim-mode actions` for more info.
|
|
|
|
#### Variables
|
|
`string` **`actionName`**
|
|
Absolute path of the directory that was changed to.
|
|
|
|
`table` **`args`**
|
|
Table of args relating to the Vim action.
|
|
|
|
<hr>
|