vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-06-28 22:30:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #17612 from mbilsing/master

Browse Source 
Fixes CodeMirror's show-hint module to use the Editor object instead of the Doc object in most parameters
This commit is contained in:
Ryan Cavanaugh
2017-07-10 16:09:02 -07:00
committed by GitHub
parent 81f4a41840 6cfc342e87
commit e545c1e19a
2 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
types/codemirror/codemirror-showhint.d.ts vendored
View File

@@ -1,6 +1,8 @@
// Type definitions for CodeMirror
// Project: https://github.com/marijnh/CodeMirror
// Definitions by: jacqt <https://github.com/jacqt>, basarat <https://github.com/basarat>
// Definitions by: jacqt <https://github.com/jacqt>
// basarat <https://github.com/basarat>
// mbilsing <https://github.com/mbilsing>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// See docs https://codemirror.net/doc/manual.html#addon_show-hint
@@ -16,7 +18,7 @@ declare module "codemirror" {
and return a {list, from, to} object, where list is an array of strings or objects (the completions), and
from and to give the start and end of the token that is being completed as {line, ch} objects. An optional
selectedHint property (an integer) can be added to the completion object to control the initially selected hint. */
function showHint(cm: CodeMirror.Doc, hinter?: HintFunction, options?: ShowHintOptions): void;
function showHint(cm: CodeMirror.Editor, hinter?: HintFunction, options?: ShowHintOptions): void;
interface Hints {
from: Position;
@@ -32,7 +34,7 @@ declare module "codemirror" {
displayText?: string;
from?: Position;
/** Called if a completion is picked. If provided *you* are responsible for applying the completion */
hint?: (cm: any, data: Hints, cur: Hint) => void;
hint?: (cm: CodeMirror.Editor, data: Hints, cur: Hint) => void;
render?: (element: HTMLLIElement, data: Hints, cur: Hint) => void;
to?: Position;
}
@@ -41,18 +43,15 @@ declare module "codemirror" {
/** An extension of the existing CodeMirror typings for the Editor.on("keyup", func) syntax */
on(eventName: string, handler: (doc: CodeMirror.Doc, event: any) => void): void;
off(eventName: string, handler: (doc: CodeMirror.Doc, event: any) => void): void;
}
interface Doc {
showHint: (options: ShowHintOptions) => void;
}
interface HintFunction {
(doc: CodeMirror.Doc): Hints;
(cm: CodeMirror.Editor): Hints;
}
interface AsyncHintFunction {
(doc: CodeMirror.Doc, callback: (hints: Hints) => any): any;
(cm: CodeMirror.Editor, callback: (hints: Hints) => any): any;
async?: boolean;
}

12
types/codemirror/test/showhint.ts
View File

@@ -1,16 +1,16 @@
var doc = new CodeMirror.Doc('text');
var cm = CodeMirror(document.body, {value: 'text'});
var pos = new CodeMirror.Pos(2, 3);
CodeMirror.showHint(doc);
CodeMirror.showHint(doc, function (cm) {
CodeMirror.showHint(cm);
CodeMirror.showHint(cm, function (cm) {
return {
from: pos,
list: ["one", "two"],
to: pos
};
});
CodeMirror.showHint(doc, function (cm) {
CodeMirror.showHint(cm, function (cm) {
return {
from: pos,
list: [
@@ -32,7 +32,7 @@ CodeMirror.showHint(doc, function (cm) {
};
});
var asyncHintFunc : CodeMirror.AsyncHintFunction =
(doc: CodeMirror.Doc, callback: (hints: CodeMirror.Hints) => any) => {
(cm: CodeMirror.Editor, callback: (hints: CodeMirror.Hints) => any) => {
callback({
from: pos,
list: ["one", "two"],
@@ -41,7 +41,7 @@ var asyncHintFunc : CodeMirror.AsyncHintFunction =
};
asyncHintFunc.async = true;
doc.showHint({
cm.showHint({
completeSingle: false,
hint: asyncHintFunc
})