forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
markitup.d.ts
237 lines (193 loc) · 6.58 KB
/
markitup.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
// Type definitions for markitup 1.x
// Project: https://github.com/markitup/1.x
// Definitions by: drillbits <https://github.com/drillbits>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/// <reference path="../jquery/jquery.d.ts" />
declare module MarkItUp {
interface Options {
/**
* Apply a specific className to the wrapping Div. Useful to prevent CSS conflicts between instances.
*/
nameSpace?: string;
/**
* Enable/Disable the handle to resize the editor.
*/
resizeHandle?: boolean;
/**
* Display the preview in a popup window with comma-separated list of specs. If empty or false, the preview will be displayed in the built-in iFrame preview.
*/
previewInWindow?: string;
/**
* AutoRefresh the preview iFrame or window when the editor is used.
*/
previewAutoRefresh?: boolean;
/**
* You can set the path of your own parser to preview markup languages other than html. If this property is set, the built-in preview will be overridden by your own preview script.
* Use ~/ for markItUp! root.
*/
previewParserPath?: string;
/**
* Name of the var posted with the editor content to the parser defined above.
*
* default: 'data'
*/
previewParserVar?: string;
/**
* Path to the Html preview template.
* Use ~/ for markItUp! root.
*
* default: '~/templates/preview.html'
*/
previewTemplatePath?: string;
/**
* Parse the content with the javascript parser of your choice before passing it to the preview.
*
* default: false
*/
previewParser?: boolean;
/**
* Position of the Built-in preview before or after the main textarea.
* 'before'|'after'
*
* default: 'after'
*/
previewPosition?: string;
/**
* Define what to do when Enter key is pressed.
*/
onEnter?: MarkupSet;
/**
* Define what to do when Ctrl+Enter keys are pressed.
*/
onCtrlEnter?: MarkupSet;
/**
* Define what to do when Shift+Enter keys are pressed.
*/
onShiftEnter?: MarkupSet;
/**
* Define what to do when Tab key is pressed. Warning, this key is also used to jump at the end of a new inserted markup.
*/
onTab?: MarkupSet;
/**
* Function to be called before any markup insertion.
*/
beforeInsert?: (h: MarkupSet) => string;
/**
* Function to be called after any markup insertion.
*/
afterInsert?: (h: MarkupSet) => string;
/**
* Note that most of the settings below are used by the engine for all insertion calls ($.markItUp( {} ), onEnter, onShiftEnter, onCtrlEnter, onTab) except exclusive button properties marked by
*/
markupSet?: MarkupSet[];
}
interface MarkupSet {
/**
* Button name
*/
name?: string;
/**
* Classname to be applied to this very button.
*/
className?: string;
/**
* Shortcut key to be applied to the button. Ctrl+key trigger the action of a button.
*/
key?: string;
/**
* Markup to be added before selection. Accepts functions.
*/
openWith?: string|((h: MarkupSet) => string);
/**
* Markup to be added after selection. Accepts functions.
*/
closeWith?: string|((h: MarkupSet) => string);
/**
* Text to be added in place of the cursor or selection. Accepts functions.
*/
replaceWith?: string|((h: MarkupSet) => string);
/**
* Text to be added before a whole block. Accepts functions.
*/
openBlockWith?: string|((h: MarkupSet) => string);
/**
* Text to be added after a whole block. Accepts functions.
*/
closeBlockWith?: string|((h: MarkupSet) => string);
/**
* Set whether the tags has to be inserted at each line or on the whole selected block.
*/
multiline?: boolean;
/**
* Placeholder text to be inserted if no text is selected by the user.
*/
placeHolder?: string|((h: MarkupSet) => string);
/**
* Function to be called just before a markup insertion. If a global beforeInsert callback is already defined this function is fired just after.
*/
beforeInsert?: (h: MarkupSet) => string;
/**
* Function to be called just after a markup insertion. If a global afterInsert callback is already defined this function is fired before.
*/
afterInsert?: (h: MarkupSet) => string;
/**
* Function to be called before a multiline markup insertion.
*/
beforeMultiInsert?: (h: MarkupSet) => string;
/**
* Function to be called after a multiline markup insertion.
*/
afterMultiInsert?: (h: MarkupSet) => string;
/**
* Open a dropdown menu with another button set.
*/
dropMenu?: MarkupSet[];
/**
* Keep (true) or not (false) the default behaviour of the key.
*/
keepDefault?: boolean;
/**
* Returns the selection.
*/
selection?: string;
/**
* Returns the textarea object.
*/
textarea?: HTMLElement;
/**
* Returns the position of the selection.
*/
caretPosition?: number;
/**
* Returns the position of the scrollbar.
*/
scrollPosition?: number;
/**
* If a multi-line edition is trigged (Ctrl + Shift + click). This property return the number of the line being processed.
*/
line?: number;
/**
* Returns true if the Control key is pressed when the callback is fired.
*/
ctrlKey?: boolean;
/**
* Returns true if the Shift key is pressed when the callback is fired.
*/
shiftKey?: boolean;
/**
* Returns true if the Alt key is pressed when the callback is fired.
*/
altKey?: boolean;
}
interface Static {
(): JQuery;
(settings: Options): JQuery;
}
}
interface JQueryStatic {
markItUp: MarkItUp.Static;
}
interface JQuery {
markItUp(settings?: MarkItUp.Options): JQuery;
markItUpRemove(): JQuery;
}