-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmethods.html
More file actions
381 lines (345 loc) · 35.9 KB
/
Copy pathmethods.html
File metadata and controls
381 lines (345 loc) · 35.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SquibView Methods Reference</title>
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'><circle cx='16' cy='16' r='14' fill='%23f57c00' stroke='%23000' stroke-width='1'/><path d='M2 16h28M16 2a14 14 0 0114 14 14 14 0 01-14 14 14 14 0 01-14-14A14 14 0 0116 2zm0 0v28M9 16a7 7 0 0014 0 7 7 0 00-14 0z' fill='none' stroke='%23000' stroke-width='1'/></svg>">
<style>
/* Additional CSS */
/* SquibView CLI Generated Styles */
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', sans-serif;
line-height: 1.6;
color: #333;
max-width: 900px;
margin: 0 auto;
padding: 2rem 3rem;
background-color: #fff;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.5em;
margin-bottom: 0.5em;
font-weight: 600;
line-height: 1.25;
}
h1 {
font-size: 2rem;
}
h2 {
font-size: 1.5rem;
}
h3 { font-size: 1.25rem; }
h4 { font-size: 1rem; }
h5 { font-size: 0.875rem; }
h6 { font-size: 0.85rem; color: #666; }
p { margin-bottom: 1rem; }
a {
color: #0066cc;
text-decoration: none;
}
a:hover {
color: #0066cc;
text-decoration: underline;
}
ul, ol {
margin-bottom: 1rem;
padding-left: 2rem;
}
li {
margin-bottom: 0.25rem;
}
blockquote {
margin: 1rem 0;
padding: 0.5rem 1rem;
border-left: 4px solid #ddd;
background-color: #f9f9f9;
color: #666;
}
code {
background-color: #f5f5f5;
padding: 0.2em 0.4em;
border-radius: 3px;
font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace;
font-size: 0.85em;
}
pre {
background-color: #f8f8f8;
padding: 1rem;
margin-bottom: 1rem;
overflow-x: auto;
border-radius: 4px;
}
pre code {
background-color: transparent;
padding: 0;
border-radius: 0;
}
table {
border-collapse: collapse;
width: 100%;
margin-bottom: 1rem;
}
th, td {
border: 1px solid #ddd;
padding: 0.5rem;
text-align: left;
}
th {
background-color: #f2f2f2;
font-weight: bold;
}
img {
max-width: 100%;
height: auto;
margin-bottom: 1rem;
}
hr {
border: none;
border-top: 1px solid #ddd;
margin: 2rem 0;
}
/* Badge images - inline display */
p img {
display: inline;
margin: 0 2px;
vertical-align: middle;
}
/* Math styling */
.MathJax {
overflow-x: auto;
overflow-y: hidden;
}
/* Responsive design */
@media (max-width: 768px) {
body {
padding: 1rem 1.5rem;
}
table {
font-size: 0.875rem;
}
th, td {
padding: 0.25rem;
}
}
/* Print styles */
@media print {
body {
padding: 0;
color: #000;
}
a {
color: #000;
text-decoration: underline;
}
pre, blockquote {
page-break-inside: avoid;
}
h1, h2, h3, h4, h5, h6 {
page-break-after: avoid;
}
}
</style>
<!-- Highlight.js for syntax highlighting -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<!-- Leaflet for GeoJSON/TopoJSON maps -->
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css">
<script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js"></script>
<script src="https://unpkg.com/topojson-client@3.1.0/dist/topojson-client.min.js"></script>
<!-- Three.js for STL 3D models -->
<script src="https://unpkg.com/three@0.171.0/build/three.min.js"></script>
<!-- MathJax for math rendering -->
<script>
window.MathJax = {
tex: {
inlineMath: [['$', '$'], ['\\(', '\\)']],
displayMath: [['$$', '$$'], ['\\[', '\\]']],
processEscapes: true,
processEnvironments: true
},
options: {
ignoreHtmlClass: 'tex2jax_ignore',
processHtmlClass: 'tex2jax_process'
},
svg: {
fontCache: 'global'
}
};
</script>
<script type="text/javascript" id="MathJax-script" async
src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js">
</script>
<!-- Mermaid for diagram rendering -->
<script src="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js"></script>
</head>
<body>
<div><h1>SquibView Methods Reference</h1><p>Complete reference for all public methods of the SquibView class.</p><h2>Content Management</h2><h3>setContent</h3><p>Sets the editor content and optionally changes the content type.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">setContent</span>(content, contentType, saveRevision = <span class="hljs-literal">true</span>)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>content</code> (string) - The content to set</li><li><code>contentType</code> (string) - Optional. Content type (‘md’, ‘html’, ‘reveal’, ‘csv’, ‘tsv’)</li><li><code>saveRevision</code> (boolean) - Whether to save this change to revision history</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">setContent</span>(<span class="hljs-string">'# New Content'</span>, <span class="hljs-string">'md'</span>);
editor.<span class="hljs-title function_">setContent</span>(<span class="hljs-string">'<h1>HTML Content</h1>'</span>, <span class="hljs-string">'html'</span>, <span class="hljs-literal">false</span>);
</code></pre></div><hr><h3>getContent</h3><p>Returns the current source content.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">getContent</span>()
</code></pre></div><p><strong>Returns:</strong><code>string</code> - The current source content</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> content = editor.<span class="hljs-title function_">getContent</span>();
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(content);
</code></pre></div><hr><h3>getHTMLSource</h3><p>Returns the rendered HTML output.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">getHTMLSource</span>()
</code></pre></div><p><strong>Returns:</strong><code>string</code> - The rendered HTML</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> html = editor.<span class="hljs-title function_">getHTMLSource</span>();
<span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'preview'</span>).<span class="hljs-property">innerHTML</span> = html;
</code></pre></div><hr><h3>clearContent</h3><p>Clears all content from the editor.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">clearContent</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">clearContent</span>();
</code></pre></div><h2>View Control</h2><h3>setView</h3><p>Changes the editor view mode.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">setView</span>(view)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>view</code> (string) - View mode: ‘src’, ‘html’, or ‘split’</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">setView</span>(<span class="hljs-string">'split'</span>);
editor.<span class="hljs-title function_">setView</span>(<span class="hljs-string">'html'</span>);
</code></pre></div><hr><h3>toggleView</h3><p>Cycles through the available view modes (src → html → split → src).</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">toggleView</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">toggleView</span>();
</code></pre></div><hr><h3>showSource</h3><p>Shows only the source editor view.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">showSource</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">showSource</span>();
</code></pre></div><hr><h3>showHTML</h3><p>Shows only the rendered HTML view.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">showHTML</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">showHTML</span>();
</code></pre></div><hr><h3>showSplit</h3><p>Shows the split view with both source and rendered output.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">showSplit</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">showSplit</span>();
</code></pre></div><h2>Content Type</h2><h3>setContentType</h3><p>Changes the content type and re-renders the content.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">setContentType</span>(type)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>type</code> (string) - Content type: ‘md’, ‘html’, ‘reveal’, ‘csv’, or ‘tsv’</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">setContentType</span>(<span class="hljs-string">'md'</span>);
editor.<span class="hljs-title function_">setContentType</span>(<span class="hljs-string">'csv'</span>);
</code></pre></div><hr><h3>getContentType</h3><p>Returns the current content type.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">getContentType</span>()
</code></pre></div><p><strong>Returns:</strong><code>string</code> - Current content type</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> type = editor.<span class="hljs-title function_">getContentType</span>();
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(type); <span class="hljs-comment">// 'md'</span></code></pre></div><h2>Revision Management</h2><h3>revisionUndo</h3><p>Undoes the last change and restores previous content.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">revisionUndo</span>()
</code></pre></div><p><strong>Returns:</strong><code>boolean</code> - True if undo was performed, false if no history</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">if</span> (editor.<span class="hljs-title function_">revisionUndo</span>()) {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Undo performed'</span>);
}
</code></pre></div><hr><h3>revisionRedo</h3><p>Redoes a previously undone change.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">revisionRedo</span>()
</code></pre></div><p><strong>Returns:</strong><code>boolean</code> - True if redo was performed, false if no redo history</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">if</span> (editor.<span class="hljs-title function_">revisionRedo</span>()) {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Redo performed'</span>);
}
</code></pre></div><hr><h3>revisionGetCurrentIndex</h3><p>Gets the current position in the revision history.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">revisionGetCurrentIndex</span>()
</code></pre></div><p><strong>Returns:</strong><code>number</code> - Current revision index (0-based)</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> currentIndex = editor.<span class="hljs-title function_">revisionGetCurrentIndex</span>();
<span class="hljs-keyword">const</span> totalRevisions = editor.<span class="hljs-title function_">revisionNumRevsions</span>();
<span class="hljs-comment">// Check if undo/redo are available</span><span class="hljs-keyword">const</span> canUndo = currentIndex > <span class="hljs-number">0</span>;
<span class="hljs-keyword">const</span> canRedo = totalRevisions > <span class="hljs-number">0</span> && currentIndex < totalRevisions - <span class="hljs-number">1</span>;
<span class="hljs-keyword">if</span> (canUndo) {
<span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'undoBtn'</span>).<span class="hljs-property">disabled</span> = <span class="hljs-literal">false</span>;
}
<span class="hljs-keyword">if</span> (canRedo) {
<span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'redoBtn'</span>).<span class="hljs-property">disabled</span> = <span class="hljs-literal">false</span>;
}
</code></pre></div><hr><h3>revisionNumRevsions</h3><p>Returns the number of revisions in history.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">revisionNumRevsions</span>()
</code></pre></div><p><strong>Returns:</strong><code>number</code> - Number of saved revisions</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> count = editor.<span class="hljs-title function_">revisionNumRevsions</span>();
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`<span class="hljs-subst">${count}</span> revisions saved`</span>);
</code></pre></div><hr><h3>revisionSet</h3><p>Jumps to a specific revision by index.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">revisionSet</span>(index)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>index</code> (number) - The revision index to jump to</li></ul><p><strong>Returns:</strong><code>boolean</code> - True if revision was set successfully</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">revisionSet</span>(<span class="hljs-number">0</span>); <span class="hljs-comment">// Jump to first revision</span>
editor.<span class="hljs-title function_">revisionSet</span>(editor.<span class="hljs-title function_">revisionNumRevsions</span>() - <span class="hljs-number">1</span>); <span class="hljs-comment">// Jump to latest</span></code></pre></div><h2>Selection & Clipboard</h2><h3>copySource</h3><p>Copies the source content (markdown) to the clipboard.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">copySource</span>()
</code></pre></div><p><strong>Returns:</strong><code>Promise<boolean></code> - True if copy succeeded</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">await</span> editor.<span class="hljs-title function_">copySource</span>();
</code></pre></div><hr><h3>copyHTML</h3><p>Copies the rendered HTML to the clipboard.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">copyHTML</span>()
</code></pre></div><p><strong>Returns:</strong><code>Promise<boolean></code> - True if copy succeeded</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">await</span> editor.<span class="hljs-title function_">copyHTML</span>();
</code></pre></div><hr><h3>copyToClipboard</h3><p>Low-level method to copy any text string to the clipboard.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">copyToClipboard</span>(text)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>text</code> (string) - The text to copy</li></ul><p><strong>Returns:</strong><code>boolean</code> - True if copy succeeded</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> success = editor.<span class="hljs-title function_">copyToClipboard</span>(<span class="hljs-string">'Custom text'</span>);
</code></pre></div><hr><h3>Getting Selected Text</h3><p>SquibView doesn’t expose a public method for getting selected text directly. Use the browser’s selection API:</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Get selected text from browser</span><span class="hljs-keyword">const</span> selection = <span class="hljs-variable language_">window</span>.<span class="hljs-title function_">getSelection</span>();
<span class="hljs-keyword">const</span> selectedText = selection ? selection.<span class="hljs-title function_">toString</span>() : <span class="hljs-string">''</span>;
<span class="hljs-comment">// Or listen for selection events</span>
editor.<span class="hljs-property">events</span>.<span class="hljs-title function_">on</span>(<span class="hljs-string">'text:selected'</span>, <span class="hljs-function">(<span class="hljs-params">data</span>) =></span> {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Selected text:'</span>, data.<span class="hljs-property">text</span>);
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Source:'</span>, data.<span class="hljs-property">source</span>); <span class="hljs-comment">// 'input' or 'output'</span>
});
</code></pre></div><hr><h3>getSelectionData</h3><p>Returns detailed information about the current selection.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">getSelectionData</span>()
</code></pre></div><p><strong>Returns:</strong><code>Object</code> - Selection data with properties:</p><ul><li><code>text</code> (string) - Selected text</li><li><code>html</code> (string) - Selected HTML (if from rendered view)</li><li><code>markdown</code> (string) - Converted markdown (if applicable)</li><li><code>start</code> (number) - Start position (source view)</li><li><code>end</code> (number) - End position (source view)</li><li><code>source</code> (string) - ‘input’ or ‘output’</li></ul><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> selection = editor.<span class="hljs-title function_">getSelectionData</span>();
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Selected text:'</span>, selection.<span class="hljs-property">text</span>);
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'From:'</span>, selection.<span class="hljs-property">source</span>);
</code></pre></div><hr><h3>setOnReplaceSelectedText</h3><p>Sets a handler for replacing selected text.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">setOnReplaceSelectedText</span>(handler)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>handler</code> (function) - Callback function that receives selection data</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">setOnReplaceSelectedText</span>(<span class="hljs-function">(<span class="hljs-params">data</span>) =></span> {
<span class="hljs-keyword">const</span> replacement = data.<span class="hljs-property">text</span>.<span class="hljs-title function_">toUpperCase</span>();
editor.<span class="hljs-title function_">replaceSelectedText</span>(replacement);
});
</code></pre></div><hr><h3>replaceSelectedText</h3><p>Replaces selected text with new text. Requires selection data from the text:selected event.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">replaceSelectedText</span>(newText, selectionData)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>newText</code> (string) - Text to replace selection with</li><li><code>selectionData</code> (object) - Selection data from text:selected event or lastSelectionData</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Listen for text selection and wrap in bold</span>
editor.<span class="hljs-property">events</span>.<span class="hljs-title function_">on</span>(<span class="hljs-string">'text:selected'</span>, <span class="hljs-function">(<span class="hljs-params">data</span>) =></span> {
editor.<span class="hljs-title function_">replaceSelectedText</span>(<span class="hljs-string">`**<span class="hljs-subst">${data.text}</span>**`</span>, data);
});
<span class="hljs-comment">// Or use lastSelectionData if available</span><span class="hljs-keyword">if</span> (editor.<span class="hljs-property">lastSelectionData</span>) {
<span class="hljs-keyword">const</span> text = editor.<span class="hljs-property">lastSelectionData</span>.<span class="hljs-property">text</span>;
editor.<span class="hljs-title function_">replaceSelectedText</span>(<span class="hljs-string">`**<span class="hljs-subst">${text}</span>**`</span>, editor.<span class="hljs-property">lastSelectionData</span>);
}
</code></pre></div><h2>Renderer System</h2><h3>registerRenderer</h3><p>Registers a custom content renderer.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">registerRenderer</span>(type, config)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>type</code> (string) - Content type identifier</li><li><code>config</code> (Object) - Renderer configuration with properties:
<ul><li><code>name</code> (string) - Display name</li><li><code>render</code> (function) - Render function</li><li><code>outputToSource</code> (function) - Optional. Convert output to source</li><li><code>buttons</code> (Array) - Optional. Custom toolbar buttons</li><li><code>operations</code> (Object) - Optional. Button operations</li></ul></li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">registerRenderer</span>(<span class="hljs-string">'json'</span>, {
<span class="hljs-attr">name</span>: <span class="hljs-string">'JSON'</span>,
<span class="hljs-attr">render</span>: <span class="hljs-function">(<span class="hljs-params">content</span>) =></span> {
<span class="hljs-keyword">try</span> {
<span class="hljs-keyword">const</span> parsed = <span class="hljs-title class_">JSON</span>.<span class="hljs-title function_">parse</span>(content);
<span class="hljs-keyword">return</span><span class="hljs-string">`<pre><span class="hljs-subst">${<span class="hljs-built_in">JSON</span>.stringify(parsed, <span class="hljs-literal">null</span>, <span class="hljs-number">2</span>)}</span></pre>`</span>;
} <span class="hljs-keyword">catch</span> (e) {
<span class="hljs-keyword">return</span><span class="hljs-string">`<pre class="error"><span class="hljs-subst">${e.message}</span></pre>`</span>;
}
}
});
</code></pre></div><hr><h3>render</h3><p>Manually triggers content rendering.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">render</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Force re-render after external changes</span>
editor.<span class="hljs-title function_">render</span>();
</code></pre></div><h2>Event System</h2><h3>on</h3><p>Subscribes to an editor event.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">on</span>(event, handler)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>event</code> (string) - Event name</li><li><code>handler</code> (function) - Event handler function</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">on</span>(<span class="hljs-string">'content-change'</span>, <span class="hljs-function">(<span class="hljs-params">data</span>) =></span> {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'Content changed:'</span>, data);
});
editor.<span class="hljs-title function_">on</span>(<span class="hljs-string">'view-change'</span>, <span class="hljs-function">(<span class="hljs-params">view</span>) =></span> {
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">'View changed to:'</span>, view);
});
</code></pre></div><hr><h3>off</h3><p>Unsubscribes from an editor event.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">off</span>(event, handler)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>event</code> (string) - Event name</li><li><code>handler</code> (function) - Handler to remove</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span><span class="hljs-title function_">handler</span> = (<span class="hljs-params">data</span>) => <span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(data);
editor.<span class="hljs-title function_">on</span>(<span class="hljs-string">'content-change'</span>, handler);
<span class="hljs-comment">// Later...</span>
editor.<span class="hljs-title function_">off</span>(<span class="hljs-string">'content-change'</span>, handler);
</code></pre></div><hr><h3>emit</h3><p>Emits a custom event.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">emit</span>(event, data)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>event</code> (string) - Event name</li><li><code>data</code> (any) - Event data</li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript">editor.<span class="hljs-title function_">emit</span>(<span class="hljs-string">'custom-event'</span>, { <span class="hljs-attr">message</span>: <span class="hljs-string">'Hello'</span> });
</code></pre></div><h2>Utility Methods</h2><h3>destroy</h3><p>Cleans up the editor instance and removes event listeners.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">destroy</span>()
</code></pre></div><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Clean up before removing from DOM</span>
editor.<span class="hljs-title function_">destroy</span>();
</code></pre></div><hr><h3>getVersion</h3><p>Returns the library version information.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">getVersion</span>()
</code></pre></div><p><strong>Returns:</strong><code>Object</code> - Version info with <code>version</code> and <code>url</code> properties</p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-keyword">const</span> version = editor.<span class="hljs-title function_">getVersion</span>();
<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(<span class="hljs-string">`SquibView v<span class="hljs-subst">${version.version}</span>`</span>);
</code></pre></div><h2>Line Numbers</h2><h3>setLineNumbers</h3><p>Enables or disables line numbers display.</p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-title function_">setLineNumbers</span>(show, options)
</code></pre></div><p><strong>Parameters:</strong></p><ul><li><code>show</code> (boolean) - Whether to show line numbers</li><li><code>options</code> (Object) - Optional. Line number configuration:
<ul><li><code>start</code> (number) - Starting line number</li><li><code>minDigits</code> (number) - Minimum digit width</li></ul></li></ul><p><strong>Returns:</strong><code>void</code></p><p><strong>Example:</strong></p><div data-source-type="javascript"><pre><code class="hljs language-javascript" data-source-type="code" data-lang="javascript"><span class="hljs-comment">// Enable line numbers</span>
editor.<span class="hljs-title function_">setLineNumbers</span>(<span class="hljs-literal">true</span>);
<span class="hljs-comment">// Enable with custom start</span>
editor.<span class="hljs-title function_">setLineNumbers</span>(<span class="hljs-literal">true</span>, { <span class="hljs-attr">start</span>: <span class="hljs-number">100</span>, <span class="hljs-attr">minDigits</span>: <span class="hljs-number">3</span> });
</code></pre></div><h2>See Also</h2><ul><li><a href="./SquibView.html">SquibView Class</a></li><li><a href="./events.html">Events Reference</a></li><li><a href="./options.html">Options Reference</a></li><li><a href="../examples/">Examples</a></li></ul></div>
<script>
// Initialize MathJax after page load
document.addEventListener('DOMContentLoaded', function() {
if (window.MathJax && window.MathJax.typesetPromise) {
window.MathJax.typesetPromise().catch(function(err) {
console.warn('MathJax typesetting failed:', err);
});
}
});
</script>
<script>
// Initialize Mermaid after page load
document.addEventListener('DOMContentLoaded', function() {
if (window.mermaid) {
try {
window.mermaid.initialize({
startOnLoad: false,
theme: 'default',
securityLevel: 'loose',
fontFamily: 'inherit'
});
// Manually render all mermaid diagrams
const mermaidElements = document.querySelectorAll('.mermaid');
mermaidElements.forEach(function(element, index) {
const id = 'mermaid-' + index;
element.id = id;
try {
window.mermaid.render(id + '-svg', element.textContent, function(svgCode) {
element.innerHTML = svgCode;
});
} catch (err) {
console.warn('Mermaid rendering failed for element', index, ':', err);
// Fallback: show the text content
element.innerHTML = '<pre>' + element.textContent + '</pre>';
}
});
} catch (err) {
console.warn('Mermaid initialization failed:', err);
}
}
});
</script>
</body>
</html>