svelte-highlight 7.4.1 → 7.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,19 +1,29 @@
1
- <script>export let highlighted;
2
- export let hideBorder = false;
3
- export let wrapLines = false;
4
- export let startingLineNumber = 1;
5
- export let highlightedLines = [];
6
- const DIGIT_WIDTH = 12;
7
- const MIN_DIGITS = 2;
8
- const HIGHLIGHTED_BACKGROUND = "rgba(254, 241, 96, 0.2)";
9
- $:
10
- lines = highlighted.split("\n");
11
- $:
12
- len_digits = lines.length.toString().length;
13
- $:
14
- len = len_digits - MIN_DIGITS < 1 ? MIN_DIGITS : len_digits;
15
- $:
16
- width = len * DIGIT_WIDTH;
1
+ <script>
2
+ // @ts-check
3
+
4
+ /** @type {string} */
5
+ export let highlighted;
6
+
7
+ /** @type {boolean} */
8
+ export let hideBorder = false;
9
+
10
+ /** @type {boolean} */
11
+ export let wrapLines = false;
12
+
13
+ /** @type {number} */
14
+ export let startingLineNumber = 1;
15
+
16
+ /** @type {number[]} */
17
+ export let highlightedLines = [];
18
+
19
+ const DIGIT_WIDTH = 12;
20
+ const MIN_DIGITS = 2;
21
+ const HIGHLIGHTED_BACKGROUND = "rgba(254, 241, 96, 0.2)";
22
+
23
+ $: lines = highlighted.split("\n");
24
+ $: len_digits = lines.length.toString().length;
25
+ $: len = len_digits - MIN_DIGITS < 1 ? MIN_DIGITS : len_digits;
26
+ $: width = len * DIGIT_WIDTH;
17
27
  </script>
18
28
 
19
29
  <div style:overflow-x="auto" {...$$restProps}>
@@ -1,297 +1,85 @@
1
- import { SvelteComponentTyped } from "svelte";
2
- declare const __propDef: {
3
- props: {
4
- accesskey?: string;
5
- autofocus?: boolean;
6
- class?: string;
7
- contenteditable?: "inherit" | import("svelte/elements").Booleanish;
8
- contextmenu?: string;
9
- dir?: string;
10
- draggable?: import("svelte/elements").Booleanish;
11
- enterkeyhint?: "search" | "next" | "done" | "enter" | "go" | "previous" | "send";
12
- hidden?: boolean;
13
- id?: string;
14
- lang?: string;
15
- part?: string;
16
- placeholder?: string;
17
- slot?: string;
18
- spellcheck?: import("svelte/elements").Booleanish;
19
- style?: string;
20
- tabindex?: number;
21
- title?: string;
22
- translate?: "" | "yes" | "no";
23
- inert?: boolean;
24
- radiogroup?: string;
25
- role?: import("svelte/elements").AriaRole;
26
- about?: string;
27
- datatype?: string;
28
- inlist?: any;
29
- prefix?: string;
30
- property?: string;
31
- resource?: string;
32
- typeof?: string;
33
- vocab?: string;
34
- autocapitalize?: string;
35
- autocorrect?: string;
36
- autosave?: string;
37
- color?: string;
38
- itemprop?: string;
39
- itemscope?: boolean;
40
- itemtype?: string;
41
- itemid?: string;
42
- itemref?: string;
43
- results?: number;
44
- security?: string;
45
- unselectable?: "off" | "on";
46
- inputmode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal";
47
- is?: string;
48
- 'bind:innerHTML'?: string;
49
- 'bind:textContent'?: string;
50
- 'bind:innerText'?: string;
51
- 'bind:contentRect'?: DOMRectReadOnly;
52
- 'bind:contentBoxSize'?: {
53
- blockSize: number;
54
- inlineSize: number;
55
- }[];
56
- 'bind:borderBoxSize'?: {
57
- blockSize: number;
58
- inlineSize: number;
59
- }[];
60
- 'bind:devicePixelContentBoxSize'?: {
61
- blockSize: number;
62
- inlineSize: number;
63
- }[];
64
- 'data-sveltekit-keepfocus'?: true | "" | "off";
65
- 'data-sveltekit-noscroll'?: true | "" | "off";
66
- 'data-sveltekit-preload-code'?: true | "" | "off" | "eager" | "viewport" | "hover" | "tap";
67
- 'data-sveltekit-preload-data'?: true | "" | "off" | "hover" | "tap";
68
- 'data-sveltekit-reload'?: true | "" | "off";
69
- 'data-sveltekit-replacestate'?: true | "" | "off";
70
- 'aria-activedescendant'?: string;
71
- 'aria-atomic'?: import("svelte/elements").Booleanish;
72
- 'aria-autocomplete'?: "inline" | "both" | "none" | "list";
73
- 'aria-busy'?: import("svelte/elements").Booleanish;
74
- 'aria-checked'?: boolean | "false" | "true" | "mixed";
75
- 'aria-colcount'?: number;
76
- 'aria-colindex'?: number;
77
- 'aria-colspan'?: number;
78
- 'aria-controls'?: string;
79
- 'aria-current'?: "time" | "location" | "page" | import("svelte/elements").Booleanish | "step" | "date";
80
- 'aria-describedby'?: string;
81
- 'aria-details'?: string;
82
- 'aria-disabled'?: import("svelte/elements").Booleanish;
83
- 'aria-dropeffect'?: "link" | "none" | "copy" | "move" | "execute" | "popup";
84
- 'aria-errormessage'?: string;
85
- 'aria-expanded'?: import("svelte/elements").Booleanish;
86
- 'aria-flowto'?: string;
87
- 'aria-grabbed'?: import("svelte/elements").Booleanish;
88
- 'aria-haspopup'?: "grid" | "dialog" | "menu" | import("svelte/elements").Booleanish | "listbox" | "tree";
89
- 'aria-hidden'?: import("svelte/elements").Booleanish;
90
- 'aria-invalid'?: import("svelte/elements").Booleanish | "grammar" | "spelling";
91
- 'aria-keyshortcuts'?: string;
92
- 'aria-label'?: string;
93
- 'aria-labelledby'?: string;
94
- 'aria-level'?: number;
95
- 'aria-live'?: "off" | "assertive" | "polite";
96
- 'aria-modal'?: import("svelte/elements").Booleanish;
97
- 'aria-multiline'?: import("svelte/elements").Booleanish;
98
- 'aria-multiselectable'?: import("svelte/elements").Booleanish;
99
- 'aria-orientation'?: "horizontal" | "vertical";
100
- 'aria-owns'?: string;
101
- 'aria-placeholder'?: string;
102
- 'aria-posinset'?: number;
103
- 'aria-pressed'?: boolean | "false" | "true" | "mixed";
104
- 'aria-readonly'?: import("svelte/elements").Booleanish;
105
- 'aria-relevant'?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
106
- 'aria-required'?: import("svelte/elements").Booleanish;
107
- 'aria-roledescription'?: string;
108
- 'aria-rowcount'?: number;
109
- 'aria-rowindex'?: number;
110
- 'aria-rowspan'?: number;
111
- 'aria-selected'?: import("svelte/elements").Booleanish;
112
- 'aria-setsize'?: number;
113
- 'aria-sort'?: "none" | "other" | "ascending" | "descending";
114
- 'aria-valuemax'?: number;
115
- 'aria-valuemin'?: number;
116
- 'aria-valuenow'?: number;
117
- 'aria-valuetext'?: string;
118
- 'on:copy'?: import("svelte/elements").ClipboardEventHandler<HTMLDivElement>;
119
- 'on:cut'?: import("svelte/elements").ClipboardEventHandler<HTMLDivElement>;
120
- 'on:paste'?: import("svelte/elements").ClipboardEventHandler<HTMLDivElement>;
121
- 'on:compositionend'?: import("svelte/elements").CompositionEventHandler<HTMLDivElement>;
122
- 'on:compositionstart'?: import("svelte/elements").CompositionEventHandler<HTMLDivElement>;
123
- 'on:compositionupdate'?: import("svelte/elements").CompositionEventHandler<HTMLDivElement>;
124
- 'on:focus'?: import("svelte/elements").FocusEventHandler<HTMLDivElement>;
125
- 'on:focusin'?: import("svelte/elements").FocusEventHandler<HTMLDivElement>;
126
- 'on:focusout'?: import("svelte/elements").FocusEventHandler<HTMLDivElement>;
127
- 'on:blur'?: import("svelte/elements").FocusEventHandler<HTMLDivElement>;
128
- 'on:change'?: import("svelte/elements").FormEventHandler<HTMLDivElement>;
129
- 'on:beforeinput'?: import("svelte/elements").EventHandler<InputEvent, HTMLDivElement>;
130
- 'on:input'?: import("svelte/elements").FormEventHandler<HTMLDivElement>;
131
- 'on:reset'?: import("svelte/elements").FormEventHandler<HTMLDivElement>;
132
- 'on:submit'?: import("svelte/elements").EventHandler<Event & {
133
- readonly submitter: HTMLElement;
134
- }, HTMLDivElement>;
135
- 'on:invalid'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
136
- 'on:formdata'?: import("svelte/elements").EventHandler<Event & {
137
- readonly formData: FormData;
138
- }, HTMLDivElement>;
139
- 'on:load'?: import("svelte/elements").EventHandler<Event, Element>;
140
- 'on:error'?: import("svelte/elements").EventHandler<Event, Element>;
141
- 'on:toggle'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
142
- 'on:keydown'?: import("svelte/elements").KeyboardEventHandler<HTMLDivElement>;
143
- 'on:keypress'?: import("svelte/elements").KeyboardEventHandler<HTMLDivElement>;
144
- 'on:keyup'?: import("svelte/elements").KeyboardEventHandler<HTMLDivElement>;
145
- 'on:abort'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
146
- 'on:canplay'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
147
- 'on:canplaythrough'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
148
- 'on:cuechange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
149
- 'on:durationchange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
150
- 'on:emptied'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
151
- 'on:encrypted'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
152
- 'on:ended'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
153
- 'on:loadeddata'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
154
- 'on:loadedmetadata'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
155
- 'on:loadstart'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
156
- 'on:pause'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
157
- 'on:play'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
158
- 'on:playing'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
159
- 'on:progress'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
160
- 'on:ratechange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
161
- 'on:seeked'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
162
- 'on:seeking'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
163
- 'on:stalled'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
164
- 'on:suspend'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
165
- 'on:timeupdate'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
166
- 'on:volumechange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
167
- 'on:waiting'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
168
- 'on:auxclick'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
169
- 'on:click'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
170
- 'on:contextmenu'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
171
- 'on:dblclick'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
172
- 'on:drag'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
173
- 'on:dragend'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
174
- 'on:dragenter'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
175
- 'on:dragexit'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
176
- 'on:dragleave'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
177
- 'on:dragover'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
178
- 'on:dragstart'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
179
- 'on:drop'?: import("svelte/elements").DragEventHandler<HTMLDivElement>;
180
- 'on:mousedown'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
181
- 'on:mouseenter'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
182
- 'on:mouseleave'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
183
- 'on:mousemove'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
184
- 'on:mouseout'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
185
- 'on:mouseover'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
186
- 'on:mouseup'?: import("svelte/elements").MouseEventHandler<HTMLDivElement>;
187
- 'on:select'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
188
- 'on:selectionchange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
189
- 'on:selectstart'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
190
- 'on:touchcancel'?: import("svelte/elements").TouchEventHandler<HTMLDivElement>;
191
- 'on:touchend'?: import("svelte/elements").TouchEventHandler<HTMLDivElement>;
192
- 'on:touchmove'?: import("svelte/elements").TouchEventHandler<HTMLDivElement>;
193
- 'on:touchstart'?: import("svelte/elements").TouchEventHandler<HTMLDivElement>;
194
- 'on:gotpointercapture'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
195
- 'on:pointercancel'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
196
- 'on:pointerdown'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
197
- 'on:pointerenter'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
198
- 'on:pointerleave'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
199
- 'on:pointermove'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
200
- 'on:pointerout'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
201
- 'on:pointerover'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
202
- 'on:pointerup'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
203
- 'on:lostpointercapture'?: import("svelte/elements").PointerEventHandler<HTMLDivElement>;
204
- 'on:scroll'?: import("svelte/elements").UIEventHandler<HTMLDivElement>;
205
- 'on:resize'?: import("svelte/elements").UIEventHandler<HTMLDivElement>;
206
- 'on:wheel'?: import("svelte/elements").WheelEventHandler<HTMLDivElement>;
207
- 'on:animationstart'?: import("svelte/elements").AnimationEventHandler<HTMLDivElement>;
208
- 'on:animationend'?: import("svelte/elements").AnimationEventHandler<HTMLDivElement>;
209
- 'on:animationiteration'?: import("svelte/elements").AnimationEventHandler<HTMLDivElement>;
210
- 'on:transitionstart'?: import("svelte/elements").TransitionEventHandler<HTMLDivElement>;
211
- 'on:transitionrun'?: import("svelte/elements").TransitionEventHandler<HTMLDivElement>;
212
- 'on:transitionend'?: import("svelte/elements").TransitionEventHandler<HTMLDivElement>;
213
- 'on:transitioncancel'?: import("svelte/elements").TransitionEventHandler<HTMLDivElement>;
214
- 'on:outrostart'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLDivElement>;
215
- 'on:outroend'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLDivElement>;
216
- 'on:introstart'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLDivElement>;
217
- 'on:introend'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLDivElement>;
218
- 'on:message'?: import("svelte/elements").MessageEventHandler<HTMLDivElement>;
219
- 'on:messageerror'?: import("svelte/elements").MessageEventHandler<HTMLDivElement>;
220
- 'on:visibilitychange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
221
- 'on:cancel'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
222
- 'on:close'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
223
- 'on:fullscreenchange'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
224
- 'on:fullscreenerror'?: import("svelte/elements").EventHandler<Event, HTMLDivElement>;
225
- /**
226
- * Pass the highlighted `code` to `LineNumbers`.
227
- * @example
228
- * <Highlight language={typescript} {code} let:highlighted>
229
- * <LineNumbers {highlighted} />
230
- * </Highlight>
231
- */
232
- highlighted: string;
233
- /**
234
- * Set to `true` to hide the border of the line numbers column.
235
- * @default false
236
- */
237
- hideBorder?: boolean;
238
- /**
239
- * Specify which starting line number should be displayed.
240
- * @default 1
241
- */
242
- startingLineNumber?: number;
243
- /**
244
- * Set to `true` for lines to wrap.
245
- * @default false
246
- */
247
- wrapLines?: boolean;
248
- /**
249
- * Specify the line indices to highlight.
250
- * @default []
251
- * @example [0, 1, 9]
252
- */
253
- highlightedLines?: number[];
254
- /**
255
- * Specify the text color for line numbers.
256
- * Defaults to the current theme color applied to `.hljs code`.
257
- * @default currentColor
258
- * @example "pink"
259
- */
260
- "--line-number-color"?: string;
261
- /**
262
- * Specify the border color.
263
- * Defaults to the current background color applied to `.hljs`.
264
- * @default currentColor
265
- * @example "#fff"
266
- */
267
- "--border-color"?: string;
268
- /**
269
- * Specify the left padding for `td` elements.
270
- * @default 1em
271
- * @example 0
272
- */
273
- "--padding-left"?: number | string;
274
- /**
275
- * Specify the right padding for `td` elements.
276
- * @default 1em
277
- * @example 0
278
- */
279
- "--padding-right"?: number | string;
280
- /**
281
- * Specify the background color of highlighted lines.
282
- * @default "rgba(254, 241, 96, 0.2)"
283
- * @example "#fff"
284
- */
285
- "--highlighted-background"?: string;
286
- };
287
- events: {
288
- [evt: string]: CustomEvent<any>;
289
- };
290
- slots: {};
1
+ import type { SvelteComponentTyped } from "svelte";
2
+ import type { HTMLAttributes } from "svelte/elements";
3
+
4
+ export type LineNumbersProps = HTMLAttributes<HTMLPreElement> & {
5
+ /**
6
+ * Pass the highlighted `code` to `LineNumbers`.
7
+ * @example
8
+ * <Highlight language={typescript} {code} let:highlighted>
9
+ * <LineNumbers {highlighted} />
10
+ * </Highlight>
11
+ */
12
+ highlighted: string;
13
+
14
+ /**
15
+ * Set to `true` to hide the border of the line numbers column.
16
+ * @default false
17
+ */
18
+ hideBorder?: boolean;
19
+
20
+ /**
21
+ * Specify which starting line number should be displayed.
22
+ * @default 1
23
+ */
24
+ startingLineNumber?: number;
25
+
26
+ /**
27
+ * Set to `true` for lines to wrap.
28
+ * @default false
29
+ */
30
+ wrapLines?: boolean;
31
+
32
+ /**
33
+ * Specify the line indices to highlight.
34
+ * @default []
35
+ * @example [0, 1, 9]
36
+ */
37
+ highlightedLines?: number[];
38
+
39
+ /**
40
+ * Specify the text color for line numbers.
41
+ * Defaults to the current theme color applied to `.hljs code`.
42
+ * @default currentColor
43
+ * @example "pink"
44
+ */
45
+ "--line-number-color"?: string;
46
+
47
+ /**
48
+ * Specify the border color.
49
+ * Defaults to the current background color applied to `.hljs`.
50
+ * @default currentColor
51
+ * @example "#fff"
52
+ */
53
+ "--border-color"?: string;
54
+
55
+ /**
56
+ * Specify the left padding for `td` elements.
57
+ * @default 1em
58
+ * @example 0
59
+ */
60
+ "--padding-left"?: number | string;
61
+
62
+ /**
63
+ * Specify the right padding for `td` elements.
64
+ * @default 1em
65
+ * @example 0
66
+ */
67
+ "--padding-right"?: number | string;
68
+
69
+ /**
70
+ * Specify the background color of highlighted lines.
71
+ * @default "rgba(254, 241, 96, 0.2)"
72
+ * @example "#fff"
73
+ */
74
+ "--highlighted-background"?: string;
291
75
  };
292
- export type LineNumbersProps = typeof __propDef.props;
293
- export type LineNumbersEvents = typeof __propDef.events;
294
- export type LineNumbersSlots = typeof __propDef.slots;
295
- export default class LineNumbers extends SvelteComponentTyped<LineNumbersProps, LineNumbersEvents, LineNumbersSlots> {
296
- }
297
- export {};
76
+
77
+ export type LineNumbersEvents = {};
78
+
79
+ export type LineNumbersSlots = {};
80
+
81
+ export default class LineNumbers extends SvelteComponentTyped<
82
+ LineNumbersProps,
83
+ LineNumbersEvents,
84
+ LineNumbersSlots
85
+ > {}
package/README.md CHANGED
@@ -9,6 +9,8 @@ Try it in [StackBlitz](https://stackblitz.com/edit/svelte-highlight?file=src%2Fr
9
9
 
10
10
  ## [Documentation](https://svhe.onrender.com)
11
11
 
12
+ The Changelog is [available on GitHub](https://github.com/metonym/svelte-highlight/blob/master/CHANGELOG.md).
13
+
12
14
  ## Installation
13
15
 
14
16
  ```bash
package/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { default as default, default as Highlight } from "./Highlight.svelte";
1
+ export { default as Highlight, default as default } from "./Highlight.svelte";
2
2
  export { default as HighlightAuto } from "./HighlightAuto.svelte";
3
3
  export { default as HighlightSvelte } from "./HighlightSvelte.svelte";
4
4
  export { default as LineNumbers } from "./LineNumbers.svelte";
@@ -1,7 +1,7 @@
1
1
  import type { LanguageFn } from "highlight.js";
2
2
 
3
3
  interface LanguageType<TName extends string> {
4
- name?: TName;
4
+ name: TName;
5
5
  register: LanguageFn;
6
6
  }
7
7