-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
pro-src
committed
May 25, 2018
1 parent
4104182
commit a0e2117
Showing
10 changed files
with
2,109 additions
and
416 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
title: IDisposable | ||
category: API-interfaces | ||
layout: docs | ||
--- | ||
|
||
|
||
# Interface: IDisposable | ||
|
||
An object that can be disposed via a dispose function. | ||
|
||
## Hierarchy | ||
|
||
**IDisposable** | ||
|
||
↳ [IMarker](../imarker) | ||
|
||
## Implemented by | ||
|
||
* [Terminal](../../classes/terminal) | ||
|
||
## Index | ||
|
||
### Methods | ||
|
||
* [dispose](#dispose) | ||
|
||
--- | ||
|
||
## Methods | ||
|
||
<a id="dispose"></a> | ||
|
||
### dispose | ||
|
||
▸ **dispose**(): `void` | ||
|
||
*Defined in [xterm.d.ts:259](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L259)* | ||
|
||
**Returns:** `void` | ||
|
||
___ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
--- | ||
title: IEventEmitter | ||
category: API-interfaces | ||
layout: docs | ||
--- | ||
|
||
|
||
# Interface: IEventEmitter | ||
|
||
## Hierarchy | ||
|
||
**IEventEmitter** | ||
|
||
## Implemented by | ||
|
||
* [Terminal](../../classes/terminal) | ||
|
||
## Index | ||
|
||
### Methods | ||
|
||
* [addDisposableListener](#adddisposablelistener) | ||
* [emit](#emit) | ||
* [off](#off) | ||
* [on](#on) | ||
|
||
--- | ||
|
||
## Methods | ||
|
||
<a id="adddisposablelistener"></a> | ||
|
||
### addDisposableListener | ||
|
||
▸ **addDisposableListener**(type: *`string`*, handler: *`function`*): [IDisposable](../idisposable) | ||
|
||
*Defined in [xterm.d.ts:252](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L252)* | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| type | `string` | | ||
| handler | `function` | | ||
|
||
**Returns:** [IDisposable](../idisposable) | ||
|
||
___ | ||
<a id="emit"></a> | ||
|
||
### emit | ||
|
||
▸ **emit**(type: *`string`*, data?: *`any`*): `void` | ||
|
||
*Defined in [xterm.d.ts:251](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L251)* | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| type | `string` | | ||
| `Optional` data | `any` | | ||
|
||
**Returns:** `void` | ||
|
||
___ | ||
<a id="off"></a> | ||
|
||
### off | ||
|
||
▸ **off**(type: *`string`*, listener: *`function`*): `void` | ||
|
||
*Defined in [xterm.d.ts:250](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L250)* | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| type | `string` | | ||
| listener | `function` | | ||
|
||
**Returns:** `void` | ||
|
||
___ | ||
<a id="on"></a> | ||
|
||
### on | ||
|
||
▸ **on**(type: *`string`*, listener: *`function`*): `void` | ||
|
||
*Defined in [xterm.d.ts:249](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L249)* | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| type | `string` | | ||
| listener | `function` | | ||
|
||
**Returns:** `void` | ||
|
||
___ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
--- | ||
title: ILinkMatcherOptions | ||
category: API-interfaces | ||
layout: docs | ||
--- | ||
|
||
|
||
# Interface: ILinkMatcherOptions | ||
|
||
An object containing options for a link matcher. | ||
|
||
## Hierarchy | ||
|
||
**ILinkMatcherOptions** | ||
|
||
## Index | ||
|
||
### Properties | ||
|
||
* [leaveCallback](#leavecallback) | ||
* [matchIndex](#matchindex) | ||
* [priority](#priority) | ||
* [tooltipCallback](#tooltipcallback) | ||
* [validationCallback](#validationcallback) | ||
* [willLinkActivate](#willlinkactivate) | ||
|
||
--- | ||
|
||
## Properties | ||
|
||
<a id="leavecallback"></a> | ||
|
||
### `<Optional>` leaveCallback | ||
|
||
**● leaveCallback**: *`function`* | ||
|
||
*Defined in [xterm.d.ts:230](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L230)* | ||
|
||
A callback that fires when the mouse leaves a link. Note that this can happen even when tooltipCallback hasn't fired for the link yet. | ||
|
||
#### Type declaration | ||
▸(event: *`MouseEvent`*, uri: *`string`*): `boolean` | `void` | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| event | `MouseEvent` | | ||
| uri | `string` | | ||
|
||
**Returns:** `boolean` | `void` | ||
|
||
___ | ||
<a id="matchindex"></a> | ||
|
||
### `<Optional>` matchIndex | ||
|
||
**● matchIndex**: *`number`* | ||
|
||
*Defined in [xterm.d.ts:213](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L213)* | ||
|
||
The index of the link from the regex.match(text) call. This defaults to 0 (for regular expressions without capture groups). | ||
|
||
___ | ||
<a id="priority"></a> | ||
|
||
### `<Optional>` priority | ||
|
||
**● priority**: *`number`* | ||
|
||
*Defined in [xterm.d.ts:237](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L237)* | ||
|
||
The priority of the link matcher, this defines the order in which the link matcher is evaluated relative to others, from highest to lowest. The default value is 0. | ||
|
||
___ | ||
<a id="tooltipcallback"></a> | ||
|
||
### `<Optional>` tooltipCallback | ||
|
||
**● tooltipCallback**: *`function`* | ||
|
||
*Defined in [xterm.d.ts:224](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L224)* | ||
|
||
A callback that fires when the mouse hovers over a link for a moment. | ||
|
||
#### Type declaration | ||
▸(event: *`MouseEvent`*, uri: *`string`*): `boolean` | `void` | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| event | `MouseEvent` | | ||
| uri | `string` | | ||
|
||
**Returns:** `boolean` | `void` | ||
|
||
___ | ||
<a id="validationcallback"></a> | ||
|
||
### `<Optional>` validationCallback | ||
|
||
**● validationCallback**: *`function`* | ||
|
||
*Defined in [xterm.d.ts:219](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L219)* | ||
|
||
A callback that validates whether to create an individual link, pass whether the link is valid to the callback. | ||
|
||
#### Type declaration | ||
▸(uri: *`string`*, callback: *`function`*): `void` | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| uri | `string` | | ||
| callback | `function` | | ||
|
||
**Returns:** `void` | ||
|
||
___ | ||
<a id="willlinkactivate"></a> | ||
|
||
### `<Optional>` willLinkActivate | ||
|
||
**● willLinkActivate**: *`function`* | ||
|
||
*Defined in [xterm.d.ts:245](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L245)* | ||
|
||
A callback that fires when the mousedown and click events occur that determines whether a link will be activated upon click. This enables only activating a link when a certain modifier is held down, if not the mouse event will continue propagation (eg. double click to select word). | ||
|
||
#### Type declaration | ||
▸(event: *`MouseEvent`*, uri: *`string`*): `boolean` | ||
|
||
**Parameters:** | ||
|
||
| Param | Type | | ||
| ------ | ------ | | ||
| event | `MouseEvent` | | ||
| uri | `string` | | ||
|
||
**Returns:** `boolean` | ||
|
||
___ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: ILocalizableStrings | ||
category: API-interfaces | ||
layout: docs | ||
--- | ||
|
||
|
||
# Interface: ILocalizableStrings | ||
|
||
## Hierarchy | ||
|
||
**ILocalizableStrings** | ||
|
||
## Index | ||
|
||
### Properties | ||
|
||
* [blankLine](#blankline) | ||
* [promptLabel](#promptlabel) | ||
* [tooMuchOutput](#toomuchoutput) | ||
|
||
--- | ||
|
||
## Properties | ||
|
||
<a id="blankline"></a> | ||
|
||
### blankLine | ||
|
||
**● blankLine**: *`string`* | ||
|
||
*Defined in [xterm.d.ts:269](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L269)* | ||
|
||
___ | ||
<a id="promptlabel"></a> | ||
|
||
### promptLabel | ||
|
||
**● promptLabel**: *`string`* | ||
|
||
*Defined in [xterm.d.ts:270](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L270)* | ||
|
||
___ | ||
<a id="toomuchoutput"></a> | ||
|
||
### tooMuchOutput | ||
|
||
**● tooMuchOutput**: *`string`* | ||
|
||
*Defined in [xterm.d.ts:271](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts#L271)* | ||
|
||
___ | ||
|
Oops, something went wrong.