tinymce.d.ts 123 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254
  1. interface StringPathBookmark {
  2. start: string;
  3. end?: string;
  4. forward?: boolean;
  5. }
  6. interface RangeBookmark {
  7. rng: Range;
  8. forward?: boolean;
  9. }
  10. interface IdBookmark {
  11. id: string;
  12. keep?: boolean;
  13. forward?: boolean;
  14. }
  15. interface IndexBookmark {
  16. name: string;
  17. index: number;
  18. }
  19. interface PathBookmark {
  20. start: number[];
  21. end?: number[];
  22. isFakeCaret?: boolean;
  23. forward?: boolean;
  24. }
  25. type Bookmark = StringPathBookmark | RangeBookmark | IdBookmark | IndexBookmark | PathBookmark;
  26. type NormalizedEvent<E, T = any> = E & {
  27. readonly type: string;
  28. readonly target: T;
  29. readonly isDefaultPrevented: () => boolean;
  30. readonly preventDefault: () => void;
  31. readonly isPropagationStopped: () => boolean;
  32. readonly stopPropagation: () => void;
  33. readonly isImmediatePropagationStopped: () => boolean;
  34. readonly stopImmediatePropagation: () => void;
  35. };
  36. type MappedEvent<T extends {}, K extends string> = K extends keyof T ? T[K] : any;
  37. interface NativeEventMap {
  38. 'beforepaste': Event;
  39. 'blur': FocusEvent;
  40. 'beforeinput': InputEvent;
  41. 'click': MouseEvent;
  42. 'compositionend': Event;
  43. 'compositionstart': Event;
  44. 'compositionupdate': Event;
  45. 'contextmenu': PointerEvent;
  46. 'copy': ClipboardEvent;
  47. 'cut': ClipboardEvent;
  48. 'dblclick': MouseEvent;
  49. 'drag': DragEvent;
  50. 'dragdrop': DragEvent;
  51. 'dragend': DragEvent;
  52. 'draggesture': DragEvent;
  53. 'dragover': DragEvent;
  54. 'dragstart': DragEvent;
  55. 'drop': DragEvent;
  56. 'focus': FocusEvent;
  57. 'focusin': FocusEvent;
  58. 'focusout': FocusEvent;
  59. 'input': InputEvent;
  60. 'keydown': KeyboardEvent;
  61. 'keypress': KeyboardEvent;
  62. 'keyup': KeyboardEvent;
  63. 'mousedown': MouseEvent;
  64. 'mouseenter': MouseEvent;
  65. 'mouseleave': MouseEvent;
  66. 'mousemove': MouseEvent;
  67. 'mouseout': MouseEvent;
  68. 'mouseover': MouseEvent;
  69. 'mouseup': MouseEvent;
  70. 'paste': ClipboardEvent;
  71. 'selectionchange': Event;
  72. 'submit': Event;
  73. 'touchend': TouchEvent;
  74. 'touchmove': TouchEvent;
  75. 'touchstart': TouchEvent;
  76. 'touchcancel': TouchEvent;
  77. 'wheel': WheelEvent;
  78. }
  79. type EditorEvent<T> = NormalizedEvent<T>;
  80. interface EventDispatcherSettings {
  81. scope?: any;
  82. toggleEvent?: (name: string, state: boolean) => void | boolean;
  83. beforeFire?: <T>(args: EditorEvent<T>) => void;
  84. }
  85. interface EventDispatcherConstructor<T extends {}> {
  86. readonly prototype: EventDispatcher<T>;
  87. new (settings?: EventDispatcherSettings): EventDispatcher<T>;
  88. isNative: (name: string) => boolean;
  89. }
  90. declare class EventDispatcher<T extends {}> {
  91. static isNative(name: string): boolean;
  92. private readonly settings;
  93. private readonly scope;
  94. private readonly toggleEvent;
  95. private bindings;
  96. constructor(settings?: EventDispatcherSettings);
  97. fire<K extends string, U extends MappedEvent<T, K>>(name: K, args?: U): EditorEvent<U>;
  98. dispatch<K extends string, U extends MappedEvent<T, K>>(name: K, args?: U): EditorEvent<U>;
  99. on<K extends string>(name: K, callback: false | ((event: EditorEvent<MappedEvent<T, K>>) => void | boolean), prepend?: boolean, extra?: {}): this;
  100. off<K extends string>(name?: K, callback?: (event: EditorEvent<MappedEvent<T, K>>) => void): this;
  101. once<K extends string>(name: K, callback: (event: EditorEvent<MappedEvent<T, K>>) => void, prepend?: boolean): this;
  102. has(name: string): boolean;
  103. }
  104. type UndoLevelType = 'fragmented' | 'complete';
  105. interface BaseUndoLevel {
  106. type: UndoLevelType;
  107. bookmark: Bookmark | null;
  108. beforeBookmark: Bookmark | null;
  109. }
  110. interface FragmentedUndoLevel extends BaseUndoLevel {
  111. type: 'fragmented';
  112. fragments: string[];
  113. content: '';
  114. }
  115. interface CompleteUndoLevel extends BaseUndoLevel {
  116. type: 'complete';
  117. fragments: null;
  118. content: string;
  119. }
  120. type NewUndoLevel = CompleteUndoLevel | FragmentedUndoLevel;
  121. type UndoLevel = NewUndoLevel & {
  122. bookmark: Bookmark;
  123. };
  124. interface UndoManager {
  125. data: UndoLevel[];
  126. typing: boolean;
  127. add: (level?: Partial<UndoLevel>, event?: EditorEvent<any>) => UndoLevel | null;
  128. dispatchChange: () => void;
  129. beforeChange: () => void;
  130. undo: () => UndoLevel | undefined;
  131. redo: () => UndoLevel | undefined;
  132. clear: () => void;
  133. reset: () => void;
  134. hasUndo: () => boolean;
  135. hasRedo: () => boolean;
  136. transact: (callback: () => void) => UndoLevel | null;
  137. ignore: (callback: () => void) => void;
  138. extra: (callback1: () => void, callback2: () => void) => void;
  139. }
  140. type SchemaType = 'html4' | 'html5' | 'html5-strict';
  141. interface ElementSettings {
  142. block_elements?: string;
  143. boolean_attributes?: string;
  144. move_caret_before_on_enter_elements?: string;
  145. non_empty_elements?: string;
  146. self_closing_elements?: string;
  147. text_block_elements?: string;
  148. text_inline_elements?: string;
  149. void_elements?: string;
  150. whitespace_elements?: string;
  151. transparent_elements?: string;
  152. wrap_block_elements?: string;
  153. }
  154. interface SchemaSettings extends ElementSettings {
  155. custom_elements?: string | Record<string, CustomElementSpec>;
  156. extended_valid_elements?: string;
  157. invalid_elements?: string;
  158. invalid_styles?: string | Record<string, string>;
  159. schema?: SchemaType;
  160. valid_children?: string;
  161. valid_classes?: string | Record<string, string>;
  162. valid_elements?: string;
  163. valid_styles?: string | Record<string, string>;
  164. verify_html?: boolean;
  165. padd_empty_block_inline_children?: boolean;
  166. }
  167. interface Attribute {
  168. required?: boolean;
  169. defaultValue?: string;
  170. forcedValue?: string;
  171. validValues?: Record<string, {}>;
  172. }
  173. interface DefaultAttribute {
  174. name: string;
  175. value: string;
  176. }
  177. interface AttributePattern extends Attribute {
  178. pattern: RegExp;
  179. }
  180. interface ElementRule {
  181. attributes: Record<string, Attribute>;
  182. attributesDefault?: DefaultAttribute[];
  183. attributesForced?: DefaultAttribute[];
  184. attributesOrder: string[];
  185. attributePatterns?: AttributePattern[];
  186. attributesRequired?: string[];
  187. paddEmpty?: boolean;
  188. removeEmpty?: boolean;
  189. removeEmptyAttrs?: boolean;
  190. paddInEmptyBlock?: boolean;
  191. }
  192. interface SchemaElement extends ElementRule {
  193. outputName?: string;
  194. parentsRequired?: string[];
  195. pattern?: RegExp;
  196. }
  197. interface SchemaMap {
  198. [name: string]: {};
  199. }
  200. interface SchemaRegExpMap {
  201. [name: string]: RegExp;
  202. }
  203. interface CustomElementSpec {
  204. extends?: string;
  205. attributes?: string[];
  206. children?: string[];
  207. padEmpty?: boolean;
  208. }
  209. interface Schema {
  210. type: SchemaType;
  211. children: Record<string, SchemaMap>;
  212. elements: Record<string, SchemaElement>;
  213. getValidStyles: () => Record<string, string[]> | undefined;
  214. getValidClasses: () => Record<string, SchemaMap> | undefined;
  215. getBlockElements: () => SchemaMap;
  216. getInvalidStyles: () => Record<string, SchemaMap> | undefined;
  217. getVoidElements: () => SchemaMap;
  218. getTextBlockElements: () => SchemaMap;
  219. getTextInlineElements: () => SchemaMap;
  220. getBoolAttrs: () => SchemaMap;
  221. getElementRule: (name: string) => SchemaElement | undefined;
  222. getSelfClosingElements: () => SchemaMap;
  223. getNonEmptyElements: () => SchemaMap;
  224. getMoveCaretBeforeOnEnterElements: () => SchemaMap;
  225. getWhitespaceElements: () => SchemaMap;
  226. getTransparentElements: () => SchemaMap;
  227. getSpecialElements: () => SchemaRegExpMap;
  228. isValidChild: (name: string, child: string) => boolean;
  229. isValid: (name: string, attr?: string) => boolean;
  230. isBlock: (name: string) => boolean;
  231. isInline: (name: string) => boolean;
  232. isWrapper: (name: string) => boolean;
  233. getCustomElements: () => SchemaMap;
  234. addValidElements: (validElements: string) => void;
  235. setValidElements: (validElements: string) => void;
  236. addCustomElements: (customElements: string | Record<string, CustomElementSpec>) => void;
  237. addValidChildren: (validChildren: any) => void;
  238. }
  239. type Attributes$1 = Array<{
  240. name: string;
  241. value: string;
  242. }> & {
  243. map: Record<string, string>;
  244. };
  245. interface AstNodeConstructor {
  246. readonly prototype: AstNode;
  247. new (name: string, type: number): AstNode;
  248. create(name: string, attrs?: Record<string, string>): AstNode;
  249. }
  250. declare class AstNode {
  251. static create(name: string, attrs?: Record<string, string>): AstNode;
  252. name: string;
  253. type: number;
  254. attributes?: Attributes$1;
  255. value?: string;
  256. parent?: AstNode | null;
  257. firstChild?: AstNode | null;
  258. lastChild?: AstNode | null;
  259. next?: AstNode | null;
  260. prev?: AstNode | null;
  261. raw?: boolean;
  262. constructor(name: string, type: number);
  263. replace(node: AstNode): AstNode;
  264. attr(name: string, value: string | null | undefined): AstNode | undefined;
  265. attr(name: Record<string, string | null | undefined> | undefined): AstNode | undefined;
  266. attr(name: string): string | undefined;
  267. clone(): AstNode;
  268. wrap(wrapper: AstNode): AstNode;
  269. unwrap(): void;
  270. remove(): AstNode;
  271. append(node: AstNode): AstNode;
  272. insert(node: AstNode, refNode: AstNode, before?: boolean): AstNode;
  273. getAll(name: string): AstNode[];
  274. children(): AstNode[];
  275. empty(): AstNode;
  276. isEmpty(elements: SchemaMap, whitespace?: SchemaMap, predicate?: (node: AstNode) => boolean): boolean;
  277. walk(prev?: boolean): AstNode | null | undefined;
  278. }
  279. type Content = string | AstNode;
  280. type ContentFormat = 'raw' | 'text' | 'html' | 'tree';
  281. interface GetContentArgs {
  282. format: ContentFormat;
  283. get: boolean;
  284. getInner: boolean;
  285. no_events?: boolean;
  286. save?: boolean;
  287. source_view?: boolean;
  288. [key: string]: any;
  289. }
  290. interface SetContentArgs {
  291. format: string;
  292. set: boolean;
  293. content: Content;
  294. no_events?: boolean;
  295. no_selection?: boolean;
  296. paste?: boolean;
  297. load?: boolean;
  298. initial?: boolean;
  299. [key: string]: any;
  300. }
  301. interface GetSelectionContentArgs extends GetContentArgs {
  302. selection?: boolean;
  303. contextual?: boolean;
  304. }
  305. interface SetSelectionContentArgs extends SetContentArgs {
  306. content: string;
  307. selection?: boolean;
  308. }
  309. interface BlobInfoData {
  310. id?: string;
  311. name?: string;
  312. filename?: string;
  313. blob: Blob;
  314. base64: string;
  315. blobUri?: string;
  316. uri?: string;
  317. }
  318. interface BlobInfo {
  319. id: () => string;
  320. name: () => string;
  321. filename: () => string;
  322. blob: () => Blob;
  323. base64: () => string;
  324. blobUri: () => string;
  325. uri: () => string | undefined;
  326. }
  327. interface BlobCache {
  328. create: {
  329. (o: BlobInfoData): BlobInfo;
  330. (id: string, blob: Blob, base64: string, name?: string, filename?: string): BlobInfo;
  331. };
  332. add: (blobInfo: BlobInfo) => void;
  333. get: (id: string) => BlobInfo | undefined;
  334. getByUri: (blobUri: string) => BlobInfo | undefined;
  335. getByData: (base64: string, type: string) => BlobInfo | undefined;
  336. findFirst: (predicate: (blobInfo: BlobInfo) => boolean) => BlobInfo | undefined;
  337. removeByUri: (blobUri: string) => void;
  338. destroy: () => void;
  339. }
  340. interface BlobInfoImagePair {
  341. image: HTMLImageElement;
  342. blobInfo: BlobInfo;
  343. }
  344. declare class NodeChange {
  345. private readonly editor;
  346. private lastPath;
  347. constructor(editor: Editor);
  348. nodeChanged(args?: Record<string, any>): void;
  349. private isSameElementPath;
  350. }
  351. interface SelectionOverrides {
  352. showCaret: (direction: number, node: HTMLElement, before: boolean, scrollIntoView?: boolean) => Range | null;
  353. showBlockCaretContainer: (blockCaretContainer: HTMLElement) => void;
  354. hideFakeCaret: () => void;
  355. destroy: () => void;
  356. }
  357. interface Quirks {
  358. refreshContentEditable(): void;
  359. isHidden(): boolean;
  360. }
  361. type DecoratorData = Record<string, any>;
  362. type Decorator = (uid: string, data: DecoratorData) => {
  363. attributes?: {};
  364. classes?: string[];
  365. };
  366. type AnnotationListener = (state: boolean, name: string, data?: {
  367. uid: string;
  368. nodes: any[];
  369. }) => void;
  370. type AnnotationListenerApi = AnnotationListener;
  371. interface AnnotatorSettings {
  372. decorate: Decorator;
  373. persistent?: boolean;
  374. }
  375. interface Annotator {
  376. register: (name: string, settings: AnnotatorSettings) => void;
  377. annotate: (name: string, data: DecoratorData) => void;
  378. annotationChanged: (name: string, f: AnnotationListenerApi) => void;
  379. remove: (name: string) => void;
  380. removeAll: (name: string) => void;
  381. getAll: (name: string) => Record<string, Element[]>;
  382. }
  383. interface IsEmptyOptions {
  384. readonly skipBogus?: boolean;
  385. readonly includeZwsp?: boolean;
  386. readonly checkRootAsContent?: boolean;
  387. readonly isContent?: (node: Node) => boolean;
  388. }
  389. interface GeomRect {
  390. readonly x: number;
  391. readonly y: number;
  392. readonly w: number;
  393. readonly h: number;
  394. }
  395. interface Rect {
  396. inflate: (rect: GeomRect, w: number, h: number) => GeomRect;
  397. relativePosition: (rect: GeomRect, targetRect: GeomRect, rel: string) => GeomRect;
  398. findBestRelativePosition: (rect: GeomRect, targetRect: GeomRect, constrainRect: GeomRect, rels: string[]) => string | null;
  399. intersect: (rect: GeomRect, cropRect: GeomRect) => GeomRect | null;
  400. clamp: (rect: GeomRect, clampRect: GeomRect, fixedSize?: boolean) => GeomRect;
  401. create: (x: number, y: number, w: number, h: number) => GeomRect;
  402. fromClientRect: (clientRect: DOMRect) => GeomRect;
  403. }
  404. interface NotificationManagerImpl {
  405. open: (spec: NotificationSpec, closeCallback: () => void, hasEditorFocus: () => boolean) => NotificationApi;
  406. close: <T extends NotificationApi>(notification: T) => void;
  407. getArgs: <T extends NotificationApi>(notification: T) => NotificationSpec;
  408. }
  409. interface NotificationSpec {
  410. type?: 'info' | 'warning' | 'error' | 'success';
  411. text: string;
  412. icon?: string;
  413. progressBar?: boolean;
  414. timeout?: number;
  415. }
  416. interface NotificationApi {
  417. close: () => void;
  418. progressBar: {
  419. value: (percent: number) => void;
  420. };
  421. text: (text: string) => void;
  422. reposition: () => void;
  423. getEl: () => HTMLElement;
  424. settings: NotificationSpec;
  425. }
  426. interface NotificationManager {
  427. open: (spec: NotificationSpec) => NotificationApi;
  428. close: () => void;
  429. getNotifications: () => NotificationApi[];
  430. }
  431. interface UploadFailure {
  432. message: string;
  433. remove?: boolean;
  434. }
  435. type ProgressFn = (percent: number) => void;
  436. type UploadHandler = (blobInfo: BlobInfo, progress: ProgressFn) => Promise<string>;
  437. interface UploadResult$2 {
  438. url: string;
  439. blobInfo: BlobInfo;
  440. status: boolean;
  441. error?: UploadFailure;
  442. }
  443. type BlockPatternTrigger = 'enter' | 'space';
  444. interface RawPattern {
  445. start?: any;
  446. end?: any;
  447. format?: any;
  448. cmd?: any;
  449. value?: any;
  450. replacement?: any;
  451. trigger?: BlockPatternTrigger;
  452. }
  453. interface InlineBasePattern {
  454. readonly start: string;
  455. readonly end: string;
  456. }
  457. interface InlineFormatPattern extends InlineBasePattern {
  458. readonly type: 'inline-format';
  459. readonly format: string[];
  460. }
  461. interface InlineCmdPattern extends InlineBasePattern {
  462. readonly type: 'inline-command';
  463. readonly cmd: string;
  464. readonly value?: any;
  465. }
  466. type InlinePattern = InlineFormatPattern | InlineCmdPattern;
  467. interface BlockBasePattern {
  468. readonly start: string;
  469. readonly trigger: BlockPatternTrigger;
  470. }
  471. interface BlockFormatPattern extends BlockBasePattern {
  472. readonly type: 'block-format';
  473. readonly format: string;
  474. }
  475. interface BlockCmdPattern extends BlockBasePattern {
  476. readonly type: 'block-command';
  477. readonly cmd: string;
  478. readonly value?: any;
  479. }
  480. type BlockPattern = BlockFormatPattern | BlockCmdPattern;
  481. type Pattern = InlinePattern | BlockPattern;
  482. interface DynamicPatternContext {
  483. readonly text: string;
  484. readonly block: Element;
  485. }
  486. type DynamicPatternsLookup = (ctx: DynamicPatternContext) => Pattern[];
  487. type RawDynamicPatternsLookup = (ctx: DynamicPatternContext) => RawPattern[];
  488. interface AlertBannerSpec {
  489. type: 'alertbanner';
  490. level: 'info' | 'warn' | 'error' | 'success';
  491. text: string;
  492. icon: string;
  493. url?: string;
  494. }
  495. interface ButtonSpec {
  496. type: 'button';
  497. text: string;
  498. enabled?: boolean;
  499. primary?: boolean;
  500. name?: string;
  501. icon?: string;
  502. borderless?: boolean;
  503. buttonType?: 'primary' | 'secondary' | 'toolbar';
  504. }
  505. interface FormComponentSpec {
  506. type: string;
  507. name: string;
  508. }
  509. interface FormComponentWithLabelSpec extends FormComponentSpec {
  510. label?: string;
  511. }
  512. interface CheckboxSpec extends FormComponentSpec {
  513. type: 'checkbox';
  514. label: string;
  515. enabled?: boolean;
  516. }
  517. interface CollectionSpec extends FormComponentWithLabelSpec {
  518. type: 'collection';
  519. }
  520. interface CollectionItem {
  521. value: string;
  522. text: string;
  523. icon: string;
  524. }
  525. interface ColorInputSpec extends FormComponentWithLabelSpec {
  526. type: 'colorinput';
  527. storageKey?: string;
  528. }
  529. interface ColorPickerSpec extends FormComponentWithLabelSpec {
  530. type: 'colorpicker';
  531. }
  532. interface CustomEditorInit {
  533. setValue: (value: string) => void;
  534. getValue: () => string;
  535. destroy: () => void;
  536. }
  537. type CustomEditorInitFn = (elm: HTMLElement, settings: any) => Promise<CustomEditorInit>;
  538. interface CustomEditorOldSpec extends FormComponentSpec {
  539. type: 'customeditor';
  540. tag?: string;
  541. init: (e: HTMLElement) => Promise<CustomEditorInit>;
  542. }
  543. interface CustomEditorNewSpec extends FormComponentSpec {
  544. type: 'customeditor';
  545. tag?: string;
  546. scriptId: string;
  547. scriptUrl: string;
  548. onFocus?: (e: HTMLElement) => void;
  549. settings?: any;
  550. }
  551. type CustomEditorSpec = CustomEditorOldSpec | CustomEditorNewSpec;
  552. interface DropZoneSpec extends FormComponentWithLabelSpec {
  553. type: 'dropzone';
  554. }
  555. interface GridSpec {
  556. type: 'grid';
  557. columns: number;
  558. items: BodyComponentSpec[];
  559. }
  560. interface HtmlPanelSpec {
  561. type: 'htmlpanel';
  562. html: string;
  563. onInit?: (el: HTMLElement) => void;
  564. presets?: 'presentation' | 'document';
  565. stretched?: boolean;
  566. }
  567. interface IframeSpec extends FormComponentWithLabelSpec {
  568. type: 'iframe';
  569. border?: boolean;
  570. sandboxed?: boolean;
  571. streamContent?: boolean;
  572. transparent?: boolean;
  573. }
  574. interface ImagePreviewSpec extends FormComponentSpec {
  575. type: 'imagepreview';
  576. height?: string;
  577. }
  578. interface InputSpec extends FormComponentWithLabelSpec {
  579. type: 'input';
  580. inputMode?: string;
  581. placeholder?: string;
  582. maximized?: boolean;
  583. enabled?: boolean;
  584. }
  585. type Alignment = 'start' | 'center' | 'end';
  586. interface LabelSpec {
  587. type: 'label';
  588. label: string;
  589. items: BodyComponentSpec[];
  590. align?: Alignment;
  591. for?: string;
  592. }
  593. interface ListBoxSingleItemSpec {
  594. text: string;
  595. value: string;
  596. }
  597. interface ListBoxNestedItemSpec {
  598. text: string;
  599. items: ListBoxItemSpec[];
  600. }
  601. type ListBoxItemSpec = ListBoxNestedItemSpec | ListBoxSingleItemSpec;
  602. interface ListBoxSpec extends FormComponentWithLabelSpec {
  603. type: 'listbox';
  604. items: ListBoxItemSpec[];
  605. disabled?: boolean;
  606. }
  607. interface PanelSpec {
  608. type: 'panel';
  609. classes?: string[];
  610. items: BodyComponentSpec[];
  611. }
  612. interface SelectBoxItemSpec {
  613. text: string;
  614. value: string;
  615. }
  616. interface SelectBoxSpec extends FormComponentWithLabelSpec {
  617. type: 'selectbox';
  618. items: SelectBoxItemSpec[];
  619. size?: number;
  620. enabled?: boolean;
  621. }
  622. interface SizeInputSpec extends FormComponentWithLabelSpec {
  623. type: 'sizeinput';
  624. constrain?: boolean;
  625. enabled?: boolean;
  626. }
  627. interface SliderSpec extends FormComponentSpec {
  628. type: 'slider';
  629. label: string;
  630. min?: number;
  631. max?: number;
  632. }
  633. interface TableSpec {
  634. type: 'table';
  635. header: string[];
  636. cells: string[][];
  637. }
  638. interface TextAreaSpec extends FormComponentWithLabelSpec {
  639. type: 'textarea';
  640. placeholder?: string;
  641. maximized?: boolean;
  642. enabled?: boolean;
  643. }
  644. interface BaseToolbarButtonSpec<I extends BaseToolbarButtonInstanceApi> {
  645. enabled?: boolean;
  646. tooltip?: string;
  647. icon?: string;
  648. text?: string;
  649. onSetup?: (api: I) => (api: I) => void;
  650. }
  651. interface BaseToolbarButtonInstanceApi {
  652. isEnabled: () => boolean;
  653. setEnabled: (state: boolean) => void;
  654. setText: (text: string) => void;
  655. setIcon: (icon: string) => void;
  656. }
  657. interface ToolbarButtonSpec extends BaseToolbarButtonSpec<ToolbarButtonInstanceApi> {
  658. type?: 'button';
  659. onAction: (api: ToolbarButtonInstanceApi) => void;
  660. shortcut?: string;
  661. }
  662. interface ToolbarButtonInstanceApi extends BaseToolbarButtonInstanceApi {
  663. }
  664. interface ToolbarGroupSetting {
  665. name: string;
  666. items: string[];
  667. }
  668. type ToolbarConfig = string | ToolbarGroupSetting[];
  669. interface GroupToolbarButtonInstanceApi extends BaseToolbarButtonInstanceApi {
  670. }
  671. interface GroupToolbarButtonSpec extends BaseToolbarButtonSpec<GroupToolbarButtonInstanceApi> {
  672. type?: 'grouptoolbarbutton';
  673. items?: ToolbarConfig;
  674. }
  675. interface CardImageSpec {
  676. type: 'cardimage';
  677. src: string;
  678. alt?: string;
  679. classes?: string[];
  680. }
  681. interface CardTextSpec {
  682. type: 'cardtext';
  683. text: string;
  684. name?: string;
  685. classes?: string[];
  686. }
  687. type CardItemSpec = CardContainerSpec | CardImageSpec | CardTextSpec;
  688. type CardContainerDirection = 'vertical' | 'horizontal';
  689. type CardContainerAlign = 'left' | 'right';
  690. type CardContainerValign = 'top' | 'middle' | 'bottom';
  691. interface CardContainerSpec {
  692. type: 'cardcontainer';
  693. items: CardItemSpec[];
  694. direction?: CardContainerDirection;
  695. align?: CardContainerAlign;
  696. valign?: CardContainerValign;
  697. }
  698. interface CommonMenuItemSpec {
  699. enabled?: boolean;
  700. text?: string;
  701. value?: string;
  702. meta?: Record<string, any>;
  703. shortcut?: string;
  704. }
  705. interface CommonMenuItemInstanceApi {
  706. isEnabled: () => boolean;
  707. setEnabled: (state: boolean) => void;
  708. }
  709. interface CardMenuItemInstanceApi extends CommonMenuItemInstanceApi {
  710. }
  711. interface CardMenuItemSpec extends Omit<CommonMenuItemSpec, 'text' | 'shortcut'> {
  712. type: 'cardmenuitem';
  713. label?: string;
  714. items: CardItemSpec[];
  715. onSetup?: (api: CardMenuItemInstanceApi) => (api: CardMenuItemInstanceApi) => void;
  716. onAction?: (api: CardMenuItemInstanceApi) => void;
  717. }
  718. interface ChoiceMenuItemSpec extends CommonMenuItemSpec {
  719. type?: 'choiceitem';
  720. icon?: string;
  721. }
  722. interface ChoiceMenuItemInstanceApi extends CommonMenuItemInstanceApi {
  723. isActive: () => boolean;
  724. setActive: (state: boolean) => void;
  725. }
  726. interface ContextMenuItem extends CommonMenuItemSpec {
  727. text: string;
  728. icon?: string;
  729. type?: 'item';
  730. onAction: () => void;
  731. }
  732. interface ContextSubMenu extends CommonMenuItemSpec {
  733. type: 'submenu';
  734. text: string;
  735. icon?: string;
  736. getSubmenuItems: () => string | Array<ContextMenuContents>;
  737. }
  738. type ContextMenuContents = string | ContextMenuItem | SeparatorMenuItemSpec | ContextSubMenu;
  739. interface ContextMenuApi {
  740. update: (element: Element) => string | Array<ContextMenuContents>;
  741. }
  742. interface FancyActionArgsMap {
  743. 'inserttable': {
  744. numRows: number;
  745. numColumns: number;
  746. };
  747. 'colorswatch': {
  748. value: string;
  749. };
  750. }
  751. interface BaseFancyMenuItemSpec<T extends keyof FancyActionArgsMap> {
  752. type: 'fancymenuitem';
  753. fancytype: T;
  754. initData?: Record<string, unknown>;
  755. onAction?: (data: FancyActionArgsMap[T]) => void;
  756. }
  757. interface InsertTableMenuItemSpec extends BaseFancyMenuItemSpec<'inserttable'> {
  758. fancytype: 'inserttable';
  759. initData?: {};
  760. }
  761. interface ColorSwatchMenuItemSpec extends BaseFancyMenuItemSpec<'colorswatch'> {
  762. fancytype: 'colorswatch';
  763. select?: (value: string) => boolean;
  764. initData?: {
  765. allowCustomColors?: boolean;
  766. colors?: ChoiceMenuItemSpec[];
  767. storageKey?: string;
  768. };
  769. }
  770. type FancyMenuItemSpec = InsertTableMenuItemSpec | ColorSwatchMenuItemSpec;
  771. interface MenuItemSpec extends CommonMenuItemSpec {
  772. type?: 'menuitem';
  773. icon?: string;
  774. onSetup?: (api: MenuItemInstanceApi) => (api: MenuItemInstanceApi) => void;
  775. onAction?: (api: MenuItemInstanceApi) => void;
  776. }
  777. interface MenuItemInstanceApi extends CommonMenuItemInstanceApi {
  778. }
  779. interface SeparatorMenuItemSpec {
  780. type?: 'separator';
  781. text?: string;
  782. }
  783. interface ToggleMenuItemSpec extends CommonMenuItemSpec {
  784. type?: 'togglemenuitem';
  785. icon?: string;
  786. active?: boolean;
  787. onSetup?: (api: ToggleMenuItemInstanceApi) => void;
  788. onAction: (api: ToggleMenuItemInstanceApi) => void;
  789. }
  790. interface ToggleMenuItemInstanceApi extends CommonMenuItemInstanceApi {
  791. isActive: () => boolean;
  792. setActive: (state: boolean) => void;
  793. }
  794. type NestedMenuItemContents = string | MenuItemSpec | NestedMenuItemSpec | ToggleMenuItemSpec | SeparatorMenuItemSpec | FancyMenuItemSpec;
  795. interface NestedMenuItemSpec extends CommonMenuItemSpec {
  796. type?: 'nestedmenuitem';
  797. icon?: string;
  798. getSubmenuItems: () => string | Array<NestedMenuItemContents>;
  799. onSetup?: (api: NestedMenuItemInstanceApi) => (api: NestedMenuItemInstanceApi) => void;
  800. }
  801. interface NestedMenuItemInstanceApi extends CommonMenuItemInstanceApi {
  802. setTooltip: (tooltip: string) => void;
  803. setIconFill: (id: string, value: string) => void;
  804. }
  805. type MenuButtonItemTypes = NestedMenuItemContents;
  806. type SuccessCallback$1 = (menu: string | MenuButtonItemTypes[]) => void;
  807. interface MenuButtonFetchContext {
  808. pattern: string;
  809. }
  810. interface BaseMenuButtonSpec {
  811. text?: string;
  812. tooltip?: string;
  813. icon?: string;
  814. search?: boolean | {
  815. placeholder?: string;
  816. };
  817. fetch: (success: SuccessCallback$1, fetchContext: MenuButtonFetchContext, api: BaseMenuButtonInstanceApi) => void;
  818. onSetup?: (api: BaseMenuButtonInstanceApi) => (api: BaseMenuButtonInstanceApi) => void;
  819. }
  820. interface BaseMenuButtonInstanceApi {
  821. isEnabled: () => boolean;
  822. setEnabled: (state: boolean) => void;
  823. isActive: () => boolean;
  824. setActive: (state: boolean) => void;
  825. setText: (text: string) => void;
  826. setIcon: (icon: string) => void;
  827. }
  828. interface ToolbarMenuButtonSpec extends BaseMenuButtonSpec {
  829. type?: 'menubutton';
  830. onSetup?: (api: ToolbarMenuButtonInstanceApi) => (api: ToolbarMenuButtonInstanceApi) => void;
  831. }
  832. interface ToolbarMenuButtonInstanceApi extends BaseMenuButtonInstanceApi {
  833. }
  834. type ToolbarSplitButtonItemTypes = ChoiceMenuItemSpec | SeparatorMenuItemSpec;
  835. type SuccessCallback = (menu: ToolbarSplitButtonItemTypes[]) => void;
  836. type SelectPredicate = (value: string) => boolean;
  837. type PresetTypes = 'color' | 'normal' | 'listpreview';
  838. type ColumnTypes$1 = number | 'auto';
  839. interface ToolbarSplitButtonSpec {
  840. type?: 'splitbutton';
  841. tooltip?: string;
  842. icon?: string;
  843. text?: string;
  844. select?: SelectPredicate;
  845. presets?: PresetTypes;
  846. columns?: ColumnTypes$1;
  847. fetch: (success: SuccessCallback) => void;
  848. onSetup?: (api: ToolbarSplitButtonInstanceApi) => (api: ToolbarSplitButtonInstanceApi) => void;
  849. onAction: (api: ToolbarSplitButtonInstanceApi) => void;
  850. onItemAction: (api: ToolbarSplitButtonInstanceApi, value: string) => void;
  851. }
  852. interface ToolbarSplitButtonInstanceApi {
  853. isEnabled: () => boolean;
  854. setEnabled: (state: boolean) => void;
  855. setIconFill: (id: string, value: string) => void;
  856. isActive: () => boolean;
  857. setActive: (state: boolean) => void;
  858. setTooltip: (tooltip: string) => void;
  859. setText: (text: string) => void;
  860. setIcon: (icon: string) => void;
  861. }
  862. interface BaseToolbarToggleButtonSpec<I extends BaseToolbarButtonInstanceApi> extends BaseToolbarButtonSpec<I> {
  863. active?: boolean;
  864. }
  865. interface BaseToolbarToggleButtonInstanceApi extends BaseToolbarButtonInstanceApi {
  866. isActive: () => boolean;
  867. setActive: (state: boolean) => void;
  868. }
  869. interface ToolbarToggleButtonSpec extends BaseToolbarToggleButtonSpec<ToolbarToggleButtonInstanceApi> {
  870. type?: 'togglebutton';
  871. onAction: (api: ToolbarToggleButtonInstanceApi) => void;
  872. shortcut?: string;
  873. }
  874. interface ToolbarToggleButtonInstanceApi extends BaseToolbarToggleButtonInstanceApi {
  875. }
  876. type Id = string;
  877. interface TreeSpec {
  878. type: 'tree';
  879. items: TreeItemSpec[];
  880. onLeafAction?: (id: Id) => void;
  881. defaultExpandedIds?: Id[];
  882. onToggleExpand?: (expandedIds: Id[], { expanded, node }: {
  883. expanded: boolean;
  884. node: Id;
  885. }) => void;
  886. defaultSelectedId?: Id;
  887. }
  888. interface BaseTreeItemSpec {
  889. title: string;
  890. id: Id;
  891. menu?: ToolbarMenuButtonSpec;
  892. }
  893. interface DirectorySpec extends BaseTreeItemSpec {
  894. type: 'directory';
  895. children: TreeItemSpec[];
  896. }
  897. interface LeafSpec extends BaseTreeItemSpec {
  898. type: 'leaf';
  899. }
  900. type TreeItemSpec = DirectorySpec | LeafSpec;
  901. interface UrlInputSpec extends FormComponentWithLabelSpec {
  902. type: 'urlinput';
  903. filetype?: 'image' | 'media' | 'file';
  904. enabled?: boolean;
  905. picker_text?: string;
  906. }
  907. interface UrlInputData {
  908. value: string;
  909. meta: {
  910. text?: string;
  911. };
  912. }
  913. type BodyComponentSpec = BarSpec | ButtonSpec | CheckboxSpec | TextAreaSpec | InputSpec | ListBoxSpec | SelectBoxSpec | SizeInputSpec | SliderSpec | IframeSpec | HtmlPanelSpec | UrlInputSpec | DropZoneSpec | ColorInputSpec | GridSpec | ColorPickerSpec | ImagePreviewSpec | AlertBannerSpec | CollectionSpec | LabelSpec | TableSpec | TreeSpec | PanelSpec | CustomEditorSpec;
  914. interface BarSpec {
  915. type: 'bar';
  916. items: BodyComponentSpec[];
  917. }
  918. interface DialogToggleMenuItemSpec extends CommonMenuItemSpec {
  919. type?: 'togglemenuitem';
  920. name: string;
  921. }
  922. type DialogFooterMenuButtonItemSpec = DialogToggleMenuItemSpec;
  923. interface BaseDialogFooterButtonSpec {
  924. name?: string;
  925. align?: 'start' | 'end';
  926. primary?: boolean;
  927. enabled?: boolean;
  928. icon?: string;
  929. buttonType?: 'primary' | 'secondary';
  930. }
  931. interface DialogFooterNormalButtonSpec extends BaseDialogFooterButtonSpec {
  932. type: 'submit' | 'cancel' | 'custom';
  933. text: string;
  934. }
  935. interface DialogFooterMenuButtonSpec extends BaseDialogFooterButtonSpec {
  936. type: 'menu';
  937. text?: string;
  938. tooltip?: string;
  939. icon?: string;
  940. items: DialogFooterMenuButtonItemSpec[];
  941. }
  942. interface DialogFooterToggleButtonSpec extends BaseDialogFooterButtonSpec {
  943. type: 'togglebutton';
  944. tooltip?: string;
  945. icon?: string;
  946. text?: string;
  947. active?: boolean;
  948. }
  949. type DialogFooterButtonSpec = DialogFooterNormalButtonSpec | DialogFooterMenuButtonSpec | DialogFooterToggleButtonSpec;
  950. interface TabSpec {
  951. name?: string;
  952. title: string;
  953. items: BodyComponentSpec[];
  954. }
  955. interface TabPanelSpec {
  956. type: 'tabpanel';
  957. tabs: TabSpec[];
  958. }
  959. type DialogDataItem = any;
  960. type DialogData = Record<string, DialogDataItem>;
  961. interface DialogInstanceApi<T extends DialogData> {
  962. getData: () => T;
  963. setData: (data: Partial<T>) => void;
  964. setEnabled: (name: string, state: boolean) => void;
  965. focus: (name: string) => void;
  966. showTab: (name: string) => void;
  967. redial: (nu: DialogSpec<T>) => void;
  968. block: (msg: string) => void;
  969. unblock: () => void;
  970. toggleFullscreen: () => void;
  971. close: () => void;
  972. }
  973. interface DialogActionDetails {
  974. name: string;
  975. value?: any;
  976. }
  977. interface DialogChangeDetails<T> {
  978. name: keyof T;
  979. }
  980. interface DialogTabChangeDetails {
  981. newTabName: string;
  982. oldTabName: string;
  983. }
  984. type DialogActionHandler<T extends DialogData> = (api: DialogInstanceApi<T>, details: DialogActionDetails) => void;
  985. type DialogChangeHandler<T extends DialogData> = (api: DialogInstanceApi<T>, details: DialogChangeDetails<T>) => void;
  986. type DialogSubmitHandler<T extends DialogData> = (api: DialogInstanceApi<T>) => void;
  987. type DialogCloseHandler = () => void;
  988. type DialogCancelHandler<T extends DialogData> = (api: DialogInstanceApi<T>) => void;
  989. type DialogTabChangeHandler<T extends DialogData> = (api: DialogInstanceApi<T>, details: DialogTabChangeDetails) => void;
  990. type DialogSize = 'normal' | 'medium' | 'large';
  991. interface DialogSpec<T extends DialogData> {
  992. title: string;
  993. size?: DialogSize;
  994. body: TabPanelSpec | PanelSpec;
  995. buttons?: DialogFooterButtonSpec[];
  996. initialData?: Partial<T>;
  997. onAction?: DialogActionHandler<T>;
  998. onChange?: DialogChangeHandler<T>;
  999. onSubmit?: DialogSubmitHandler<T>;
  1000. onClose?: DialogCloseHandler;
  1001. onCancel?: DialogCancelHandler<T>;
  1002. onTabChange?: DialogTabChangeHandler<T>;
  1003. }
  1004. interface UrlDialogInstanceApi {
  1005. block: (msg: string) => void;
  1006. unblock: () => void;
  1007. close: () => void;
  1008. sendMessage: (msg: any) => void;
  1009. }
  1010. interface UrlDialogActionDetails {
  1011. name: string;
  1012. value?: any;
  1013. }
  1014. interface UrlDialogMessage {
  1015. mceAction: string;
  1016. [key: string]: any;
  1017. }
  1018. type UrlDialogActionHandler = (api: UrlDialogInstanceApi, actions: UrlDialogActionDetails) => void;
  1019. type UrlDialogCloseHandler = () => void;
  1020. type UrlDialogCancelHandler = (api: UrlDialogInstanceApi) => void;
  1021. type UrlDialogMessageHandler = (api: UrlDialogInstanceApi, message: UrlDialogMessage) => void;
  1022. interface UrlDialogFooterButtonSpec extends DialogFooterNormalButtonSpec {
  1023. type: 'cancel' | 'custom';
  1024. }
  1025. interface UrlDialogSpec {
  1026. title: string;
  1027. url: string;
  1028. height?: number;
  1029. width?: number;
  1030. buttons?: UrlDialogFooterButtonSpec[];
  1031. onAction?: UrlDialogActionHandler;
  1032. onClose?: UrlDialogCloseHandler;
  1033. onCancel?: UrlDialogCancelHandler;
  1034. onMessage?: UrlDialogMessageHandler;
  1035. }
  1036. type ColumnTypes = number | 'auto';
  1037. type SeparatorItemSpec = SeparatorMenuItemSpec;
  1038. interface AutocompleterItemSpec {
  1039. type?: 'autocompleteitem';
  1040. value: string;
  1041. text?: string;
  1042. icon?: string;
  1043. meta?: Record<string, any>;
  1044. }
  1045. type AutocompleterContents = SeparatorItemSpec | AutocompleterItemSpec | CardMenuItemSpec;
  1046. interface AutocompleterSpec {
  1047. type?: 'autocompleter';
  1048. trigger: string;
  1049. minChars?: number;
  1050. columns?: ColumnTypes;
  1051. matches?: (rng: Range, text: string, pattern: string) => boolean;
  1052. fetch: (pattern: string, maxResults: number, fetchOptions: Record<string, any>) => Promise<AutocompleterContents[]>;
  1053. onAction: (autocompleterApi: AutocompleterInstanceApi, rng: Range, value: string, meta: Record<string, any>) => void;
  1054. maxResults?: number;
  1055. highlightOn?: string[];
  1056. }
  1057. interface AutocompleterInstanceApi {
  1058. hide: () => void;
  1059. reload: (fetchOptions: Record<string, any>) => void;
  1060. }
  1061. type ContextPosition = 'node' | 'selection' | 'line';
  1062. type ContextScope = 'node' | 'editor';
  1063. interface ContextBarSpec {
  1064. predicate?: (elem: Element) => boolean;
  1065. position?: ContextPosition;
  1066. scope?: ContextScope;
  1067. }
  1068. interface ContextFormLaunchButtonApi extends BaseToolbarButtonSpec<BaseToolbarButtonInstanceApi> {
  1069. type: 'contextformbutton';
  1070. }
  1071. interface ContextFormLaunchToggleButtonSpec extends BaseToolbarToggleButtonSpec<BaseToolbarToggleButtonInstanceApi> {
  1072. type: 'contextformtogglebutton';
  1073. }
  1074. interface ContextFormButtonInstanceApi extends BaseToolbarButtonInstanceApi {
  1075. }
  1076. interface ContextFormToggleButtonInstanceApi extends BaseToolbarToggleButtonInstanceApi {
  1077. }
  1078. interface ContextFormButtonSpec extends BaseToolbarButtonSpec<ContextFormButtonInstanceApi> {
  1079. type?: 'contextformbutton';
  1080. primary?: boolean;
  1081. onAction: (formApi: ContextFormInstanceApi, api: ContextFormButtonInstanceApi) => void;
  1082. }
  1083. interface ContextFormToggleButtonSpec extends BaseToolbarToggleButtonSpec<ContextFormToggleButtonInstanceApi> {
  1084. type?: 'contextformtogglebutton';
  1085. onAction: (formApi: ContextFormInstanceApi, buttonApi: ContextFormToggleButtonInstanceApi) => void;
  1086. primary?: boolean;
  1087. }
  1088. interface ContextFormInstanceApi {
  1089. hide: () => void;
  1090. getValue: () => string;
  1091. }
  1092. interface ContextFormSpec extends ContextBarSpec {
  1093. type?: 'contextform';
  1094. initValue?: () => string;
  1095. label?: string;
  1096. launch?: ContextFormLaunchButtonApi | ContextFormLaunchToggleButtonSpec;
  1097. commands: Array<ContextFormToggleButtonSpec | ContextFormButtonSpec>;
  1098. }
  1099. interface ContextToolbarSpec extends ContextBarSpec {
  1100. type?: 'contexttoolbar';
  1101. items: string;
  1102. }
  1103. type PublicDialog_d_AlertBannerSpec = AlertBannerSpec;
  1104. type PublicDialog_d_BarSpec = BarSpec;
  1105. type PublicDialog_d_BodyComponentSpec = BodyComponentSpec;
  1106. type PublicDialog_d_ButtonSpec = ButtonSpec;
  1107. type PublicDialog_d_CheckboxSpec = CheckboxSpec;
  1108. type PublicDialog_d_CollectionItem = CollectionItem;
  1109. type PublicDialog_d_CollectionSpec = CollectionSpec;
  1110. type PublicDialog_d_ColorInputSpec = ColorInputSpec;
  1111. type PublicDialog_d_ColorPickerSpec = ColorPickerSpec;
  1112. type PublicDialog_d_CustomEditorSpec = CustomEditorSpec;
  1113. type PublicDialog_d_CustomEditorInit = CustomEditorInit;
  1114. type PublicDialog_d_CustomEditorInitFn = CustomEditorInitFn;
  1115. type PublicDialog_d_DialogData = DialogData;
  1116. type PublicDialog_d_DialogSize = DialogSize;
  1117. type PublicDialog_d_DialogSpec<T extends DialogData> = DialogSpec<T>;
  1118. type PublicDialog_d_DialogInstanceApi<T extends DialogData> = DialogInstanceApi<T>;
  1119. type PublicDialog_d_DialogFooterButtonSpec = DialogFooterButtonSpec;
  1120. type PublicDialog_d_DialogActionDetails = DialogActionDetails;
  1121. type PublicDialog_d_DialogChangeDetails<T> = DialogChangeDetails<T>;
  1122. type PublicDialog_d_DialogTabChangeDetails = DialogTabChangeDetails;
  1123. type PublicDialog_d_DropZoneSpec = DropZoneSpec;
  1124. type PublicDialog_d_GridSpec = GridSpec;
  1125. type PublicDialog_d_HtmlPanelSpec = HtmlPanelSpec;
  1126. type PublicDialog_d_IframeSpec = IframeSpec;
  1127. type PublicDialog_d_ImagePreviewSpec = ImagePreviewSpec;
  1128. type PublicDialog_d_InputSpec = InputSpec;
  1129. type PublicDialog_d_LabelSpec = LabelSpec;
  1130. type PublicDialog_d_ListBoxSpec = ListBoxSpec;
  1131. type PublicDialog_d_ListBoxItemSpec = ListBoxItemSpec;
  1132. type PublicDialog_d_ListBoxNestedItemSpec = ListBoxNestedItemSpec;
  1133. type PublicDialog_d_ListBoxSingleItemSpec = ListBoxSingleItemSpec;
  1134. type PublicDialog_d_PanelSpec = PanelSpec;
  1135. type PublicDialog_d_SelectBoxSpec = SelectBoxSpec;
  1136. type PublicDialog_d_SelectBoxItemSpec = SelectBoxItemSpec;
  1137. type PublicDialog_d_SizeInputSpec = SizeInputSpec;
  1138. type PublicDialog_d_SliderSpec = SliderSpec;
  1139. type PublicDialog_d_TableSpec = TableSpec;
  1140. type PublicDialog_d_TabSpec = TabSpec;
  1141. type PublicDialog_d_TabPanelSpec = TabPanelSpec;
  1142. type PublicDialog_d_TextAreaSpec = TextAreaSpec;
  1143. type PublicDialog_d_TreeSpec = TreeSpec;
  1144. type PublicDialog_d_TreeItemSpec = TreeItemSpec;
  1145. type PublicDialog_d_UrlInputData = UrlInputData;
  1146. type PublicDialog_d_UrlInputSpec = UrlInputSpec;
  1147. type PublicDialog_d_UrlDialogSpec = UrlDialogSpec;
  1148. type PublicDialog_d_UrlDialogFooterButtonSpec = UrlDialogFooterButtonSpec;
  1149. type PublicDialog_d_UrlDialogInstanceApi = UrlDialogInstanceApi;
  1150. type PublicDialog_d_UrlDialogActionDetails = UrlDialogActionDetails;
  1151. type PublicDialog_d_UrlDialogMessage = UrlDialogMessage;
  1152. declare namespace PublicDialog_d {
  1153. export { PublicDialog_d_AlertBannerSpec as AlertBannerSpec, PublicDialog_d_BarSpec as BarSpec, PublicDialog_d_BodyComponentSpec as BodyComponentSpec, PublicDialog_d_ButtonSpec as ButtonSpec, PublicDialog_d_CheckboxSpec as CheckboxSpec, PublicDialog_d_CollectionItem as CollectionItem, PublicDialog_d_CollectionSpec as CollectionSpec, PublicDialog_d_ColorInputSpec as ColorInputSpec, PublicDialog_d_ColorPickerSpec as ColorPickerSpec, PublicDialog_d_CustomEditorSpec as CustomEditorSpec, PublicDialog_d_CustomEditorInit as CustomEditorInit, PublicDialog_d_CustomEditorInitFn as CustomEditorInitFn, PublicDialog_d_DialogData as DialogData, PublicDialog_d_DialogSize as DialogSize, PublicDialog_d_DialogSpec as DialogSpec, PublicDialog_d_DialogInstanceApi as DialogInstanceApi, PublicDialog_d_DialogFooterButtonSpec as DialogFooterButtonSpec, PublicDialog_d_DialogActionDetails as DialogActionDetails, PublicDialog_d_DialogChangeDetails as DialogChangeDetails, PublicDialog_d_DialogTabChangeDetails as DialogTabChangeDetails, PublicDialog_d_DropZoneSpec as DropZoneSpec, PublicDialog_d_GridSpec as GridSpec, PublicDialog_d_HtmlPanelSpec as HtmlPanelSpec, PublicDialog_d_IframeSpec as IframeSpec, PublicDialog_d_ImagePreviewSpec as ImagePreviewSpec, PublicDialog_d_InputSpec as InputSpec, PublicDialog_d_LabelSpec as LabelSpec, PublicDialog_d_ListBoxSpec as ListBoxSpec, PublicDialog_d_ListBoxItemSpec as ListBoxItemSpec, PublicDialog_d_ListBoxNestedItemSpec as ListBoxNestedItemSpec, PublicDialog_d_ListBoxSingleItemSpec as ListBoxSingleItemSpec, PublicDialog_d_PanelSpec as PanelSpec, PublicDialog_d_SelectBoxSpec as SelectBoxSpec, PublicDialog_d_SelectBoxItemSpec as SelectBoxItemSpec, PublicDialog_d_SizeInputSpec as SizeInputSpec, PublicDialog_d_SliderSpec as SliderSpec, PublicDialog_d_TableSpec as TableSpec, PublicDialog_d_TabSpec as TabSpec, PublicDialog_d_TabPanelSpec as TabPanelSpec, PublicDialog_d_TextAreaSpec as TextAreaSpec, PublicDialog_d_TreeSpec as TreeSpec, PublicDialog_d_TreeItemSpec as TreeItemSpec, DirectorySpec as TreeDirectorySpec, LeafSpec as TreeLeafSpec, PublicDialog_d_UrlInputData as UrlInputData, PublicDialog_d_UrlInputSpec as UrlInputSpec, PublicDialog_d_UrlDialogSpec as UrlDialogSpec, PublicDialog_d_UrlDialogFooterButtonSpec as UrlDialogFooterButtonSpec, PublicDialog_d_UrlDialogInstanceApi as UrlDialogInstanceApi, PublicDialog_d_UrlDialogActionDetails as UrlDialogActionDetails, PublicDialog_d_UrlDialogMessage as UrlDialogMessage, };
  1154. }
  1155. type PublicInlineContent_d_AutocompleterSpec = AutocompleterSpec;
  1156. type PublicInlineContent_d_AutocompleterItemSpec = AutocompleterItemSpec;
  1157. type PublicInlineContent_d_AutocompleterContents = AutocompleterContents;
  1158. type PublicInlineContent_d_AutocompleterInstanceApi = AutocompleterInstanceApi;
  1159. type PublicInlineContent_d_ContextPosition = ContextPosition;
  1160. type PublicInlineContent_d_ContextScope = ContextScope;
  1161. type PublicInlineContent_d_ContextFormSpec = ContextFormSpec;
  1162. type PublicInlineContent_d_ContextFormInstanceApi = ContextFormInstanceApi;
  1163. type PublicInlineContent_d_ContextFormButtonSpec = ContextFormButtonSpec;
  1164. type PublicInlineContent_d_ContextFormButtonInstanceApi = ContextFormButtonInstanceApi;
  1165. type PublicInlineContent_d_ContextFormToggleButtonSpec = ContextFormToggleButtonSpec;
  1166. type PublicInlineContent_d_ContextFormToggleButtonInstanceApi = ContextFormToggleButtonInstanceApi;
  1167. type PublicInlineContent_d_ContextToolbarSpec = ContextToolbarSpec;
  1168. type PublicInlineContent_d_SeparatorItemSpec = SeparatorItemSpec;
  1169. declare namespace PublicInlineContent_d {
  1170. export { PublicInlineContent_d_AutocompleterSpec as AutocompleterSpec, PublicInlineContent_d_AutocompleterItemSpec as AutocompleterItemSpec, PublicInlineContent_d_AutocompleterContents as AutocompleterContents, PublicInlineContent_d_AutocompleterInstanceApi as AutocompleterInstanceApi, PublicInlineContent_d_ContextPosition as ContextPosition, PublicInlineContent_d_ContextScope as ContextScope, PublicInlineContent_d_ContextFormSpec as ContextFormSpec, PublicInlineContent_d_ContextFormInstanceApi as ContextFormInstanceApi, PublicInlineContent_d_ContextFormButtonSpec as ContextFormButtonSpec, PublicInlineContent_d_ContextFormButtonInstanceApi as ContextFormButtonInstanceApi, PublicInlineContent_d_ContextFormToggleButtonSpec as ContextFormToggleButtonSpec, PublicInlineContent_d_ContextFormToggleButtonInstanceApi as ContextFormToggleButtonInstanceApi, PublicInlineContent_d_ContextToolbarSpec as ContextToolbarSpec, PublicInlineContent_d_SeparatorItemSpec as SeparatorItemSpec, };
  1171. }
  1172. type PublicMenu_d_MenuItemSpec = MenuItemSpec;
  1173. type PublicMenu_d_MenuItemInstanceApi = MenuItemInstanceApi;
  1174. type PublicMenu_d_NestedMenuItemContents = NestedMenuItemContents;
  1175. type PublicMenu_d_NestedMenuItemSpec = NestedMenuItemSpec;
  1176. type PublicMenu_d_NestedMenuItemInstanceApi = NestedMenuItemInstanceApi;
  1177. type PublicMenu_d_FancyMenuItemSpec = FancyMenuItemSpec;
  1178. type PublicMenu_d_ColorSwatchMenuItemSpec = ColorSwatchMenuItemSpec;
  1179. type PublicMenu_d_InsertTableMenuItemSpec = InsertTableMenuItemSpec;
  1180. type PublicMenu_d_ToggleMenuItemSpec = ToggleMenuItemSpec;
  1181. type PublicMenu_d_ToggleMenuItemInstanceApi = ToggleMenuItemInstanceApi;
  1182. type PublicMenu_d_ChoiceMenuItemSpec = ChoiceMenuItemSpec;
  1183. type PublicMenu_d_ChoiceMenuItemInstanceApi = ChoiceMenuItemInstanceApi;
  1184. type PublicMenu_d_SeparatorMenuItemSpec = SeparatorMenuItemSpec;
  1185. type PublicMenu_d_ContextMenuApi = ContextMenuApi;
  1186. type PublicMenu_d_ContextMenuContents = ContextMenuContents;
  1187. type PublicMenu_d_ContextMenuItem = ContextMenuItem;
  1188. type PublicMenu_d_ContextSubMenu = ContextSubMenu;
  1189. type PublicMenu_d_CardMenuItemSpec = CardMenuItemSpec;
  1190. type PublicMenu_d_CardMenuItemInstanceApi = CardMenuItemInstanceApi;
  1191. type PublicMenu_d_CardItemSpec = CardItemSpec;
  1192. type PublicMenu_d_CardContainerSpec = CardContainerSpec;
  1193. type PublicMenu_d_CardImageSpec = CardImageSpec;
  1194. type PublicMenu_d_CardTextSpec = CardTextSpec;
  1195. declare namespace PublicMenu_d {
  1196. export { PublicMenu_d_MenuItemSpec as MenuItemSpec, PublicMenu_d_MenuItemInstanceApi as MenuItemInstanceApi, PublicMenu_d_NestedMenuItemContents as NestedMenuItemContents, PublicMenu_d_NestedMenuItemSpec as NestedMenuItemSpec, PublicMenu_d_NestedMenuItemInstanceApi as NestedMenuItemInstanceApi, PublicMenu_d_FancyMenuItemSpec as FancyMenuItemSpec, PublicMenu_d_ColorSwatchMenuItemSpec as ColorSwatchMenuItemSpec, PublicMenu_d_InsertTableMenuItemSpec as InsertTableMenuItemSpec, PublicMenu_d_ToggleMenuItemSpec as ToggleMenuItemSpec, PublicMenu_d_ToggleMenuItemInstanceApi as ToggleMenuItemInstanceApi, PublicMenu_d_ChoiceMenuItemSpec as ChoiceMenuItemSpec, PublicMenu_d_ChoiceMenuItemInstanceApi as ChoiceMenuItemInstanceApi, PublicMenu_d_SeparatorMenuItemSpec as SeparatorMenuItemSpec, PublicMenu_d_ContextMenuApi as ContextMenuApi, PublicMenu_d_ContextMenuContents as ContextMenuContents, PublicMenu_d_ContextMenuItem as ContextMenuItem, PublicMenu_d_ContextSubMenu as ContextSubMenu, PublicMenu_d_CardMenuItemSpec as CardMenuItemSpec, PublicMenu_d_CardMenuItemInstanceApi as CardMenuItemInstanceApi, PublicMenu_d_CardItemSpec as CardItemSpec, PublicMenu_d_CardContainerSpec as CardContainerSpec, PublicMenu_d_CardImageSpec as CardImageSpec, PublicMenu_d_CardTextSpec as CardTextSpec, };
  1197. }
  1198. interface SidebarInstanceApi {
  1199. element: () => HTMLElement;
  1200. }
  1201. interface SidebarSpec {
  1202. icon?: string;
  1203. tooltip?: string;
  1204. onShow?: (api: SidebarInstanceApi) => void;
  1205. onSetup?: (api: SidebarInstanceApi) => (api: SidebarInstanceApi) => void;
  1206. onHide?: (api: SidebarInstanceApi) => void;
  1207. }
  1208. type PublicSidebar_d_SidebarSpec = SidebarSpec;
  1209. type PublicSidebar_d_SidebarInstanceApi = SidebarInstanceApi;
  1210. declare namespace PublicSidebar_d {
  1211. export { PublicSidebar_d_SidebarSpec as SidebarSpec, PublicSidebar_d_SidebarInstanceApi as SidebarInstanceApi, };
  1212. }
  1213. type PublicToolbar_d_ToolbarButtonSpec = ToolbarButtonSpec;
  1214. type PublicToolbar_d_ToolbarButtonInstanceApi = ToolbarButtonInstanceApi;
  1215. type PublicToolbar_d_ToolbarSplitButtonSpec = ToolbarSplitButtonSpec;
  1216. type PublicToolbar_d_ToolbarSplitButtonInstanceApi = ToolbarSplitButtonInstanceApi;
  1217. type PublicToolbar_d_ToolbarMenuButtonSpec = ToolbarMenuButtonSpec;
  1218. type PublicToolbar_d_ToolbarMenuButtonInstanceApi = ToolbarMenuButtonInstanceApi;
  1219. type PublicToolbar_d_ToolbarToggleButtonSpec = ToolbarToggleButtonSpec;
  1220. type PublicToolbar_d_ToolbarToggleButtonInstanceApi = ToolbarToggleButtonInstanceApi;
  1221. type PublicToolbar_d_GroupToolbarButtonSpec = GroupToolbarButtonSpec;
  1222. type PublicToolbar_d_GroupToolbarButtonInstanceApi = GroupToolbarButtonInstanceApi;
  1223. declare namespace PublicToolbar_d {
  1224. export { PublicToolbar_d_ToolbarButtonSpec as ToolbarButtonSpec, PublicToolbar_d_ToolbarButtonInstanceApi as ToolbarButtonInstanceApi, PublicToolbar_d_ToolbarSplitButtonSpec as ToolbarSplitButtonSpec, PublicToolbar_d_ToolbarSplitButtonInstanceApi as ToolbarSplitButtonInstanceApi, PublicToolbar_d_ToolbarMenuButtonSpec as ToolbarMenuButtonSpec, PublicToolbar_d_ToolbarMenuButtonInstanceApi as ToolbarMenuButtonInstanceApi, PublicToolbar_d_ToolbarToggleButtonSpec as ToolbarToggleButtonSpec, PublicToolbar_d_ToolbarToggleButtonInstanceApi as ToolbarToggleButtonInstanceApi, PublicToolbar_d_GroupToolbarButtonSpec as GroupToolbarButtonSpec, PublicToolbar_d_GroupToolbarButtonInstanceApi as GroupToolbarButtonInstanceApi, };
  1225. }
  1226. interface ViewButtonApi {
  1227. setIcon: (newIcon: string) => void;
  1228. }
  1229. interface ViewToggleButtonApi extends ViewButtonApi {
  1230. isActive: () => boolean;
  1231. setActive: (state: boolean) => void;
  1232. }
  1233. interface BaseButtonSpec<Api extends ViewButtonApi> {
  1234. text?: string;
  1235. icon?: string;
  1236. tooltip?: string;
  1237. buttonType?: 'primary' | 'secondary';
  1238. borderless?: boolean;
  1239. onAction: (api: Api) => void;
  1240. }
  1241. interface ViewNormalButtonSpec extends BaseButtonSpec<ViewButtonApi> {
  1242. text: string;
  1243. type: 'button';
  1244. }
  1245. interface ViewToggleButtonSpec extends BaseButtonSpec<ViewToggleButtonApi> {
  1246. type: 'togglebutton';
  1247. active?: boolean;
  1248. onAction: (api: ViewToggleButtonApi) => void;
  1249. }
  1250. interface ViewButtonsGroupSpec {
  1251. type: 'group';
  1252. buttons: Array<ViewNormalButtonSpec | ViewToggleButtonSpec>;
  1253. }
  1254. type ViewButtonSpec = ViewNormalButtonSpec | ViewToggleButtonSpec | ViewButtonsGroupSpec;
  1255. interface ViewInstanceApi {
  1256. getContainer: () => HTMLElement;
  1257. }
  1258. interface ViewSpec {
  1259. buttons?: ViewButtonSpec[];
  1260. onShow: (api: ViewInstanceApi) => void;
  1261. onHide: (api: ViewInstanceApi) => void;
  1262. }
  1263. type PublicView_d_ViewSpec = ViewSpec;
  1264. type PublicView_d_ViewInstanceApi = ViewInstanceApi;
  1265. declare namespace PublicView_d {
  1266. export { PublicView_d_ViewSpec as ViewSpec, PublicView_d_ViewInstanceApi as ViewInstanceApi, };
  1267. }
  1268. interface Registry$1 {
  1269. addButton: (name: string, spec: ToolbarButtonSpec) => void;
  1270. addGroupToolbarButton: (name: string, spec: GroupToolbarButtonSpec) => void;
  1271. addToggleButton: (name: string, spec: ToolbarToggleButtonSpec) => void;
  1272. addMenuButton: (name: string, spec: ToolbarMenuButtonSpec) => void;
  1273. addSplitButton: (name: string, spec: ToolbarSplitButtonSpec) => void;
  1274. addMenuItem: (name: string, spec: MenuItemSpec) => void;
  1275. addNestedMenuItem: (name: string, spec: NestedMenuItemSpec) => void;
  1276. addToggleMenuItem: (name: string, spec: ToggleMenuItemSpec) => void;
  1277. addContextMenu: (name: string, spec: ContextMenuApi) => void;
  1278. addContextToolbar: (name: string, spec: ContextToolbarSpec) => void;
  1279. addContextForm: (name: string, spec: ContextFormSpec) => void;
  1280. addIcon: (name: string, svgData: string) => void;
  1281. addAutocompleter: (name: string, spec: AutocompleterSpec) => void;
  1282. addSidebar: (name: string, spec: SidebarSpec) => void;
  1283. addView: (name: string, spec: ViewSpec) => void;
  1284. getAll: () => {
  1285. buttons: Record<string, ToolbarButtonSpec | GroupToolbarButtonSpec | ToolbarMenuButtonSpec | ToolbarSplitButtonSpec | ToolbarToggleButtonSpec>;
  1286. menuItems: Record<string, MenuItemSpec | NestedMenuItemSpec | ToggleMenuItemSpec>;
  1287. popups: Record<string, AutocompleterSpec>;
  1288. contextMenus: Record<string, ContextMenuApi>;
  1289. contextToolbars: Record<string, ContextToolbarSpec | ContextFormSpec>;
  1290. icons: Record<string, string>;
  1291. sidebars: Record<string, SidebarSpec>;
  1292. views: Record<string, ViewSpec>;
  1293. };
  1294. }
  1295. interface AutocompleteLookupData {
  1296. readonly matchText: string;
  1297. readonly items: AutocompleterContents[];
  1298. readonly columns: ColumnTypes;
  1299. readonly onAction: (autoApi: AutocompleterInstanceApi, rng: Range, value: string, meta: Record<string, any>) => void;
  1300. readonly highlightOn: string[];
  1301. }
  1302. interface AutocompleterEventArgs {
  1303. readonly lookupData: AutocompleteLookupData[];
  1304. }
  1305. interface RangeLikeObject {
  1306. startContainer: Node;
  1307. startOffset: number;
  1308. endContainer: Node;
  1309. endOffset: number;
  1310. }
  1311. type ApplyFormat = BlockFormat | InlineFormat | SelectorFormat;
  1312. type RemoveFormat = RemoveBlockFormat | RemoveInlineFormat | RemoveSelectorFormat;
  1313. type Format = ApplyFormat | RemoveFormat;
  1314. type Formats = Record<string, Format | Format[]>;
  1315. type FormatAttrOrStyleValue = string | ((vars?: FormatVars) => string | null);
  1316. type FormatVars = Record<string, string | null>;
  1317. interface BaseFormat<T> {
  1318. ceFalseOverride?: boolean;
  1319. classes?: string | string[];
  1320. collapsed?: boolean;
  1321. exact?: boolean;
  1322. expand?: boolean;
  1323. links?: boolean;
  1324. mixed?: boolean;
  1325. block_expand?: boolean;
  1326. onmatch?: (node: Element, fmt: T, itemName: string) => boolean;
  1327. remove?: 'none' | 'empty' | 'all';
  1328. remove_similar?: boolean;
  1329. split?: boolean;
  1330. deep?: boolean;
  1331. preserve_attributes?: string[];
  1332. }
  1333. interface Block {
  1334. block: string;
  1335. list_block?: string;
  1336. wrapper?: boolean;
  1337. }
  1338. interface Inline {
  1339. inline: string;
  1340. }
  1341. interface Selector {
  1342. selector: string;
  1343. inherit?: boolean;
  1344. }
  1345. interface CommonFormat<T> extends BaseFormat<T> {
  1346. attributes?: Record<string, FormatAttrOrStyleValue>;
  1347. styles?: Record<string, FormatAttrOrStyleValue>;
  1348. toggle?: boolean;
  1349. preview?: string | false;
  1350. onformat?: (elm: Element, fmt: T, vars?: FormatVars, node?: Node | RangeLikeObject | null) => void;
  1351. clear_child_styles?: boolean;
  1352. merge_siblings?: boolean;
  1353. merge_with_parents?: boolean;
  1354. }
  1355. interface BlockFormat extends Block, CommonFormat<BlockFormat> {
  1356. }
  1357. interface InlineFormat extends Inline, CommonFormat<InlineFormat> {
  1358. }
  1359. interface SelectorFormat extends Selector, CommonFormat<SelectorFormat> {
  1360. }
  1361. interface CommonRemoveFormat<T> extends BaseFormat<T> {
  1362. attributes?: string[] | Record<string, FormatAttrOrStyleValue>;
  1363. styles?: string[] | Record<string, FormatAttrOrStyleValue>;
  1364. }
  1365. interface RemoveBlockFormat extends Block, CommonRemoveFormat<RemoveBlockFormat> {
  1366. }
  1367. interface RemoveInlineFormat extends Inline, CommonRemoveFormat<RemoveInlineFormat> {
  1368. }
  1369. interface RemoveSelectorFormat extends Selector, CommonRemoveFormat<RemoveSelectorFormat> {
  1370. }
  1371. interface Filter<C extends Function> {
  1372. name: string;
  1373. callbacks: C[];
  1374. }
  1375. interface ParserArgs {
  1376. getInner?: boolean | number;
  1377. forced_root_block?: boolean | string;
  1378. context?: string;
  1379. isRootContent?: boolean;
  1380. format?: string;
  1381. invalid?: boolean;
  1382. no_events?: boolean;
  1383. [key: string]: any;
  1384. }
  1385. type ParserFilterCallback = (nodes: AstNode[], name: string, args: ParserArgs) => void;
  1386. interface ParserFilter extends Filter<ParserFilterCallback> {
  1387. }
  1388. interface DomParserSettings {
  1389. allow_html_data_urls?: boolean;
  1390. allow_svg_data_urls?: boolean;
  1391. allow_conditional_comments?: boolean;
  1392. allow_html_in_named_anchor?: boolean;
  1393. allow_script_urls?: boolean;
  1394. allow_unsafe_link_target?: boolean;
  1395. blob_cache?: BlobCache;
  1396. convert_fonts_to_spans?: boolean;
  1397. convert_unsafe_embeds?: boolean;
  1398. document?: Document;
  1399. fix_list_elements?: boolean;
  1400. font_size_legacy_values?: string;
  1401. forced_root_block?: boolean | string;
  1402. forced_root_block_attrs?: Record<string, string>;
  1403. inline_styles?: boolean;
  1404. pad_empty_with_br?: boolean;
  1405. preserve_cdata?: boolean;
  1406. root_name?: string;
  1407. sandbox_iframes?: boolean;
  1408. sandbox_iframes_exclusions?: string[];
  1409. sanitize?: boolean;
  1410. validate?: boolean;
  1411. }
  1412. interface DomParser {
  1413. schema: Schema;
  1414. addAttributeFilter: (name: string, callback: ParserFilterCallback) => void;
  1415. getAttributeFilters: () => ParserFilter[];
  1416. removeAttributeFilter: (name: string, callback?: ParserFilterCallback) => void;
  1417. addNodeFilter: (name: string, callback: ParserFilterCallback) => void;
  1418. getNodeFilters: () => ParserFilter[];
  1419. removeNodeFilter: (name: string, callback?: ParserFilterCallback) => void;
  1420. parse: (html: string, args?: ParserArgs) => AstNode;
  1421. }
  1422. interface StyleSheetLoaderSettings {
  1423. maxLoadTime?: number;
  1424. contentCssCors?: boolean;
  1425. referrerPolicy?: ReferrerPolicy;
  1426. }
  1427. interface StyleSheetLoader {
  1428. load: (url: string) => Promise<void>;
  1429. loadRawCss: (key: string, css: string) => void;
  1430. loadAll: (urls: string[]) => Promise<string[]>;
  1431. unload: (url: string) => void;
  1432. unloadRawCss: (key: string) => void;
  1433. unloadAll: (urls: string[]) => void;
  1434. _setReferrerPolicy: (referrerPolicy: ReferrerPolicy) => void;
  1435. _setContentCssCors: (contentCssCors: boolean) => void;
  1436. }
  1437. type Registry = Registry$1;
  1438. interface EditorUiApi {
  1439. show: () => void;
  1440. hide: () => void;
  1441. setEnabled: (state: boolean) => void;
  1442. isEnabled: () => boolean;
  1443. }
  1444. interface EditorUi extends EditorUiApi {
  1445. registry: Registry;
  1446. styleSheetLoader: StyleSheetLoader;
  1447. }
  1448. type Ui_d_Registry = Registry;
  1449. type Ui_d_EditorUiApi = EditorUiApi;
  1450. type Ui_d_EditorUi = EditorUi;
  1451. declare namespace Ui_d {
  1452. export { Ui_d_Registry as Registry, PublicDialog_d as Dialog, PublicInlineContent_d as InlineContent, PublicMenu_d as Menu, PublicView_d as View, PublicSidebar_d as Sidebar, PublicToolbar_d as Toolbar, Ui_d_EditorUiApi as EditorUiApi, Ui_d_EditorUi as EditorUi, };
  1453. }
  1454. interface WindowParams {
  1455. readonly inline?: 'cursor' | 'toolbar' | 'bottom';
  1456. readonly ariaAttrs?: boolean;
  1457. readonly persistent?: boolean;
  1458. }
  1459. type InstanceApi<T extends DialogData> = UrlDialogInstanceApi | DialogInstanceApi<T>;
  1460. interface WindowManagerImpl {
  1461. open: <T extends DialogData>(config: DialogSpec<T>, params: WindowParams | undefined, closeWindow: (dialog: DialogInstanceApi<T>) => void) => DialogInstanceApi<T>;
  1462. openUrl: (config: UrlDialogSpec, closeWindow: (dialog: UrlDialogInstanceApi) => void) => UrlDialogInstanceApi;
  1463. alert: (message: string, callback: () => void) => void;
  1464. confirm: (message: string, callback: (state: boolean) => void) => void;
  1465. close: (dialog: InstanceApi<any>) => void;
  1466. }
  1467. interface WindowManager {
  1468. open: <T extends DialogData>(config: DialogSpec<T>, params?: WindowParams) => DialogInstanceApi<T>;
  1469. openUrl: (config: UrlDialogSpec) => UrlDialogInstanceApi;
  1470. alert: (message: string, callback?: () => void, scope?: any) => void;
  1471. confirm: (message: string, callback?: (state: boolean) => void, scope?: any) => void;
  1472. close: () => void;
  1473. }
  1474. interface ExecCommandEvent {
  1475. command: string;
  1476. ui: boolean;
  1477. value?: any;
  1478. }
  1479. interface BeforeGetContentEvent extends GetContentArgs {
  1480. selection?: boolean;
  1481. }
  1482. interface GetContentEvent extends BeforeGetContentEvent {
  1483. content: string;
  1484. }
  1485. interface BeforeSetContentEvent extends SetContentArgs {
  1486. content: string;
  1487. selection?: boolean;
  1488. }
  1489. interface SetContentEvent extends BeforeSetContentEvent {
  1490. content: string;
  1491. }
  1492. interface SaveContentEvent extends GetContentEvent {
  1493. save: boolean;
  1494. }
  1495. interface NewBlockEvent {
  1496. newBlock: Element;
  1497. }
  1498. interface NodeChangeEvent {
  1499. element: Element;
  1500. parents: Node[];
  1501. selectionChange?: boolean;
  1502. initial?: boolean;
  1503. }
  1504. interface FormatEvent {
  1505. format: string;
  1506. vars?: FormatVars;
  1507. node?: Node | RangeLikeObject | null;
  1508. }
  1509. interface ObjectResizeEvent {
  1510. target: HTMLElement;
  1511. width: number;
  1512. height: number;
  1513. origin: string;
  1514. }
  1515. interface ObjectSelectedEvent {
  1516. target: Node;
  1517. targetClone?: Node;
  1518. }
  1519. interface ScrollIntoViewEvent {
  1520. elm: HTMLElement;
  1521. alignToTop: boolean | undefined;
  1522. }
  1523. interface SetSelectionRangeEvent {
  1524. range: Range;
  1525. forward: boolean | undefined;
  1526. }
  1527. interface ShowCaretEvent {
  1528. target: Node;
  1529. direction: number;
  1530. before: boolean;
  1531. }
  1532. interface SwitchModeEvent {
  1533. mode: string;
  1534. }
  1535. interface ChangeEvent {
  1536. level: UndoLevel;
  1537. lastLevel: UndoLevel | undefined;
  1538. }
  1539. interface AddUndoEvent extends ChangeEvent {
  1540. originalEvent: Event | undefined;
  1541. }
  1542. interface UndoRedoEvent {
  1543. level: UndoLevel;
  1544. }
  1545. interface WindowEvent<T extends DialogData> {
  1546. dialog: InstanceApi<T>;
  1547. }
  1548. interface ProgressStateEvent {
  1549. state: boolean;
  1550. time?: number;
  1551. }
  1552. interface AfterProgressStateEvent {
  1553. state: boolean;
  1554. }
  1555. interface PlaceholderToggleEvent {
  1556. state: boolean;
  1557. }
  1558. interface LoadErrorEvent {
  1559. message: string;
  1560. }
  1561. interface PreProcessEvent extends ParserArgs {
  1562. node: Element;
  1563. }
  1564. interface PostProcessEvent extends ParserArgs {
  1565. content: string;
  1566. }
  1567. interface PastePlainTextToggleEvent {
  1568. state: boolean;
  1569. }
  1570. interface PastePreProcessEvent {
  1571. content: string;
  1572. readonly internal: boolean;
  1573. }
  1574. interface PastePostProcessEvent {
  1575. node: HTMLElement;
  1576. readonly internal: boolean;
  1577. }
  1578. interface EditableRootStateChangeEvent {
  1579. state: boolean;
  1580. }
  1581. interface NewTableRowEvent {
  1582. node: HTMLTableRowElement;
  1583. }
  1584. interface NewTableCellEvent {
  1585. node: HTMLTableCellElement;
  1586. }
  1587. interface TableEventData {
  1588. readonly structure: boolean;
  1589. readonly style: boolean;
  1590. }
  1591. interface TableModifiedEvent extends TableEventData {
  1592. readonly table: HTMLTableElement;
  1593. }
  1594. interface BeforeOpenNotificationEvent {
  1595. notification: NotificationSpec;
  1596. }
  1597. interface OpenNotificationEvent {
  1598. notification: NotificationApi;
  1599. }
  1600. interface EditorEventMap extends Omit<NativeEventMap, 'blur' | 'focus'> {
  1601. 'activate': {
  1602. relatedTarget: Editor | null;
  1603. };
  1604. 'deactivate': {
  1605. relatedTarget: Editor;
  1606. };
  1607. 'focus': {
  1608. blurredEditor: Editor | null;
  1609. };
  1610. 'blur': {
  1611. focusedEditor: Editor | null;
  1612. };
  1613. 'resize': UIEvent;
  1614. 'scroll': UIEvent;
  1615. 'input': InputEvent;
  1616. 'beforeinput': InputEvent;
  1617. 'detach': {};
  1618. 'remove': {};
  1619. 'init': {};
  1620. 'ScrollIntoView': ScrollIntoViewEvent;
  1621. 'AfterScrollIntoView': ScrollIntoViewEvent;
  1622. 'ObjectResized': ObjectResizeEvent;
  1623. 'ObjectResizeStart': ObjectResizeEvent;
  1624. 'SwitchMode': SwitchModeEvent;
  1625. 'ScrollWindow': Event;
  1626. 'ResizeWindow': UIEvent;
  1627. 'SkinLoaded': {};
  1628. 'SkinLoadError': LoadErrorEvent;
  1629. 'PluginLoadError': LoadErrorEvent;
  1630. 'ModelLoadError': LoadErrorEvent;
  1631. 'IconsLoadError': LoadErrorEvent;
  1632. 'ThemeLoadError': LoadErrorEvent;
  1633. 'LanguageLoadError': LoadErrorEvent;
  1634. 'BeforeExecCommand': ExecCommandEvent;
  1635. 'ExecCommand': ExecCommandEvent;
  1636. 'NodeChange': NodeChangeEvent;
  1637. 'FormatApply': FormatEvent;
  1638. 'FormatRemove': FormatEvent;
  1639. 'ShowCaret': ShowCaretEvent;
  1640. 'SelectionChange': {};
  1641. 'ObjectSelected': ObjectSelectedEvent;
  1642. 'BeforeObjectSelected': ObjectSelectedEvent;
  1643. 'GetSelectionRange': {
  1644. range: Range;
  1645. };
  1646. 'SetSelectionRange': SetSelectionRangeEvent;
  1647. 'AfterSetSelectionRange': SetSelectionRangeEvent;
  1648. 'BeforeGetContent': BeforeGetContentEvent;
  1649. 'GetContent': GetContentEvent;
  1650. 'BeforeSetContent': BeforeSetContentEvent;
  1651. 'SetContent': SetContentEvent;
  1652. 'SaveContent': SaveContentEvent;
  1653. 'RawSaveContent': SaveContentEvent;
  1654. 'LoadContent': {
  1655. load: boolean;
  1656. element: HTMLElement;
  1657. };
  1658. 'PreviewFormats': {};
  1659. 'AfterPreviewFormats': {};
  1660. 'ScriptsLoaded': {};
  1661. 'PreInit': {};
  1662. 'PostRender': {};
  1663. 'NewBlock': NewBlockEvent;
  1664. 'ClearUndos': {};
  1665. 'TypingUndo': {};
  1666. 'Redo': UndoRedoEvent;
  1667. 'Undo': UndoRedoEvent;
  1668. 'BeforeAddUndo': AddUndoEvent;
  1669. 'AddUndo': AddUndoEvent;
  1670. 'change': ChangeEvent;
  1671. 'CloseWindow': WindowEvent<any>;
  1672. 'OpenWindow': WindowEvent<any>;
  1673. 'ProgressState': ProgressStateEvent;
  1674. 'AfterProgressState': AfterProgressStateEvent;
  1675. 'PlaceholderToggle': PlaceholderToggleEvent;
  1676. 'tap': TouchEvent;
  1677. 'longpress': TouchEvent;
  1678. 'longpresscancel': {};
  1679. 'PreProcess': PreProcessEvent;
  1680. 'PostProcess': PostProcessEvent;
  1681. 'AutocompleterStart': AutocompleterEventArgs;
  1682. 'AutocompleterUpdate': AutocompleterEventArgs;
  1683. 'AutocompleterEnd': {};
  1684. 'PastePlainTextToggle': PastePlainTextToggleEvent;
  1685. 'PastePreProcess': PastePreProcessEvent;
  1686. 'PastePostProcess': PastePostProcessEvent;
  1687. 'TableModified': TableModifiedEvent;
  1688. 'NewRow': NewTableRowEvent;
  1689. 'NewCell': NewTableCellEvent;
  1690. 'SetAttrib': SetAttribEvent;
  1691. 'hide': {};
  1692. 'show': {};
  1693. 'dirty': {};
  1694. 'BeforeOpenNotification': BeforeOpenNotificationEvent;
  1695. 'OpenNotification': OpenNotificationEvent;
  1696. }
  1697. interface EditorManagerEventMap {
  1698. 'AddEditor': {
  1699. editor: Editor;
  1700. };
  1701. 'RemoveEditor': {
  1702. editor: Editor;
  1703. };
  1704. 'BeforeUnload': {
  1705. returnValue: any;
  1706. };
  1707. }
  1708. type EventTypes_d_ExecCommandEvent = ExecCommandEvent;
  1709. type EventTypes_d_BeforeGetContentEvent = BeforeGetContentEvent;
  1710. type EventTypes_d_GetContentEvent = GetContentEvent;
  1711. type EventTypes_d_BeforeSetContentEvent = BeforeSetContentEvent;
  1712. type EventTypes_d_SetContentEvent = SetContentEvent;
  1713. type EventTypes_d_SaveContentEvent = SaveContentEvent;
  1714. type EventTypes_d_NewBlockEvent = NewBlockEvent;
  1715. type EventTypes_d_NodeChangeEvent = NodeChangeEvent;
  1716. type EventTypes_d_FormatEvent = FormatEvent;
  1717. type EventTypes_d_ObjectResizeEvent = ObjectResizeEvent;
  1718. type EventTypes_d_ObjectSelectedEvent = ObjectSelectedEvent;
  1719. type EventTypes_d_ScrollIntoViewEvent = ScrollIntoViewEvent;
  1720. type EventTypes_d_SetSelectionRangeEvent = SetSelectionRangeEvent;
  1721. type EventTypes_d_ShowCaretEvent = ShowCaretEvent;
  1722. type EventTypes_d_SwitchModeEvent = SwitchModeEvent;
  1723. type EventTypes_d_ChangeEvent = ChangeEvent;
  1724. type EventTypes_d_AddUndoEvent = AddUndoEvent;
  1725. type EventTypes_d_UndoRedoEvent = UndoRedoEvent;
  1726. type EventTypes_d_WindowEvent<T extends DialogData> = WindowEvent<T>;
  1727. type EventTypes_d_ProgressStateEvent = ProgressStateEvent;
  1728. type EventTypes_d_AfterProgressStateEvent = AfterProgressStateEvent;
  1729. type EventTypes_d_PlaceholderToggleEvent = PlaceholderToggleEvent;
  1730. type EventTypes_d_LoadErrorEvent = LoadErrorEvent;
  1731. type EventTypes_d_PreProcessEvent = PreProcessEvent;
  1732. type EventTypes_d_PostProcessEvent = PostProcessEvent;
  1733. type EventTypes_d_PastePlainTextToggleEvent = PastePlainTextToggleEvent;
  1734. type EventTypes_d_PastePreProcessEvent = PastePreProcessEvent;
  1735. type EventTypes_d_PastePostProcessEvent = PastePostProcessEvent;
  1736. type EventTypes_d_EditableRootStateChangeEvent = EditableRootStateChangeEvent;
  1737. type EventTypes_d_NewTableRowEvent = NewTableRowEvent;
  1738. type EventTypes_d_NewTableCellEvent = NewTableCellEvent;
  1739. type EventTypes_d_TableEventData = TableEventData;
  1740. type EventTypes_d_TableModifiedEvent = TableModifiedEvent;
  1741. type EventTypes_d_BeforeOpenNotificationEvent = BeforeOpenNotificationEvent;
  1742. type EventTypes_d_OpenNotificationEvent = OpenNotificationEvent;
  1743. type EventTypes_d_EditorEventMap = EditorEventMap;
  1744. type EventTypes_d_EditorManagerEventMap = EditorManagerEventMap;
  1745. declare namespace EventTypes_d {
  1746. export { EventTypes_d_ExecCommandEvent as ExecCommandEvent, EventTypes_d_BeforeGetContentEvent as BeforeGetContentEvent, EventTypes_d_GetContentEvent as GetContentEvent, EventTypes_d_BeforeSetContentEvent as BeforeSetContentEvent, EventTypes_d_SetContentEvent as SetContentEvent, EventTypes_d_SaveContentEvent as SaveContentEvent, EventTypes_d_NewBlockEvent as NewBlockEvent, EventTypes_d_NodeChangeEvent as NodeChangeEvent, EventTypes_d_FormatEvent as FormatEvent, EventTypes_d_ObjectResizeEvent as ObjectResizeEvent, EventTypes_d_ObjectSelectedEvent as ObjectSelectedEvent, EventTypes_d_ScrollIntoViewEvent as ScrollIntoViewEvent, EventTypes_d_SetSelectionRangeEvent as SetSelectionRangeEvent, EventTypes_d_ShowCaretEvent as ShowCaretEvent, EventTypes_d_SwitchModeEvent as SwitchModeEvent, EventTypes_d_ChangeEvent as ChangeEvent, EventTypes_d_AddUndoEvent as AddUndoEvent, EventTypes_d_UndoRedoEvent as UndoRedoEvent, EventTypes_d_WindowEvent as WindowEvent, EventTypes_d_ProgressStateEvent as ProgressStateEvent, EventTypes_d_AfterProgressStateEvent as AfterProgressStateEvent, EventTypes_d_PlaceholderToggleEvent as PlaceholderToggleEvent, EventTypes_d_LoadErrorEvent as LoadErrorEvent, EventTypes_d_PreProcessEvent as PreProcessEvent, EventTypes_d_PostProcessEvent as PostProcessEvent, EventTypes_d_PastePlainTextToggleEvent as PastePlainTextToggleEvent, EventTypes_d_PastePreProcessEvent as PastePreProcessEvent, EventTypes_d_PastePostProcessEvent as PastePostProcessEvent, EventTypes_d_EditableRootStateChangeEvent as EditableRootStateChangeEvent, EventTypes_d_NewTableRowEvent as NewTableRowEvent, EventTypes_d_NewTableCellEvent as NewTableCellEvent, EventTypes_d_TableEventData as TableEventData, EventTypes_d_TableModifiedEvent as TableModifiedEvent, EventTypes_d_BeforeOpenNotificationEvent as BeforeOpenNotificationEvent, EventTypes_d_OpenNotificationEvent as OpenNotificationEvent, EventTypes_d_EditorEventMap as EditorEventMap, EventTypes_d_EditorManagerEventMap as EditorManagerEventMap, };
  1747. }
  1748. type Format_d_Formats = Formats;
  1749. type Format_d_Format = Format;
  1750. type Format_d_ApplyFormat = ApplyFormat;
  1751. type Format_d_BlockFormat = BlockFormat;
  1752. type Format_d_InlineFormat = InlineFormat;
  1753. type Format_d_SelectorFormat = SelectorFormat;
  1754. type Format_d_RemoveFormat = RemoveFormat;
  1755. type Format_d_RemoveBlockFormat = RemoveBlockFormat;
  1756. type Format_d_RemoveInlineFormat = RemoveInlineFormat;
  1757. type Format_d_RemoveSelectorFormat = RemoveSelectorFormat;
  1758. declare namespace Format_d {
  1759. export { Format_d_Formats as Formats, Format_d_Format as Format, Format_d_ApplyFormat as ApplyFormat, Format_d_BlockFormat as BlockFormat, Format_d_InlineFormat as InlineFormat, Format_d_SelectorFormat as SelectorFormat, Format_d_RemoveFormat as RemoveFormat, Format_d_RemoveBlockFormat as RemoveBlockFormat, Format_d_RemoveInlineFormat as RemoveInlineFormat, Format_d_RemoveSelectorFormat as RemoveSelectorFormat, };
  1760. }
  1761. type StyleFormat = BlockStyleFormat | InlineStyleFormat | SelectorStyleFormat;
  1762. type AllowedFormat = Separator | FormatReference | StyleFormat | NestedFormatting;
  1763. interface Separator {
  1764. title: string;
  1765. }
  1766. interface FormatReference {
  1767. title: string;
  1768. format: string;
  1769. icon?: string;
  1770. }
  1771. interface NestedFormatting {
  1772. title: string;
  1773. items: Array<FormatReference | StyleFormat>;
  1774. }
  1775. interface CommonStyleFormat {
  1776. name?: string;
  1777. title: string;
  1778. icon?: string;
  1779. }
  1780. interface BlockStyleFormat extends BlockFormat, CommonStyleFormat {
  1781. }
  1782. interface InlineStyleFormat extends InlineFormat, CommonStyleFormat {
  1783. }
  1784. interface SelectorStyleFormat extends SelectorFormat, CommonStyleFormat {
  1785. }
  1786. type EntityEncoding = 'named' | 'numeric' | 'raw' | 'named,numeric' | 'named+numeric' | 'numeric,named' | 'numeric+named';
  1787. interface ContentLanguage {
  1788. readonly title: string;
  1789. readonly code: string;
  1790. readonly customCode?: string;
  1791. }
  1792. type ThemeInitFunc = (editor: Editor, elm: HTMLElement) => {
  1793. editorContainer: HTMLElement;
  1794. iframeContainer: HTMLElement;
  1795. height?: number;
  1796. iframeHeight?: number;
  1797. api?: EditorUiApi;
  1798. };
  1799. type SetupCallback = (editor: Editor) => void;
  1800. type FilePickerCallback = (callback: (value: string, meta?: Record<string, any>) => void, value: string, meta: Record<string, any>) => void;
  1801. type FilePickerValidationStatus = 'valid' | 'unknown' | 'invalid' | 'none';
  1802. type FilePickerValidationCallback = (info: {
  1803. type: string;
  1804. url: string;
  1805. }, callback: (validation: {
  1806. status: FilePickerValidationStatus;
  1807. message: string;
  1808. }) => void) => void;
  1809. type PastePreProcessFn = (editor: Editor, args: PastePreProcessEvent) => void;
  1810. type PastePostProcessFn = (editor: Editor, args: PastePostProcessEvent) => void;
  1811. type URLConverter = (url: string, name: string, elm?: string | Element) => string;
  1812. type URLConverterCallback = (url: string, node: Node | string | undefined, on_save: boolean, name: string) => string;
  1813. interface ToolbarGroup {
  1814. name?: string;
  1815. items: string[];
  1816. }
  1817. type ToolbarMode = 'floating' | 'sliding' | 'scrolling' | 'wrap';
  1818. type ToolbarLocation = 'top' | 'bottom' | 'auto';
  1819. interface BaseEditorOptions {
  1820. a11y_advanced_options?: boolean;
  1821. add_form_submit_trigger?: boolean;
  1822. add_unload_trigger?: boolean;
  1823. allow_conditional_comments?: boolean;
  1824. allow_html_data_urls?: boolean;
  1825. allow_html_in_named_anchor?: boolean;
  1826. allow_script_urls?: boolean;
  1827. allow_svg_data_urls?: boolean;
  1828. allow_unsafe_link_target?: boolean;
  1829. anchor_bottom?: false | string;
  1830. anchor_top?: false | string;
  1831. auto_focus?: string | true;
  1832. automatic_uploads?: boolean;
  1833. base_url?: string;
  1834. block_formats?: string;
  1835. block_unsupported_drop?: boolean;
  1836. body_id?: string;
  1837. body_class?: string;
  1838. br_in_pre?: boolean;
  1839. br_newline_selector?: string;
  1840. browser_spellcheck?: boolean;
  1841. branding?: boolean;
  1842. cache_suffix?: string;
  1843. color_cols?: number;
  1844. color_cols_foreground?: number;
  1845. color_cols_background?: number;
  1846. color_map?: string[];
  1847. color_map_foreground?: string[];
  1848. color_map_background?: string[];
  1849. color_default_foreground?: string;
  1850. color_default_background?: string;
  1851. content_css?: boolean | string | string[];
  1852. content_css_cors?: boolean;
  1853. content_security_policy?: string;
  1854. content_style?: string;
  1855. content_langs?: ContentLanguage[];
  1856. contextmenu?: string | string[] | false;
  1857. contextmenu_never_use_native?: boolean;
  1858. convert_fonts_to_spans?: boolean;
  1859. convert_unsafe_embeds?: boolean;
  1860. convert_urls?: boolean;
  1861. custom_colors?: boolean;
  1862. custom_elements?: string | Record<string, CustomElementSpec>;
  1863. custom_ui_selector?: string;
  1864. custom_undo_redo_levels?: number;
  1865. default_font_stack?: string[];
  1866. deprecation_warnings?: boolean;
  1867. directionality?: 'ltr' | 'rtl';
  1868. doctype?: string;
  1869. document_base_url?: string;
  1870. draggable_modal?: boolean;
  1871. editable_class?: string;
  1872. editable_root?: boolean;
  1873. element_format?: 'xhtml' | 'html';
  1874. elementpath?: boolean;
  1875. encoding?: string;
  1876. end_container_on_empty_block?: boolean | string;
  1877. entities?: string;
  1878. entity_encoding?: EntityEncoding;
  1879. extended_valid_elements?: string;
  1880. event_root?: string;
  1881. file_picker_callback?: FilePickerCallback;
  1882. file_picker_types?: string;
  1883. file_picker_validator_handler?: FilePickerValidationCallback;
  1884. fix_list_elements?: boolean;
  1885. fixed_toolbar_container?: string;
  1886. fixed_toolbar_container_target?: HTMLElement;
  1887. font_css?: string | string[];
  1888. font_family_formats?: string;
  1889. font_size_classes?: string;
  1890. font_size_legacy_values?: string;
  1891. font_size_style_values?: string;
  1892. font_size_formats?: string;
  1893. font_size_input_default_unit?: string;
  1894. forced_root_block?: string;
  1895. forced_root_block_attrs?: Record<string, string>;
  1896. formats?: Formats;
  1897. format_noneditable_selector?: string;
  1898. height?: number | string;
  1899. help_accessibility?: boolean;
  1900. hidden_input?: boolean;
  1901. highlight_on_focus?: boolean;
  1902. icons?: string;
  1903. icons_url?: string;
  1904. id?: string;
  1905. iframe_aria_text?: string;
  1906. iframe_attrs?: Record<string, string>;
  1907. images_file_types?: string;
  1908. images_replace_blob_uris?: boolean;
  1909. images_reuse_filename?: boolean;
  1910. images_upload_base_path?: string;
  1911. images_upload_credentials?: boolean;
  1912. images_upload_handler?: UploadHandler;
  1913. images_upload_url?: string;
  1914. indent?: boolean;
  1915. indent_after?: string;
  1916. indent_before?: string;
  1917. indent_use_margin?: boolean;
  1918. indentation?: string;
  1919. init_instance_callback?: SetupCallback;
  1920. inline?: boolean;
  1921. inline_boundaries?: boolean;
  1922. inline_boundaries_selector?: string;
  1923. inline_styles?: boolean;
  1924. invalid_elements?: string;
  1925. invalid_styles?: string | Record<string, string>;
  1926. keep_styles?: boolean;
  1927. language?: string;
  1928. language_load?: boolean;
  1929. language_url?: string;
  1930. line_height_formats?: string;
  1931. max_height?: number;
  1932. max_width?: number;
  1933. menu?: Record<string, {
  1934. title: string;
  1935. items: string;
  1936. }>;
  1937. menubar?: boolean | string;
  1938. min_height?: number;
  1939. min_width?: number;
  1940. model?: string;
  1941. model_url?: string;
  1942. newdocument_content?: string;
  1943. newline_behavior?: 'block' | 'linebreak' | 'invert' | 'default';
  1944. no_newline_selector?: string;
  1945. noneditable_class?: string;
  1946. noneditable_regexp?: RegExp | RegExp[];
  1947. nowrap?: boolean;
  1948. object_resizing?: boolean | string;
  1949. pad_empty_with_br?: boolean;
  1950. paste_as_text?: boolean;
  1951. paste_block_drop?: boolean;
  1952. paste_data_images?: boolean;
  1953. paste_merge_formats?: boolean;
  1954. paste_postprocess?: PastePostProcessFn;
  1955. paste_preprocess?: PastePreProcessFn;
  1956. paste_remove_styles_if_webkit?: boolean;
  1957. paste_tab_spaces?: number;
  1958. paste_webkit_styles?: string;
  1959. placeholder?: string;
  1960. preserve_cdata?: boolean;
  1961. preview_styles?: false | string;
  1962. promotion?: boolean;
  1963. protect?: RegExp[];
  1964. readonly?: boolean;
  1965. referrer_policy?: ReferrerPolicy;
  1966. relative_urls?: boolean;
  1967. remove_script_host?: boolean;
  1968. remove_trailing_brs?: boolean;
  1969. removed_menuitems?: string;
  1970. resize?: boolean | 'both';
  1971. resize_img_proportional?: boolean;
  1972. root_name?: string;
  1973. sandbox_iframes?: boolean;
  1974. sandbox_iframes_exclusions?: string[];
  1975. schema?: SchemaType;
  1976. selector?: string;
  1977. setup?: SetupCallback;
  1978. sidebar_show?: string;
  1979. skin?: boolean | string;
  1980. skin_url?: string;
  1981. smart_paste?: boolean;
  1982. statusbar?: boolean;
  1983. style_formats?: AllowedFormat[];
  1984. style_formats_autohide?: boolean;
  1985. style_formats_merge?: boolean;
  1986. submit_patch?: boolean;
  1987. suffix?: string;
  1988. table_tab_navigation?: boolean;
  1989. target?: HTMLElement;
  1990. text_patterns?: RawPattern[] | false;
  1991. text_patterns_lookup?: RawDynamicPatternsLookup;
  1992. theme?: string | ThemeInitFunc | false;
  1993. theme_url?: string;
  1994. toolbar?: boolean | string | string[] | Array<ToolbarGroup>;
  1995. toolbar1?: string;
  1996. toolbar2?: string;
  1997. toolbar3?: string;
  1998. toolbar4?: string;
  1999. toolbar5?: string;
  2000. toolbar6?: string;
  2001. toolbar7?: string;
  2002. toolbar8?: string;
  2003. toolbar9?: string;
  2004. toolbar_groups?: Record<string, GroupToolbarButtonSpec>;
  2005. toolbar_location?: ToolbarLocation;
  2006. toolbar_mode?: ToolbarMode;
  2007. toolbar_sticky?: boolean;
  2008. toolbar_sticky_offset?: number;
  2009. typeahead_urls?: boolean;
  2010. ui_mode?: 'combined' | 'split';
  2011. url_converter?: URLConverter;
  2012. url_converter_scope?: any;
  2013. urlconverter_callback?: URLConverterCallback;
  2014. valid_children?: string;
  2015. valid_classes?: string | Record<string, string>;
  2016. valid_elements?: string;
  2017. valid_styles?: string | Record<string, string>;
  2018. verify_html?: boolean;
  2019. visual?: boolean;
  2020. visual_anchor_class?: string;
  2021. visual_table_class?: string;
  2022. width?: number | string;
  2023. xss_sanitization?: boolean;
  2024. license_key?: string;
  2025. disable_nodechange?: boolean;
  2026. forced_plugins?: string | string[];
  2027. plugin_base_urls?: Record<string, string>;
  2028. service_message?: string;
  2029. [key: string]: any;
  2030. }
  2031. interface RawEditorOptions extends BaseEditorOptions {
  2032. external_plugins?: Record<string, string>;
  2033. mobile?: RawEditorOptions;
  2034. plugins?: string | string[];
  2035. }
  2036. interface NormalizedEditorOptions extends BaseEditorOptions {
  2037. external_plugins: Record<string, string>;
  2038. forced_plugins: string[];
  2039. plugins: string[];
  2040. }
  2041. interface EditorOptions extends NormalizedEditorOptions {
  2042. a11y_advanced_options: boolean;
  2043. allow_unsafe_link_target: boolean;
  2044. anchor_bottom: string;
  2045. anchor_top: string;
  2046. automatic_uploads: boolean;
  2047. block_formats: string;
  2048. body_class: string;
  2049. body_id: string;
  2050. br_newline_selector: string;
  2051. color_map: string[];
  2052. color_cols: number;
  2053. color_cols_foreground: number;
  2054. color_cols_background: number;
  2055. color_default_background: string;
  2056. color_default_foreground: string;
  2057. content_css: string[];
  2058. contextmenu: string[];
  2059. convert_unsafe_embeds: boolean;
  2060. custom_colors: boolean;
  2061. default_font_stack: string[];
  2062. document_base_url: string;
  2063. init_content_sync: boolean;
  2064. draggable_modal: boolean;
  2065. editable_class: string;
  2066. editable_root: boolean;
  2067. font_css: string[];
  2068. font_family_formats: string;
  2069. font_size_classes: string;
  2070. font_size_formats: string;
  2071. font_size_input_default_unit: string;
  2072. font_size_legacy_values: string;
  2073. font_size_style_values: string;
  2074. forced_root_block: string;
  2075. forced_root_block_attrs: Record<string, string>;
  2076. format_noneditable_selector: string;
  2077. height: number | string;
  2078. highlight_on_focus: boolean;
  2079. iframe_attrs: Record<string, string>;
  2080. images_file_types: string;
  2081. images_upload_base_path: string;
  2082. images_upload_credentials: boolean;
  2083. images_upload_url: string;
  2084. indent_use_margin: boolean;
  2085. indentation: string;
  2086. inline: boolean;
  2087. inline_boundaries_selector: string;
  2088. language: string;
  2089. language_load: boolean;
  2090. language_url: string;
  2091. line_height_formats: string;
  2092. menu: Record<string, {
  2093. title: string;
  2094. items: string;
  2095. }>;
  2096. menubar: boolean | string;
  2097. model: string;
  2098. newdocument_content: string;
  2099. no_newline_selector: string;
  2100. noneditable_class: string;
  2101. noneditable_regexp: RegExp[];
  2102. object_resizing: string;
  2103. pad_empty_with_br: boolean;
  2104. paste_as_text: boolean;
  2105. preview_styles: string;
  2106. promotion: boolean;
  2107. readonly: boolean;
  2108. removed_menuitems: string;
  2109. sandbox_iframes: boolean;
  2110. sandbox_iframes_exclusions: string[];
  2111. toolbar: boolean | string | string[] | Array<ToolbarGroup>;
  2112. toolbar_groups: Record<string, GroupToolbarButtonSpec>;
  2113. toolbar_location: ToolbarLocation;
  2114. toolbar_mode: ToolbarMode;
  2115. toolbar_persist: boolean;
  2116. toolbar_sticky: boolean;
  2117. toolbar_sticky_offset: number;
  2118. text_patterns: Pattern[];
  2119. text_patterns_lookup: DynamicPatternsLookup;
  2120. visual: boolean;
  2121. visual_anchor_class: string;
  2122. visual_table_class: string;
  2123. width: number | string;
  2124. xss_sanitization: boolean;
  2125. }
  2126. type StyleMap = Record<string, string | number>;
  2127. interface StylesSettings {
  2128. allow_script_urls?: boolean;
  2129. allow_svg_data_urls?: boolean;
  2130. url_converter?: URLConverter;
  2131. url_converter_scope?: any;
  2132. }
  2133. interface Styles {
  2134. parse: (css: string | undefined) => Record<string, string>;
  2135. serialize: (styles: StyleMap, elementName?: string) => string;
  2136. }
  2137. type EventUtilsCallback<T> = (event: EventUtilsEvent<T>) => void | boolean;
  2138. type EventUtilsEvent<T> = NormalizedEvent<T> & {
  2139. metaKey: boolean;
  2140. };
  2141. interface Callback$1<T> {
  2142. func: EventUtilsCallback<T>;
  2143. scope: any;
  2144. }
  2145. interface CallbackList<T> extends Array<Callback$1<T>> {
  2146. fakeName: string | false;
  2147. capture: boolean;
  2148. nativeHandler: EventListener;
  2149. }
  2150. interface EventUtilsConstructor {
  2151. readonly prototype: EventUtils;
  2152. new (): EventUtils;
  2153. Event: EventUtils;
  2154. }
  2155. declare class EventUtils {
  2156. static Event: EventUtils;
  2157. domLoaded: boolean;
  2158. events: Record<number, Record<string, CallbackList<any>>>;
  2159. private readonly expando;
  2160. private hasFocusIn;
  2161. private count;
  2162. constructor();
  2163. bind<K extends keyof HTMLElementEventMap>(target: any, name: K, callback: EventUtilsCallback<HTMLElementEventMap[K]>, scope?: any): EventUtilsCallback<HTMLElementEventMap[K]>;
  2164. bind<T = any>(target: any, names: string, callback: EventUtilsCallback<T>, scope?: any): EventUtilsCallback<T>;
  2165. unbind<K extends keyof HTMLElementEventMap>(target: any, name: K, callback?: EventUtilsCallback<HTMLElementEventMap[K]>): this;
  2166. unbind<T = any>(target: any, names: string, callback?: EventUtilsCallback<T>): this;
  2167. unbind(target: any): this;
  2168. fire(target: any, name: string, args?: {}): this;
  2169. dispatch(target: any, name: string, args?: {}): this;
  2170. clean(target: any): this;
  2171. destroy(): void;
  2172. cancel<T>(e: EventUtilsEvent<T>): boolean;
  2173. private executeHandlers;
  2174. }
  2175. interface SetAttribEvent {
  2176. attrElm: HTMLElement;
  2177. attrName: string;
  2178. attrValue: string | boolean | number | null;
  2179. }
  2180. interface DOMUtilsSettings {
  2181. schema: Schema;
  2182. url_converter: URLConverter;
  2183. url_converter_scope: any;
  2184. ownEvents: boolean;
  2185. keep_values: boolean;
  2186. update_styles: boolean;
  2187. root_element: HTMLElement | null;
  2188. collect: boolean;
  2189. onSetAttrib: (event: SetAttribEvent) => void;
  2190. contentCssCors: boolean;
  2191. referrerPolicy: ReferrerPolicy;
  2192. }
  2193. type Target = Node | Window;
  2194. type RunArguments<T extends Node = Node> = string | T | Array<string | T> | null;
  2195. type BoundEvent = [
  2196. Target,
  2197. string,
  2198. EventUtilsCallback<any>,
  2199. any
  2200. ];
  2201. type Callback<K extends string> = EventUtilsCallback<MappedEvent<HTMLElementEventMap, K>>;
  2202. type RunResult<T, R> = T extends Array<any> ? R[] : false | R;
  2203. interface DOMUtils {
  2204. doc: Document;
  2205. settings: Partial<DOMUtilsSettings>;
  2206. win: Window;
  2207. files: Record<string, boolean>;
  2208. stdMode: boolean;
  2209. boxModel: boolean;
  2210. styleSheetLoader: StyleSheetLoader;
  2211. boundEvents: BoundEvent[];
  2212. styles: Styles;
  2213. schema: Schema;
  2214. events: EventUtils;
  2215. root: Node | null;
  2216. isBlock: {
  2217. (node: Node | null): node is HTMLElement;
  2218. (node: string): boolean;
  2219. };
  2220. clone: (node: Node, deep: boolean) => Node;
  2221. getRoot: () => HTMLElement;
  2222. getViewPort: (argWin?: Window) => GeomRect;
  2223. getRect: (elm: string | HTMLElement) => GeomRect;
  2224. getSize: (elm: string | HTMLElement) => {
  2225. w: number;
  2226. h: number;
  2227. };
  2228. getParent: {
  2229. <K extends keyof HTMLElementTagNameMap>(node: string | Node | null, selector: K, root?: Node): HTMLElementTagNameMap[K] | null;
  2230. <T extends Element>(node: string | Node | null, selector: string | ((node: Node) => node is T), root?: Node): T | null;
  2231. (node: string | Node | null, selector?: string | ((node: Node) => boolean | void), root?: Node): Node | null;
  2232. };
  2233. getParents: {
  2234. <K extends keyof HTMLElementTagNameMap>(elm: string | HTMLElementTagNameMap[K] | null, selector: K, root?: Node, collect?: boolean): Array<HTMLElementTagNameMap[K]>;
  2235. <T extends Element>(node: string | Node | null, selector: string | ((node: Node) => node is T), root?: Node, collect?: boolean): T[];
  2236. (elm: string | Node | null, selector?: string | ((node: Node) => boolean | void), root?: Node, collect?: boolean): Node[];
  2237. };
  2238. get: {
  2239. <T extends Node>(elm: T): T;
  2240. (elm: string): HTMLElement | null;
  2241. };
  2242. getNext: (node: Node | null, selector: string | ((node: Node) => boolean)) => Node | null;
  2243. getPrev: (node: Node | null, selector: string | ((node: Node) => boolean)) => Node | null;
  2244. select: {
  2245. <K extends keyof HTMLElementTagNameMap>(selector: K, scope?: string | Node): Array<HTMLElementTagNameMap[K]>;
  2246. <T extends HTMLElement = HTMLElement>(selector: string, scope?: string | Node): T[];
  2247. };
  2248. is: {
  2249. <T extends Element>(elm: Node | Node[] | null, selector: string): elm is T;
  2250. (elm: Node | Node[] | null, selector: string): boolean;
  2251. };
  2252. add: (parentElm: RunArguments, name: string | Element, attrs?: Record<string, string | boolean | number | null>, html?: string | Node | null, create?: boolean) => HTMLElement;
  2253. create: {
  2254. <K extends keyof HTMLElementTagNameMap>(name: K, attrs?: Record<string, string | boolean | number | null>, html?: string | Node | null): HTMLElementTagNameMap[K];
  2255. (name: string, attrs?: Record<string, string | boolean | number | null>, html?: string | Node | null): HTMLElement;
  2256. };
  2257. createHTML: (name: string, attrs?: Record<string, string | null>, html?: string) => string;
  2258. createFragment: (html?: string) => DocumentFragment;
  2259. remove: {
  2260. <T extends Node>(node: T | T[], keepChildren?: boolean): typeof node extends Array<any> ? T[] : T;
  2261. <T extends Node>(node: string, keepChildren?: boolean): T | false;
  2262. };
  2263. getStyle: {
  2264. (elm: Element, name: string, computed: true): string;
  2265. (elm: string | Element | null, name: string, computed?: boolean): string | undefined;
  2266. };
  2267. setStyle: (elm: string | Element | Element[], name: string, value: string | number | null) => void;
  2268. setStyles: (elm: string | Element | Element[], stylesArg: StyleMap) => void;
  2269. removeAllAttribs: (e: RunArguments<Element>) => void;
  2270. setAttrib: (elm: RunArguments<Element>, name: string, value: string | boolean | number | null) => void;
  2271. setAttribs: (elm: RunArguments<Element>, attrs: Record<string, string | boolean | number | null>) => void;
  2272. getAttrib: (elm: string | Element | null, name: string, defaultVal?: string) => string;
  2273. getAttribs: (elm: string | Element) => NamedNodeMap | Attr[];
  2274. getPos: (elm: string | Element, rootElm?: Node) => {
  2275. x: number;
  2276. y: number;
  2277. };
  2278. parseStyle: (cssText: string) => Record<string, string>;
  2279. serializeStyle: (stylesArg: StyleMap, name?: string) => string;
  2280. addStyle: (cssText: string) => void;
  2281. loadCSS: (url: string) => void;
  2282. hasClass: (elm: string | Element, cls: string) => boolean;
  2283. addClass: (elm: RunArguments<Element>, cls: string) => void;
  2284. removeClass: (elm: RunArguments<Element>, cls: string) => void;
  2285. toggleClass: (elm: RunArguments<Element>, cls: string, state?: boolean) => void;
  2286. show: (elm: string | Node | Node[]) => void;
  2287. hide: (elm: string | Node | Node[]) => void;
  2288. isHidden: (elm: string | Node) => boolean;
  2289. uniqueId: (prefix?: string) => string;
  2290. setHTML: (elm: RunArguments<Element>, html: string) => void;
  2291. getOuterHTML: (elm: string | Node) => string;
  2292. setOuterHTML: (elm: string | Node | Node[], html: string) => void;
  2293. decode: (text: string) => string;
  2294. encode: (text: string) => string;
  2295. insertAfter: {
  2296. <T extends Node>(node: T | T[], reference: string | Node): T;
  2297. <T extends Node>(node: RunArguments<T>, reference: string | Node): RunResult<typeof node, T>;
  2298. };
  2299. replace: {
  2300. <T extends Node>(newElm: Node, oldElm: T | T[], keepChildren?: boolean): T;
  2301. <T extends Node>(newElm: Node, oldElm: RunArguments<T>, keepChildren?: boolean): false | T;
  2302. };
  2303. rename: {
  2304. <K extends keyof HTMLElementTagNameMap>(elm: Element, name: K): HTMLElementTagNameMap[K];
  2305. (elm: Element, name: string): Element;
  2306. };
  2307. findCommonAncestor: (a: Node, b: Node) => Node | null;
  2308. run<R, T extends Node>(this: DOMUtils, elm: T | T[], func: (node: T) => R, scope?: any): typeof elm extends Array<any> ? R[] : R;
  2309. run<R, T extends Node>(this: DOMUtils, elm: RunArguments<T>, func: (node: T) => R, scope?: any): RunResult<typeof elm, R>;
  2310. isEmpty: (node: Node, elements?: Record<string, any>, options?: IsEmptyOptions) => boolean;
  2311. createRng: () => Range;
  2312. nodeIndex: (node: Node, normalized?: boolean) => number;
  2313. split: {
  2314. <T extends Node>(parentElm: Node, splitElm: Node, replacementElm: T): T | undefined;
  2315. <T extends Node>(parentElm: Node, splitElm: T): T | undefined;
  2316. };
  2317. bind: {
  2318. <K extends string>(target: Target, name: K, func: Callback<K>, scope?: any): Callback<K>;
  2319. <K extends string>(target: Target[], name: K, func: Callback<K>, scope?: any): Callback<K>[];
  2320. };
  2321. unbind: {
  2322. <K extends string>(target: Target, name?: K, func?: EventUtilsCallback<MappedEvent<HTMLElementEventMap, K>>): EventUtils;
  2323. <K extends string>(target: Target[], name?: K, func?: EventUtilsCallback<MappedEvent<HTMLElementEventMap, K>>): EventUtils[];
  2324. };
  2325. fire: (target: Node | Window, name: string, evt?: {}) => EventUtils;
  2326. dispatch: (target: Node | Window, name: string, evt?: {}) => EventUtils;
  2327. getContentEditable: (node: Node) => string | null;
  2328. getContentEditableParent: (node: Node) => string | null;
  2329. isEditable: (node: Node | null | undefined) => boolean;
  2330. destroy: () => void;
  2331. isChildOf: (node: Node, parent: Node) => boolean;
  2332. dumpRng: (r: Range) => string;
  2333. }
  2334. interface ClientRect {
  2335. left: number;
  2336. top: number;
  2337. bottom: number;
  2338. right: number;
  2339. width: number;
  2340. height: number;
  2341. }
  2342. interface BookmarkManager {
  2343. getBookmark: (type?: number, normalized?: boolean) => Bookmark;
  2344. moveToBookmark: (bookmark: Bookmark) => void;
  2345. }
  2346. interface ControlSelection {
  2347. isResizable: (elm: Element) => boolean;
  2348. showResizeRect: (elm: HTMLElement) => void;
  2349. hideResizeRect: () => void;
  2350. updateResizeRect: (evt: EditorEvent<any>) => void;
  2351. destroy: () => void;
  2352. }
  2353. interface WriterSettings {
  2354. element_format?: 'xhtml' | 'html';
  2355. entities?: string;
  2356. entity_encoding?: EntityEncoding;
  2357. indent?: boolean;
  2358. indent_after?: string;
  2359. indent_before?: string;
  2360. }
  2361. type Attributes = Array<{
  2362. name: string;
  2363. value: string;
  2364. }>;
  2365. interface Writer {
  2366. cdata: (text: string) => void;
  2367. comment: (text: string) => void;
  2368. doctype: (text: string) => void;
  2369. end: (name: string) => void;
  2370. getContent: () => string;
  2371. pi: (name: string, text?: string) => void;
  2372. reset: () => void;
  2373. start: (name: string, attrs?: Attributes | null, empty?: boolean) => void;
  2374. text: (text: string, raw?: boolean) => void;
  2375. }
  2376. interface HtmlSerializerSettings extends WriterSettings {
  2377. inner?: boolean;
  2378. validate?: boolean;
  2379. }
  2380. interface HtmlSerializer {
  2381. serialize: (node: AstNode) => string;
  2382. }
  2383. interface DomSerializerSettings extends DomParserSettings, WriterSettings, SchemaSettings, HtmlSerializerSettings {
  2384. remove_trailing_brs?: boolean;
  2385. url_converter?: URLConverter;
  2386. url_converter_scope?: {};
  2387. }
  2388. interface DomSerializerImpl {
  2389. schema: Schema;
  2390. addNodeFilter: (name: string, callback: ParserFilterCallback) => void;
  2391. addAttributeFilter: (name: string, callback: ParserFilterCallback) => void;
  2392. getNodeFilters: () => ParserFilter[];
  2393. getAttributeFilters: () => ParserFilter[];
  2394. removeNodeFilter: (name: string, callback?: ParserFilterCallback) => void;
  2395. removeAttributeFilter: (name: string, callback?: ParserFilterCallback) => void;
  2396. serialize: {
  2397. (node: Element, parserArgs: {
  2398. format: 'tree';
  2399. } & ParserArgs): AstNode;
  2400. (node: Element, parserArgs?: ParserArgs): string;
  2401. };
  2402. addRules: (rules: string) => void;
  2403. setRules: (rules: string) => void;
  2404. addTempAttr: (name: string) => void;
  2405. getTempAttrs: () => string[];
  2406. }
  2407. interface DomSerializer extends DomSerializerImpl {
  2408. }
  2409. interface EditorSelection {
  2410. bookmarkManager: BookmarkManager;
  2411. controlSelection: ControlSelection;
  2412. dom: DOMUtils;
  2413. win: Window;
  2414. serializer: DomSerializer;
  2415. editor: Editor;
  2416. collapse: (toStart?: boolean) => void;
  2417. setCursorLocation: {
  2418. (node: Node, offset: number): void;
  2419. (): void;
  2420. };
  2421. getContent: {
  2422. (args: {
  2423. format: 'tree';
  2424. } & Partial<GetSelectionContentArgs>): AstNode;
  2425. (args?: Partial<GetSelectionContentArgs>): string;
  2426. };
  2427. setContent: (content: string, args?: Partial<SetSelectionContentArgs>) => void;
  2428. getBookmark: (type?: number, normalized?: boolean) => Bookmark;
  2429. moveToBookmark: (bookmark: Bookmark) => void;
  2430. select: (node: Node, content?: boolean) => Node;
  2431. isCollapsed: () => boolean;
  2432. isEditable: () => boolean;
  2433. isForward: () => boolean;
  2434. setNode: (elm: Element) => Element;
  2435. getNode: () => HTMLElement;
  2436. getSel: () => Selection | null;
  2437. setRng: (rng: Range, forward?: boolean) => void;
  2438. getRng: () => Range;
  2439. getStart: (real?: boolean) => Element;
  2440. getEnd: (real?: boolean) => Element;
  2441. getSelectedBlocks: (startElm?: Element, endElm?: Element) => Element[];
  2442. normalize: () => Range;
  2443. selectorChanged: (selector: string, callback: (active: boolean, args: {
  2444. node: Node;
  2445. selector: String;
  2446. parents: Node[];
  2447. }) => void) => EditorSelection;
  2448. selectorChangedWithUnbind: (selector: string, callback: (active: boolean, args: {
  2449. node: Node;
  2450. selector: String;
  2451. parents: Node[];
  2452. }) => void) => {
  2453. unbind: () => void;
  2454. };
  2455. getScrollContainer: () => HTMLElement | undefined;
  2456. scrollIntoView: (elm?: HTMLElement, alignToTop?: boolean) => void;
  2457. placeCaretAt: (clientX: number, clientY: number) => void;
  2458. getBoundingClientRect: () => ClientRect | DOMRect;
  2459. destroy: () => void;
  2460. expand: (options?: {
  2461. type: 'word';
  2462. }) => void;
  2463. }
  2464. type EditorCommandCallback<S> = (this: S, ui: boolean, value: any) => void;
  2465. type EditorCommandsCallback = (command: string, ui: boolean, value?: any) => void;
  2466. interface Commands {
  2467. state: Record<string, (command: string) => boolean>;
  2468. exec: Record<string, EditorCommandsCallback>;
  2469. value: Record<string, (command: string) => string>;
  2470. }
  2471. interface ExecCommandArgs {
  2472. skip_focus?: boolean;
  2473. }
  2474. interface EditorCommandsConstructor {
  2475. readonly prototype: EditorCommands;
  2476. new (editor: Editor): EditorCommands;
  2477. }
  2478. declare class EditorCommands {
  2479. private readonly editor;
  2480. private commands;
  2481. constructor(editor: Editor);
  2482. execCommand(command: string, ui?: boolean, value?: any, args?: ExecCommandArgs): boolean;
  2483. queryCommandState(command: string): boolean;
  2484. queryCommandValue(command: string): string;
  2485. addCommands<K extends keyof Commands>(commandList: Commands[K], type: K): void;
  2486. addCommands(commandList: Record<string, EditorCommandsCallback>): void;
  2487. addCommand<S>(command: string, callback: EditorCommandCallback<S>, scope: S): void;
  2488. addCommand(command: string, callback: EditorCommandCallback<Editor>): void;
  2489. queryCommandSupported(command: string): boolean;
  2490. addQueryStateHandler<S>(command: string, callback: (this: S) => boolean, scope: S): void;
  2491. addQueryStateHandler(command: string, callback: (this: Editor) => boolean): void;
  2492. addQueryValueHandler<S>(command: string, callback: (this: S) => string, scope: S): void;
  2493. addQueryValueHandler(command: string, callback: (this: Editor) => string): void;
  2494. }
  2495. interface RawString {
  2496. raw: string;
  2497. }
  2498. type Primitive = string | number | boolean | Record<string | number, any> | Function;
  2499. type TokenisedString = [
  2500. string,
  2501. ...Primitive[]
  2502. ];
  2503. type Untranslated = Primitive | TokenisedString | RawString | null | undefined;
  2504. type TranslatedString = string;
  2505. interface I18n {
  2506. getData: () => Record<string, Record<string, string>>;
  2507. setCode: (newCode: string) => void;
  2508. getCode: () => string;
  2509. add: (code: string, items: Record<string, string>) => void;
  2510. translate: (text: Untranslated) => TranslatedString;
  2511. isRtl: () => boolean;
  2512. hasCode: (code: string) => boolean;
  2513. }
  2514. interface Observable<T extends {}> {
  2515. fire<K extends string, U extends MappedEvent<T, K>>(name: K, args?: U, bubble?: boolean): EditorEvent<U>;
  2516. dispatch<K extends string, U extends MappedEvent<T, K>>(name: K, args?: U, bubble?: boolean): EditorEvent<U>;
  2517. on<K extends string>(name: K, callback: (event: EditorEvent<MappedEvent<T, K>>) => void, prepend?: boolean): EventDispatcher<T>;
  2518. off<K extends string>(name?: K, callback?: (event: EditorEvent<MappedEvent<T, K>>) => void): EventDispatcher<T>;
  2519. once<K extends string>(name: K, callback: (event: EditorEvent<MappedEvent<T, K>>) => void): EventDispatcher<T>;
  2520. hasEventListeners(name: string): boolean;
  2521. }
  2522. interface URISettings {
  2523. base_uri?: URI;
  2524. }
  2525. interface URIConstructor {
  2526. readonly prototype: URI;
  2527. new (url: string, settings?: URISettings): URI;
  2528. getDocumentBaseUrl: (loc: {
  2529. protocol: string;
  2530. host?: string;
  2531. href?: string;
  2532. pathname?: string;
  2533. }) => string;
  2534. parseDataUri: (uri: string) => {
  2535. type: string;
  2536. data: string;
  2537. };
  2538. }
  2539. interface SafeUriOptions {
  2540. readonly allow_html_data_urls?: boolean;
  2541. readonly allow_script_urls?: boolean;
  2542. readonly allow_svg_data_urls?: boolean;
  2543. }
  2544. declare class URI {
  2545. static parseDataUri(uri: string): {
  2546. type: string | undefined;
  2547. data: string;
  2548. };
  2549. static isDomSafe(uri: string, context?: string, options?: SafeUriOptions): boolean;
  2550. static getDocumentBaseUrl(loc: {
  2551. protocol: string;
  2552. host?: string;
  2553. href?: string;
  2554. pathname?: string;
  2555. }): string;
  2556. source: string;
  2557. protocol: string | undefined;
  2558. authority: string | undefined;
  2559. userInfo: string | undefined;
  2560. user: string | undefined;
  2561. password: string | undefined;
  2562. host: string | undefined;
  2563. port: string | undefined;
  2564. relative: string | undefined;
  2565. path: string;
  2566. directory: string;
  2567. file: string | undefined;
  2568. query: string | undefined;
  2569. anchor: string | undefined;
  2570. settings: URISettings;
  2571. constructor(url: string, settings?: URISettings);
  2572. setPath(path: string): void;
  2573. toRelative(uri: string): string;
  2574. toAbsolute(uri: string, noHost?: boolean): string;
  2575. isSameOrigin(uri: URI): boolean;
  2576. toRelPath(base: string, path: string): string;
  2577. toAbsPath(base: string, path: string): string;
  2578. getURI(noProtoHost?: boolean): string;
  2579. }
  2580. interface EditorManager extends Observable<EditorManagerEventMap> {
  2581. defaultOptions: RawEditorOptions;
  2582. majorVersion: string;
  2583. minorVersion: string;
  2584. releaseDate: string;
  2585. activeEditor: Editor | null;
  2586. focusedEditor: Editor | null;
  2587. baseURI: URI;
  2588. baseURL: string;
  2589. documentBaseURL: string;
  2590. i18n: I18n;
  2591. suffix: string;
  2592. add(this: EditorManager, editor: Editor): Editor;
  2593. addI18n: (code: string, item: Record<string, string>) => void;
  2594. createEditor(this: EditorManager, id: string, options: RawEditorOptions): Editor;
  2595. execCommand(this: EditorManager, cmd: string, ui: boolean, value: any): boolean;
  2596. get(this: EditorManager): Editor[];
  2597. get(this: EditorManager, id: number | string): Editor | null;
  2598. init(this: EditorManager, options: RawEditorOptions): Promise<Editor[]>;
  2599. overrideDefaults(this: EditorManager, defaultOptions: Partial<RawEditorOptions>): void;
  2600. remove(this: EditorManager): void;
  2601. remove(this: EditorManager, selector: string): void;
  2602. remove(this: EditorManager, editor: Editor): Editor | null;
  2603. setActive(this: EditorManager, editor: Editor): void;
  2604. setup(this: EditorManager): void;
  2605. translate: (text: Untranslated) => TranslatedString;
  2606. triggerSave: () => void;
  2607. _setBaseUrl(this: EditorManager, baseUrl: string): void;
  2608. }
  2609. interface EditorObservable extends Observable<EditorEventMap> {
  2610. bindPendingEventDelegates(this: Editor): void;
  2611. toggleNativeEvent(this: Editor, name: string, state: boolean): void;
  2612. unbindAllNativeEvents(this: Editor): void;
  2613. }
  2614. interface ProcessorSuccess<T> {
  2615. valid: true;
  2616. value: T;
  2617. }
  2618. interface ProcessorError {
  2619. valid: false;
  2620. message: string;
  2621. }
  2622. type SimpleProcessor = (value: unknown) => boolean;
  2623. type Processor<T> = (value: unknown) => ProcessorSuccess<T> | ProcessorError;
  2624. interface BuiltInOptionTypeMap {
  2625. 'string': string;
  2626. 'number': number;
  2627. 'boolean': boolean;
  2628. 'array': any[];
  2629. 'function': Function;
  2630. 'object': any;
  2631. 'string[]': string[];
  2632. 'object[]': any[];
  2633. 'regexp': RegExp;
  2634. }
  2635. type BuiltInOptionType = keyof BuiltInOptionTypeMap;
  2636. interface BaseOptionSpec {
  2637. immutable?: boolean;
  2638. deprecated?: boolean;
  2639. docsUrl?: string;
  2640. }
  2641. interface BuiltInOptionSpec<K extends BuiltInOptionType> extends BaseOptionSpec {
  2642. processor: K;
  2643. default?: BuiltInOptionTypeMap[K];
  2644. }
  2645. interface SimpleOptionSpec<T> extends BaseOptionSpec {
  2646. processor: SimpleProcessor;
  2647. default?: T;
  2648. }
  2649. interface OptionSpec<T, U> extends BaseOptionSpec {
  2650. processor: Processor<U>;
  2651. default?: T;
  2652. }
  2653. interface Options {
  2654. register: {
  2655. <K extends BuiltInOptionType>(name: string, spec: BuiltInOptionSpec<K>): void;
  2656. <K extends keyof NormalizedEditorOptions>(name: K, spec: OptionSpec<NormalizedEditorOptions[K], EditorOptions[K]> | SimpleOptionSpec<NormalizedEditorOptions[K]>): void;
  2657. <T, U>(name: string, spec: OptionSpec<T, U>): void;
  2658. <T>(name: string, spec: SimpleOptionSpec<T>): void;
  2659. };
  2660. isRegistered: (name: string) => boolean;
  2661. get: {
  2662. <K extends keyof EditorOptions>(name: K): EditorOptions[K];
  2663. <T>(name: string): T | undefined;
  2664. };
  2665. set: <K extends string, T>(name: K, value: K extends keyof NormalizedEditorOptions ? NormalizedEditorOptions[K] : T) => boolean;
  2666. unset: (name: string) => boolean;
  2667. isSet: (name: string) => boolean;
  2668. debug: () => void;
  2669. }
  2670. interface UploadResult$1 {
  2671. element: HTMLImageElement;
  2672. status: boolean;
  2673. blobInfo: BlobInfo;
  2674. uploadUri: string;
  2675. removed: boolean;
  2676. }
  2677. interface EditorUpload {
  2678. blobCache: BlobCache;
  2679. addFilter: (filter: (img: HTMLImageElement) => boolean) => void;
  2680. uploadImages: () => Promise<UploadResult$1[]>;
  2681. uploadImagesAuto: () => Promise<UploadResult$1[]>;
  2682. scanForImages: () => Promise<BlobInfoImagePair[]>;
  2683. destroy: () => void;
  2684. }
  2685. type FormatChangeCallback = (state: boolean, data: {
  2686. node: Node;
  2687. format: string;
  2688. parents: Element[];
  2689. }) => void;
  2690. interface FormatRegistry {
  2691. get: {
  2692. (name: string): Format[] | undefined;
  2693. (): Record<string, Format[]>;
  2694. };
  2695. has: (name: string) => boolean;
  2696. register: (name: string | Formats, format?: Format[] | Format) => void;
  2697. unregister: (name: string) => Formats;
  2698. }
  2699. interface Formatter extends FormatRegistry {
  2700. apply: (name: string, vars?: FormatVars, node?: Node | RangeLikeObject | null) => void;
  2701. remove: (name: string, vars?: FormatVars, node?: Node | Range, similar?: boolean) => void;
  2702. toggle: (name: string, vars?: FormatVars, node?: Node) => void;
  2703. match: (name: string, vars?: FormatVars, node?: Node, similar?: boolean) => boolean;
  2704. closest: (names: string[]) => string | null;
  2705. matchAll: (names: string[], vars?: FormatVars) => string[];
  2706. matchNode: (node: Node | null, name: string, vars?: FormatVars, similar?: boolean) => Format | undefined;
  2707. canApply: (name: string) => boolean;
  2708. formatChanged: (names: string, callback: FormatChangeCallback, similar?: boolean, vars?: FormatVars) => {
  2709. unbind: () => void;
  2710. };
  2711. getCssText: (format: string | ApplyFormat) => string;
  2712. }
  2713. interface EditorMode {
  2714. isReadOnly: () => boolean;
  2715. set: (mode: string) => void;
  2716. get: () => string;
  2717. register: (mode: string, api: EditorModeApi) => void;
  2718. }
  2719. interface EditorModeApi {
  2720. activate: () => void;
  2721. deactivate: () => void;
  2722. editorReadOnly: boolean;
  2723. }
  2724. interface Model {
  2725. readonly table: {
  2726. readonly getSelectedCells: () => HTMLTableCellElement[];
  2727. readonly clearSelectedCells: (container: Node) => void;
  2728. };
  2729. }
  2730. type ModelManager = AddOnManager<Model>;
  2731. interface Plugin {
  2732. getMetadata?: () => {
  2733. name: string;
  2734. url: string;
  2735. };
  2736. init?: (editor: Editor, url: string) => void;
  2737. [key: string]: any;
  2738. }
  2739. type PluginManager = AddOnManager<void | Plugin>;
  2740. interface ShortcutsConstructor {
  2741. readonly prototype: Shortcuts;
  2742. new (editor: Editor): Shortcuts;
  2743. }
  2744. type CommandFunc = string | [
  2745. string,
  2746. boolean,
  2747. any
  2748. ] | (() => void);
  2749. declare class Shortcuts {
  2750. private readonly editor;
  2751. private readonly shortcuts;
  2752. private pendingPatterns;
  2753. constructor(editor: Editor);
  2754. add(pattern: string, desc: string | null, cmdFunc: CommandFunc, scope?: any): boolean;
  2755. remove(pattern: string): boolean;
  2756. private normalizeCommandFunc;
  2757. private createShortcut;
  2758. private hasModifier;
  2759. private isFunctionKey;
  2760. private matchShortcut;
  2761. private executeShortcutAction;
  2762. }
  2763. interface RenderResult {
  2764. iframeContainer?: HTMLElement;
  2765. editorContainer: HTMLElement;
  2766. api?: Partial<EditorUiApi>;
  2767. }
  2768. interface Theme {
  2769. ui?: any;
  2770. inline?: any;
  2771. execCommand?: (command: string, ui?: boolean, value?: any) => boolean;
  2772. destroy?: () => void;
  2773. init?: (editor: Editor, url: string) => void;
  2774. renderUI?: () => Promise<RenderResult> | RenderResult;
  2775. getNotificationManagerImpl?: () => NotificationManagerImpl;
  2776. getWindowManagerImpl?: () => WindowManagerImpl;
  2777. }
  2778. type ThemeManager = AddOnManager<void | Theme>;
  2779. interface EditorConstructor {
  2780. readonly prototype: Editor;
  2781. new (id: string, options: RawEditorOptions, editorManager: EditorManager): Editor;
  2782. }
  2783. declare class Editor implements EditorObservable {
  2784. documentBaseUrl: string;
  2785. baseUri: URI;
  2786. id: string;
  2787. plugins: Record<string, Plugin>;
  2788. documentBaseURI: URI;
  2789. baseURI: URI;
  2790. contentCSS: string[];
  2791. contentStyles: string[];
  2792. ui: EditorUi;
  2793. mode: EditorMode;
  2794. options: Options;
  2795. editorUpload: EditorUpload;
  2796. shortcuts: Shortcuts;
  2797. loadedCSS: Record<string, any>;
  2798. editorCommands: EditorCommands;
  2799. suffix: string;
  2800. editorManager: EditorManager;
  2801. hidden: boolean;
  2802. inline: boolean;
  2803. hasVisual: boolean;
  2804. isNotDirty: boolean;
  2805. annotator: Annotator;
  2806. bodyElement: HTMLElement | undefined;
  2807. bookmark: any;
  2808. composing: boolean;
  2809. container: HTMLElement;
  2810. contentAreaContainer: HTMLElement;
  2811. contentDocument: Document;
  2812. contentWindow: Window;
  2813. delegates: Record<string, EventUtilsCallback<any>> | undefined;
  2814. destroyed: boolean;
  2815. dom: DOMUtils;
  2816. editorContainer: HTMLElement;
  2817. eventRoot: Element | undefined;
  2818. formatter: Formatter;
  2819. formElement: HTMLElement | undefined;
  2820. formEventDelegate: ((e: Event) => void) | undefined;
  2821. hasHiddenInput: boolean;
  2822. iframeElement: HTMLIFrameElement | null;
  2823. iframeHTML: string | undefined;
  2824. initialized: boolean;
  2825. notificationManager: NotificationManager;
  2826. orgDisplay: string;
  2827. orgVisibility: string | undefined;
  2828. parser: DomParser;
  2829. quirks: Quirks;
  2830. readonly: boolean;
  2831. removed: boolean;
  2832. schema: Schema;
  2833. selection: EditorSelection;
  2834. serializer: DomSerializer;
  2835. startContent: string;
  2836. targetElm: HTMLElement;
  2837. theme: Theme;
  2838. model: Model;
  2839. undoManager: UndoManager;
  2840. windowManager: WindowManager;
  2841. _beforeUnload: (() => void) | undefined;
  2842. _eventDispatcher: EventDispatcher<NativeEventMap> | undefined;
  2843. _nodeChangeDispatcher: NodeChange;
  2844. _pendingNativeEvents: string[];
  2845. _selectionOverrides: SelectionOverrides;
  2846. _skinLoaded: boolean;
  2847. _editableRoot: boolean;
  2848. bindPendingEventDelegates: EditorObservable['bindPendingEventDelegates'];
  2849. toggleNativeEvent: EditorObservable['toggleNativeEvent'];
  2850. unbindAllNativeEvents: EditorObservable['unbindAllNativeEvents'];
  2851. fire: EditorObservable['fire'];
  2852. dispatch: EditorObservable['dispatch'];
  2853. on: EditorObservable['on'];
  2854. off: EditorObservable['off'];
  2855. once: EditorObservable['once'];
  2856. hasEventListeners: EditorObservable['hasEventListeners'];
  2857. constructor(id: string, options: RawEditorOptions, editorManager: EditorManager);
  2858. render(): void;
  2859. focus(skipFocus?: boolean): void;
  2860. hasFocus(): boolean;
  2861. translate(text: Untranslated): TranslatedString;
  2862. getParam<K extends BuiltInOptionType>(name: string, defaultVal: BuiltInOptionTypeMap[K], type: K): BuiltInOptionTypeMap[K];
  2863. getParam<K extends keyof NormalizedEditorOptions>(name: K, defaultVal?: NormalizedEditorOptions[K], type?: BuiltInOptionType): NormalizedEditorOptions[K];
  2864. getParam<T>(name: string, defaultVal: T, type?: BuiltInOptionType): T;
  2865. hasPlugin(name: string, loaded?: boolean): boolean;
  2866. nodeChanged(args?: any): void;
  2867. addCommand<S>(name: string, callback: EditorCommandCallback<S>, scope: S): void;
  2868. addCommand(name: string, callback: EditorCommandCallback<Editor>): void;
  2869. addQueryStateHandler<S>(name: string, callback: (this: S) => boolean, scope?: S): void;
  2870. addQueryStateHandler(name: string, callback: (this: Editor) => boolean): void;
  2871. addQueryValueHandler<S>(name: string, callback: (this: S) => string, scope: S): void;
  2872. addQueryValueHandler(name: string, callback: (this: Editor) => string): void;
  2873. addShortcut(pattern: string, desc: string, cmdFunc: string | [
  2874. string,
  2875. boolean,
  2876. any
  2877. ] | (() => void), scope?: any): void;
  2878. execCommand(cmd: string, ui?: boolean, value?: any, args?: ExecCommandArgs): boolean;
  2879. queryCommandState(cmd: string): boolean;
  2880. queryCommandValue(cmd: string): string;
  2881. queryCommandSupported(cmd: string): boolean;
  2882. show(): void;
  2883. hide(): void;
  2884. isHidden(): boolean;
  2885. setProgressState(state: boolean, time?: number): void;
  2886. load(args?: Partial<SetContentArgs>): string;
  2887. save(args?: Partial<GetContentArgs>): string;
  2888. setContent(content: string, args?: Partial<SetContentArgs>): string;
  2889. setContent(content: AstNode, args?: Partial<SetContentArgs>): AstNode;
  2890. setContent(content: Content, args?: Partial<SetContentArgs>): Content;
  2891. getContent(args: {
  2892. format: 'tree';
  2893. } & Partial<GetContentArgs>): AstNode;
  2894. getContent(args?: Partial<GetContentArgs>): string;
  2895. insertContent(content: string, args?: any): void;
  2896. resetContent(initialContent?: string): void;
  2897. isDirty(): boolean;
  2898. setDirty(state: boolean): void;
  2899. getContainer(): HTMLElement;
  2900. getContentAreaContainer(): HTMLElement;
  2901. getElement(): HTMLElement;
  2902. getWin(): Window;
  2903. getDoc(): Document;
  2904. getBody(): HTMLElement;
  2905. convertURL(url: string, name: string, elm?: string | Element): string;
  2906. addVisual(elm?: HTMLElement): void;
  2907. setEditableRoot(state: boolean): void;
  2908. hasEditableRoot(): boolean;
  2909. remove(): void;
  2910. destroy(automatic?: boolean): void;
  2911. uploadImages(): Promise<UploadResult$1[]>;
  2912. _scanForImages(): Promise<BlobInfoImagePair[]>;
  2913. }
  2914. interface UrlObject {
  2915. prefix: string;
  2916. resource: string;
  2917. suffix: string;
  2918. }
  2919. type WaitState = 'added' | 'loaded';
  2920. type AddOnConstructor<T> = (editor: Editor, url: string) => T;
  2921. interface AddOnManager<T> {
  2922. items: AddOnConstructor<T>[];
  2923. urls: Record<string, string>;
  2924. lookup: Record<string, {
  2925. instance: AddOnConstructor<T>;
  2926. }>;
  2927. get: (name: string) => AddOnConstructor<T> | undefined;
  2928. requireLangPack: (name: string, languages?: string) => void;
  2929. add: (id: string, addOn: AddOnConstructor<T>) => AddOnConstructor<T>;
  2930. remove: (name: string) => void;
  2931. createUrl: (baseUrl: UrlObject, dep: string | UrlObject) => UrlObject;
  2932. load: (name: string, addOnUrl: string | UrlObject) => Promise<void>;
  2933. waitFor: (name: string, state?: WaitState) => Promise<void>;
  2934. }
  2935. interface RangeUtils {
  2936. walk: (rng: Range, callback: (nodes: Node[]) => void) => void;
  2937. split: (rng: Range) => RangeLikeObject;
  2938. normalize: (rng: Range) => boolean;
  2939. expand: (rng: Range, options?: {
  2940. type: 'word';
  2941. }) => Range;
  2942. }
  2943. interface ScriptLoaderSettings {
  2944. referrerPolicy?: ReferrerPolicy;
  2945. }
  2946. interface ScriptLoaderConstructor {
  2947. readonly prototype: ScriptLoader;
  2948. new (): ScriptLoader;
  2949. ScriptLoader: ScriptLoader;
  2950. }
  2951. declare class ScriptLoader {
  2952. static ScriptLoader: ScriptLoader;
  2953. private settings;
  2954. private states;
  2955. private queue;
  2956. private scriptLoadedCallbacks;
  2957. private queueLoadedCallbacks;
  2958. private loading;
  2959. constructor(settings?: ScriptLoaderSettings);
  2960. _setReferrerPolicy(referrerPolicy: ReferrerPolicy): void;
  2961. loadScript(url: string): Promise<void>;
  2962. isDone(url: string): boolean;
  2963. markDone(url: string): void;
  2964. add(url: string): Promise<void>;
  2965. load(url: string): Promise<void>;
  2966. remove(url: string): void;
  2967. loadQueue(): Promise<void>;
  2968. loadScripts(scripts: string[]): Promise<void>;
  2969. }
  2970. type TextProcessCallback = (node: Text, offset: number, text: string) => number;
  2971. interface Spot {
  2972. container: Text;
  2973. offset: number;
  2974. }
  2975. interface TextSeeker {
  2976. backwards: (node: Node, offset: number, process: TextProcessCallback, root?: Node) => Spot | null;
  2977. forwards: (node: Node, offset: number, process: TextProcessCallback, root?: Node) => Spot | null;
  2978. }
  2979. interface DomTreeWalkerConstructor {
  2980. readonly prototype: DomTreeWalker;
  2981. new (startNode: Node, rootNode: Node): DomTreeWalker;
  2982. }
  2983. declare class DomTreeWalker {
  2984. private readonly rootNode;
  2985. private node;
  2986. constructor(startNode: Node, rootNode: Node);
  2987. current(): Node | null | undefined;
  2988. next(shallow?: boolean): Node | null | undefined;
  2989. prev(shallow?: boolean): Node | null | undefined;
  2990. prev2(shallow?: boolean): Node | null | undefined;
  2991. private findSibling;
  2992. private findPreviousNode;
  2993. }
  2994. interface Version {
  2995. major: number;
  2996. minor: number;
  2997. }
  2998. interface Env {
  2999. transparentSrc: string;
  3000. documentMode: number;
  3001. cacheSuffix: any;
  3002. container: any;
  3003. canHaveCSP: boolean;
  3004. windowsPhone: boolean;
  3005. browser: {
  3006. current: string | undefined;
  3007. version: Version;
  3008. isEdge: () => boolean;
  3009. isChromium: () => boolean;
  3010. isIE: () => boolean;
  3011. isOpera: () => boolean;
  3012. isFirefox: () => boolean;
  3013. isSafari: () => boolean;
  3014. };
  3015. os: {
  3016. current: string | undefined;
  3017. version: Version;
  3018. isWindows: () => boolean;
  3019. isiOS: () => boolean;
  3020. isAndroid: () => boolean;
  3021. isMacOS: () => boolean;
  3022. isLinux: () => boolean;
  3023. isSolaris: () => boolean;
  3024. isFreeBSD: () => boolean;
  3025. isChromeOS: () => boolean;
  3026. };
  3027. deviceType: {
  3028. isiPad: () => boolean;
  3029. isiPhone: () => boolean;
  3030. isTablet: () => boolean;
  3031. isPhone: () => boolean;
  3032. isTouch: () => boolean;
  3033. isWebView: () => boolean;
  3034. isDesktop: () => boolean;
  3035. };
  3036. }
  3037. interface FakeClipboardItem {
  3038. readonly items: Record<string, any>;
  3039. readonly types: ReadonlyArray<string>;
  3040. readonly getType: <D = any>(type: string) => D | undefined;
  3041. }
  3042. interface FakeClipboard {
  3043. readonly FakeClipboardItem: (items: Record<string, any>) => FakeClipboardItem;
  3044. readonly write: (data: FakeClipboardItem[]) => void;
  3045. readonly read: () => FakeClipboardItem[] | undefined;
  3046. readonly clear: () => void;
  3047. }
  3048. interface FocusManager {
  3049. isEditorUIElement: (elm: Element) => boolean;
  3050. }
  3051. interface EntitiesMap {
  3052. [name: string]: string;
  3053. }
  3054. interface Entities {
  3055. encodeRaw: (text: string, attr?: boolean) => string;
  3056. encodeAllRaw: (text: string) => string;
  3057. encodeNumeric: (text: string, attr?: boolean) => string;
  3058. encodeNamed: (text: string, attr?: boolean, entities?: EntitiesMap) => string;
  3059. getEncodeFunc: (name: string, entities?: string) => (text: string, attr?: boolean) => string;
  3060. decode: (text: string) => string;
  3061. }
  3062. interface IconPack {
  3063. icons: Record<string, string>;
  3064. }
  3065. interface IconManager {
  3066. add: (id: string, iconPack: IconPack) => void;
  3067. get: (id: string) => IconPack;
  3068. has: (id: string) => boolean;
  3069. }
  3070. interface Resource {
  3071. load: <T = any>(id: string, url: string) => Promise<T>;
  3072. add: (id: string, data: any) => void;
  3073. has: (id: string) => boolean;
  3074. get: (id: string) => any;
  3075. unload: (id: string) => void;
  3076. }
  3077. type TextPatterns_d_Pattern = Pattern;
  3078. type TextPatterns_d_RawPattern = RawPattern;
  3079. type TextPatterns_d_DynamicPatternsLookup = DynamicPatternsLookup;
  3080. type TextPatterns_d_RawDynamicPatternsLookup = RawDynamicPatternsLookup;
  3081. type TextPatterns_d_DynamicPatternContext = DynamicPatternContext;
  3082. type TextPatterns_d_BlockCmdPattern = BlockCmdPattern;
  3083. type TextPatterns_d_BlockPattern = BlockPattern;
  3084. type TextPatterns_d_BlockFormatPattern = BlockFormatPattern;
  3085. type TextPatterns_d_InlineCmdPattern = InlineCmdPattern;
  3086. type TextPatterns_d_InlinePattern = InlinePattern;
  3087. type TextPatterns_d_InlineFormatPattern = InlineFormatPattern;
  3088. declare namespace TextPatterns_d {
  3089. export { TextPatterns_d_Pattern as Pattern, TextPatterns_d_RawPattern as RawPattern, TextPatterns_d_DynamicPatternsLookup as DynamicPatternsLookup, TextPatterns_d_RawDynamicPatternsLookup as RawDynamicPatternsLookup, TextPatterns_d_DynamicPatternContext as DynamicPatternContext, TextPatterns_d_BlockCmdPattern as BlockCmdPattern, TextPatterns_d_BlockPattern as BlockPattern, TextPatterns_d_BlockFormatPattern as BlockFormatPattern, TextPatterns_d_InlineCmdPattern as InlineCmdPattern, TextPatterns_d_InlinePattern as InlinePattern, TextPatterns_d_InlineFormatPattern as InlineFormatPattern, };
  3090. }
  3091. interface Delay {
  3092. setEditorInterval: (editor: Editor, callback: () => void, time?: number) => number;
  3093. setEditorTimeout: (editor: Editor, callback: () => void, time?: number) => number;
  3094. }
  3095. type UploadResult = UploadResult$2;
  3096. interface ImageUploader {
  3097. upload: (blobInfos: BlobInfo[], showNotification?: boolean) => Promise<UploadResult[]>;
  3098. }
  3099. type ArrayCallback$1<T, R> = (this: any, x: T, i: number, xs: ArrayLike<T>) => R;
  3100. type ObjCallback$1<T, R> = (this: any, value: T, key: string, obj: Record<string, T>) => R;
  3101. type ArrayCallback<T, R> = ArrayCallback$1<T, R>;
  3102. type ObjCallback<T, R> = ObjCallback$1<T, R>;
  3103. type WalkCallback<T> = (this: any, o: T, i: string, n: keyof T | undefined) => boolean | void;
  3104. interface Tools {
  3105. is: (obj: any, type?: string) => boolean;
  3106. isArray: <T>(arr: any) => arr is Array<T>;
  3107. inArray: <T>(arr: ArrayLike<T>, value: T) => number;
  3108. grep: {
  3109. <T>(arr: ArrayLike<T> | null | undefined, pred?: ArrayCallback<T, boolean>): T[];
  3110. <T>(arr: Record<string, T> | null | undefined, pred?: ObjCallback<T, boolean>): T[];
  3111. };
  3112. trim: (str: string | null | undefined) => string;
  3113. toArray: <T>(obj: ArrayLike<T>) => T[];
  3114. hasOwn: (obj: any, name: string) => boolean;
  3115. makeMap: (items: ArrayLike<string> | string | undefined, delim?: string | RegExp, map?: Record<string, {}>) => Record<string, {}>;
  3116. each: {
  3117. <T>(arr: ArrayLike<T> | null | undefined, cb: ArrayCallback<T, void | boolean>, scope?: any): boolean;
  3118. <T>(obj: Record<string, T> | null | undefined, cb: ObjCallback<T, void | boolean>, scope?: any): boolean;
  3119. };
  3120. map: {
  3121. <T, R>(arr: ArrayLike<T> | null | undefined, cb: ArrayCallback<T, R>): R[];
  3122. <T, R>(obj: Record<string, T> | null | undefined, cb: ObjCallback<T, R>): R[];
  3123. };
  3124. extend: (obj: Object, ext: Object, ...objs: Object[]) => any;
  3125. walk: <T extends Record<string, any>>(obj: T, f: WalkCallback<T>, n?: keyof T, scope?: any) => void;
  3126. resolve: (path: string, o?: Object) => any;
  3127. explode: (s: string | string[], d?: string | RegExp) => string[];
  3128. _addCacheSuffix: (url: string) => string;
  3129. }
  3130. interface KeyboardLikeEvent {
  3131. shiftKey: boolean;
  3132. ctrlKey: boolean;
  3133. altKey: boolean;
  3134. metaKey: boolean;
  3135. }
  3136. interface VK {
  3137. BACKSPACE: number;
  3138. DELETE: number;
  3139. DOWN: number;
  3140. ENTER: number;
  3141. ESC: number;
  3142. LEFT: number;
  3143. RIGHT: number;
  3144. SPACEBAR: number;
  3145. TAB: number;
  3146. UP: number;
  3147. PAGE_UP: number;
  3148. PAGE_DOWN: number;
  3149. END: number;
  3150. HOME: number;
  3151. modifierPressed: (e: KeyboardLikeEvent) => boolean;
  3152. metaKeyPressed: (e: KeyboardLikeEvent) => boolean;
  3153. }
  3154. interface DOMUtilsNamespace {
  3155. (doc: Document, settings: Partial<DOMUtilsSettings>): DOMUtils;
  3156. DOM: DOMUtils;
  3157. nodeIndex: (node: Node, normalized?: boolean) => number;
  3158. }
  3159. interface RangeUtilsNamespace {
  3160. (dom: DOMUtils): RangeUtils;
  3161. compareRanges: (rng1: RangeLikeObject, rng2: RangeLikeObject) => boolean;
  3162. getCaretRangeFromPoint: (clientX: number, clientY: number, doc: Document) => Range;
  3163. getSelectedNode: (range: Range) => Node;
  3164. getNode: (container: Node, offset: number) => Node;
  3165. }
  3166. interface AddOnManagerNamespace {
  3167. <T>(): AddOnManager<T>;
  3168. language: string | undefined;
  3169. languageLoad: boolean;
  3170. baseURL: string;
  3171. PluginManager: PluginManager;
  3172. ThemeManager: ThemeManager;
  3173. ModelManager: ModelManager;
  3174. }
  3175. interface BookmarkManagerNamespace {
  3176. (selection: EditorSelection): BookmarkManager;
  3177. isBookmarkNode: (node: Node) => boolean;
  3178. }
  3179. interface TinyMCE extends EditorManager {
  3180. geom: {
  3181. Rect: Rect;
  3182. };
  3183. util: {
  3184. Delay: Delay;
  3185. Tools: Tools;
  3186. VK: VK;
  3187. URI: URIConstructor;
  3188. EventDispatcher: EventDispatcherConstructor<any>;
  3189. Observable: Observable<any>;
  3190. I18n: I18n;
  3191. LocalStorage: Storage;
  3192. ImageUploader: ImageUploader;
  3193. };
  3194. dom: {
  3195. EventUtils: EventUtilsConstructor;
  3196. TreeWalker: DomTreeWalkerConstructor;
  3197. TextSeeker: (dom: DOMUtils, isBlockBoundary?: (node: Node) => boolean) => TextSeeker;
  3198. DOMUtils: DOMUtilsNamespace;
  3199. ScriptLoader: ScriptLoaderConstructor;
  3200. RangeUtils: RangeUtilsNamespace;
  3201. Serializer: (settings: DomSerializerSettings, editor?: Editor) => DomSerializer;
  3202. ControlSelection: (selection: EditorSelection, editor: Editor) => ControlSelection;
  3203. BookmarkManager: BookmarkManagerNamespace;
  3204. Selection: (dom: DOMUtils, win: Window, serializer: DomSerializer, editor: Editor) => EditorSelection;
  3205. StyleSheetLoader: (documentOrShadowRoot: Document | ShadowRoot, settings: StyleSheetLoaderSettings) => StyleSheetLoader;
  3206. Event: EventUtils;
  3207. };
  3208. html: {
  3209. Styles: (settings?: StylesSettings, schema?: Schema) => Styles;
  3210. Entities: Entities;
  3211. Node: AstNodeConstructor;
  3212. Schema: (settings?: SchemaSettings) => Schema;
  3213. DomParser: (settings?: DomParserSettings, schema?: Schema) => DomParser;
  3214. Writer: (settings?: WriterSettings) => Writer;
  3215. Serializer: (settings?: HtmlSerializerSettings, schema?: Schema) => HtmlSerializer;
  3216. };
  3217. AddOnManager: AddOnManagerNamespace;
  3218. Annotator: (editor: Editor) => Annotator;
  3219. Editor: EditorConstructor;
  3220. EditorCommands: EditorCommandsConstructor;
  3221. EditorManager: EditorManager;
  3222. EditorObservable: EditorObservable;
  3223. Env: Env;
  3224. FocusManager: FocusManager;
  3225. Formatter: (editor: Editor) => Formatter;
  3226. NotificationManager: (editor: Editor) => NotificationManager;
  3227. Shortcuts: ShortcutsConstructor;
  3228. UndoManager: (editor: Editor) => UndoManager;
  3229. WindowManager: (editor: Editor) => WindowManager;
  3230. DOM: DOMUtils;
  3231. ScriptLoader: ScriptLoader;
  3232. PluginManager: PluginManager;
  3233. ThemeManager: ThemeManager;
  3234. ModelManager: ModelManager;
  3235. IconManager: IconManager;
  3236. Resource: Resource;
  3237. FakeClipboard: FakeClipboard;
  3238. trim: Tools['trim'];
  3239. isArray: Tools['isArray'];
  3240. is: Tools['is'];
  3241. toArray: Tools['toArray'];
  3242. makeMap: Tools['makeMap'];
  3243. each: Tools['each'];
  3244. map: Tools['map'];
  3245. grep: Tools['grep'];
  3246. inArray: Tools['inArray'];
  3247. extend: Tools['extend'];
  3248. walk: Tools['walk'];
  3249. resolve: Tools['resolve'];
  3250. explode: Tools['explode'];
  3251. _addCacheSuffix: Tools['_addCacheSuffix'];
  3252. }
  3253. declare const tinymce: TinyMCE;
  3254. export { AddOnManager, Annotator, AstNode, Bookmark, BookmarkManager, ControlSelection, DOMUtils, Delay, DomParser, DomParserSettings, DomSerializer, DomSerializerSettings, DomTreeWalker, Editor, EditorCommands, EditorEvent, EditorManager, EditorModeApi, EditorObservable, EditorOptions, EditorSelection, Entities, Env, EventDispatcher, EventUtils, EventTypes_d as Events, FakeClipboard, FocusManager, Format_d as Formats, Formatter, GeomRect, HtmlSerializer, HtmlSerializerSettings, I18n, IconManager, Model, ModelManager, NotificationApi, NotificationManager, NotificationSpec, Observable, Plugin, PluginManager, RangeUtils, RawEditorOptions, Rect, Resource, Schema, SchemaSettings, ScriptLoader, Shortcuts, StyleSheetLoader, Styles, TextPatterns_d as TextPatterns, TextSeeker, Theme, ThemeManager, TinyMCE, Tools, URI, Ui_d as Ui, UndoManager, VK, WindowManager, Writer, WriterSettings, tinymce as default };