Update how to use addons with Typescript #1444
Merged
Conversation
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
Tyriar
requested changes
May 10, 2018
README.md
Outdated
| @@ -57,7 +57,18 @@ The proposed way to load xterm.js is via the ES6 module syntax. | |||
| import { Terminal } from 'xterm'; | |||
| ``` | |||
|
|
|||
| *Note: There are currently no typings for addons so you will need to upcast if using TypeScript, eg. `(<any>xterm).fit()`.* | |||
| *Note: There are currently no typings for addons if they are accessed via extending Terminal prototype, so you will need to upcast if using TypeScript, eg. `(<any>xterm).fit()`.* | |||
There was a problem hiding this comment.
I think thus would be better called out briefly in the Addons section below. applyAddon should be recommended as an alternative imo, not the main way.
|
@Tyriar readme is updated |
Tyriar
approved these changes
May 11, 2018
|
Thanks 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.