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.
package/Highlight.svelte CHANGED
@@ -1,21 +1,32 @@
1
- <script context="module"></script>
2
-
3
- <script>export let language;
4
- export let code;
5
- export let langtag = false;
6
- import hljs from "highlight.js/lib/core";
7
- import { createEventDispatcher, afterUpdate } from "svelte";
8
- import LangTag from "./LangTag.svelte";
9
- const dispatch = createEventDispatcher();
10
- let highlighted = "";
11
- afterUpdate(() => {
12
- if (highlighted)
13
- dispatch("highlight", { highlighted });
14
- });
15
- $: {
16
- hljs.registerLanguage(language.name, language.register);
17
- highlighted = hljs.highlight(code, { language: language.name }).value;
18
- }
1
+ <script>
2
+ // @ts-check
3
+
4
+ /** @type {import("./languages").LanguageType<string>} */
5
+ export let language;
6
+
7
+ /** @type {any} */
8
+ export let code;
9
+
10
+ /** @type {boolean} */
11
+ export let langtag = false;
12
+
13
+ import hljs from "highlight.js/lib/core";
14
+ import { createEventDispatcher, afterUpdate } from "svelte";
15
+ import LangTag from "./LangTag.svelte";
16
+
17
+ const dispatch = createEventDispatcher();
18
+
19
+ /** @type {string} */
20
+ let highlighted = "";
21
+
22
+ afterUpdate(() => {
23
+ if (highlighted) dispatch("highlight", { highlighted });
24
+ });
25
+
26
+ $: {
27
+ hljs.registerLanguage(language.name, language.register);
28
+ highlighted = hljs.highlight(code, { language: language.name }).value;
29
+ }
19
30
  </script>
20
31
 
21
32
  <slot {highlighted}>
@@ -1,241 +1,72 @@
1
- import { SvelteComponentTyped } from "svelte";
2
- import type { Slots, Events } from "./shared";
3
- declare const __propDef: {
4
- props: {
5
- code: any;
6
- language: import("./languages").LanguageType<string>;
7
- langtag?: boolean;
8
- "--langtag-background"?: string;
9
- "--langtag-color"?: string;
10
- "--langtag-border-radius"?: string;
11
- accesskey?: string;
12
- autofocus?: boolean;
13
- class?: string;
14
- contenteditable?: "inherit" | import("svelte/elements").Booleanish;
15
- contextmenu?: string;
16
- dir?: string;
17
- draggable?: import("svelte/elements").Booleanish;
18
- enterkeyhint?: "search" | "next" | "done" | "enter" | "go" | "previous" | "send";
19
- hidden?: boolean;
20
- id?: string;
21
- lang?: string;
22
- part?: string;
23
- placeholder?: string;
24
- slot?: string;
25
- spellcheck?: import("svelte/elements").Booleanish;
26
- style?: string;
27
- tabindex?: number;
28
- title?: string;
29
- translate?: "" | "yes" | "no";
30
- inert?: boolean;
31
- radiogroup?: string;
32
- role?: import("svelte/elements").AriaRole;
33
- about?: string;
34
- datatype?: string;
35
- inlist?: any;
36
- prefix?: string;
37
- property?: string;
38
- resource?: string;
39
- typeof?: string;
40
- vocab?: string;
41
- autocapitalize?: string;
42
- autocorrect?: string;
43
- autosave?: string;
44
- color?: string;
45
- itemprop?: string;
46
- itemscope?: boolean;
47
- itemtype?: string;
48
- itemid?: string;
49
- itemref?: string;
50
- results?: number;
51
- security?: string;
52
- unselectable?: "off" | "on";
53
- inputmode?: "search" | "numeric" | "none" | "url" | "text" | "email" | "tel" | "decimal";
54
- is?: string;
55
- 'bind:innerHTML'?: string;
56
- 'bind:textContent'?: string;
57
- 'bind:innerText'?: string;
58
- 'bind:contentRect'?: DOMRectReadOnly;
59
- 'bind:contentBoxSize'?: {
60
- blockSize: number;
61
- inlineSize: number;
62
- }[];
63
- 'bind:borderBoxSize'?: {
64
- blockSize: number;
65
- inlineSize: number;
66
- }[];
67
- 'bind:devicePixelContentBoxSize'?: {
68
- blockSize: number;
69
- inlineSize: number;
70
- }[];
71
- 'data-sveltekit-keepfocus'?: true | "" | "off";
72
- 'data-sveltekit-noscroll'?: true | "" | "off";
73
- 'data-sveltekit-preload-code'?: true | "" | "off" | "eager" | "viewport" | "hover" | "tap";
74
- 'data-sveltekit-preload-data'?: true | "" | "off" | "hover" | "tap";
75
- 'data-sveltekit-reload'?: true | "" | "off";
76
- 'data-sveltekit-replacestate'?: true | "" | "off";
77
- 'aria-activedescendant'?: string;
78
- 'aria-atomic'?: import("svelte/elements").Booleanish;
79
- 'aria-autocomplete'?: "inline" | "both" | "none" | "list";
80
- 'aria-busy'?: import("svelte/elements").Booleanish;
81
- 'aria-checked'?: boolean | "false" | "true" | "mixed";
82
- 'aria-colcount'?: number;
83
- 'aria-colindex'?: number;
84
- 'aria-colspan'?: number;
85
- 'aria-controls'?: string;
86
- 'aria-current'?: "time" | "location" | "page" | import("svelte/elements").Booleanish | "step" | "date";
87
- 'aria-describedby'?: string;
88
- 'aria-details'?: string;
89
- 'aria-disabled'?: import("svelte/elements").Booleanish;
90
- 'aria-dropeffect'?: "link" | "none" | "copy" | "move" | "execute" | "popup";
91
- 'aria-errormessage'?: string;
92
- 'aria-expanded'?: import("svelte/elements").Booleanish;
93
- 'aria-flowto'?: string;
94
- 'aria-grabbed'?: import("svelte/elements").Booleanish;
95
- 'aria-haspopup'?: "grid" | "dialog" | "menu" | import("svelte/elements").Booleanish | "listbox" | "tree";
96
- 'aria-hidden'?: import("svelte/elements").Booleanish;
97
- 'aria-invalid'?: import("svelte/elements").Booleanish | "grammar" | "spelling";
98
- 'aria-keyshortcuts'?: string;
99
- 'aria-label'?: string;
100
- 'aria-labelledby'?: string;
101
- 'aria-level'?: number;
102
- 'aria-live'?: "off" | "assertive" | "polite";
103
- 'aria-modal'?: import("svelte/elements").Booleanish;
104
- 'aria-multiline'?: import("svelte/elements").Booleanish;
105
- 'aria-multiselectable'?: import("svelte/elements").Booleanish;
106
- 'aria-orientation'?: "horizontal" | "vertical";
107
- 'aria-owns'?: string;
108
- 'aria-placeholder'?: string;
109
- 'aria-posinset'?: number;
110
- 'aria-pressed'?: boolean | "false" | "true" | "mixed";
111
- 'aria-readonly'?: import("svelte/elements").Booleanish;
112
- 'aria-relevant'?: "all" | "text" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals";
113
- 'aria-required'?: import("svelte/elements").Booleanish;
114
- 'aria-roledescription'?: string;
115
- 'aria-rowcount'?: number;
116
- 'aria-rowindex'?: number;
117
- 'aria-rowspan'?: number;
118
- 'aria-selected'?: import("svelte/elements").Booleanish;
119
- 'aria-setsize'?: number;
120
- 'aria-sort'?: "none" | "other" | "ascending" | "descending";
121
- 'aria-valuemax'?: number;
122
- 'aria-valuemin'?: number;
123
- 'aria-valuenow'?: number;
124
- 'aria-valuetext'?: string;
125
- 'on:copy'?: import("svelte/elements").ClipboardEventHandler<HTMLPreElement>;
126
- 'on:cut'?: import("svelte/elements").ClipboardEventHandler<HTMLPreElement>;
127
- 'on:paste'?: import("svelte/elements").ClipboardEventHandler<HTMLPreElement>;
128
- 'on:compositionend'?: import("svelte/elements").CompositionEventHandler<HTMLPreElement>;
129
- 'on:compositionstart'?: import("svelte/elements").CompositionEventHandler<HTMLPreElement>;
130
- 'on:compositionupdate'?: import("svelte/elements").CompositionEventHandler<HTMLPreElement>;
131
- 'on:focus'?: import("svelte/elements").FocusEventHandler<HTMLPreElement>;
132
- 'on:focusin'?: import("svelte/elements").FocusEventHandler<HTMLPreElement>;
133
- 'on:focusout'?: import("svelte/elements").FocusEventHandler<HTMLPreElement>;
134
- 'on:blur'?: import("svelte/elements").FocusEventHandler<HTMLPreElement>;
135
- 'on:change'?: import("svelte/elements").FormEventHandler<HTMLPreElement>;
136
- 'on:beforeinput'?: import("svelte/elements").EventHandler<InputEvent, HTMLPreElement>;
137
- 'on:input'?: import("svelte/elements").FormEventHandler<HTMLPreElement>;
138
- 'on:reset'?: import("svelte/elements").FormEventHandler<HTMLPreElement>;
139
- 'on:submit'?: import("svelte/elements").EventHandler<Event & {
140
- readonly submitter: HTMLElement;
141
- }, HTMLPreElement>;
142
- 'on:invalid'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
143
- 'on:formdata'?: import("svelte/elements").EventHandler<Event & {
144
- readonly formData: FormData;
145
- }, HTMLPreElement>;
146
- 'on:load'?: import("svelte/elements").EventHandler<Event, Element>;
147
- 'on:error'?: import("svelte/elements").EventHandler<Event, Element>;
148
- 'on:toggle'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
149
- 'on:keydown'?: import("svelte/elements").KeyboardEventHandler<HTMLPreElement>;
150
- 'on:keypress'?: import("svelte/elements").KeyboardEventHandler<HTMLPreElement>;
151
- 'on:keyup'?: import("svelte/elements").KeyboardEventHandler<HTMLPreElement>;
152
- 'on:abort'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
153
- 'on:canplay'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
154
- 'on:canplaythrough'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
155
- 'on:cuechange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
156
- 'on:durationchange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
157
- 'on:emptied'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
158
- 'on:encrypted'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
159
- 'on:ended'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
160
- 'on:loadeddata'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
161
- 'on:loadedmetadata'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
162
- 'on:loadstart'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
163
- 'on:pause'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
164
- 'on:play'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
165
- 'on:playing'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
166
- 'on:progress'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
167
- 'on:ratechange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
168
- 'on:seeked'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
169
- 'on:seeking'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
170
- 'on:stalled'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
171
- 'on:suspend'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
172
- 'on:timeupdate'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
173
- 'on:volumechange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
174
- 'on:waiting'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
175
- 'on:auxclick'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
176
- 'on:click'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
177
- 'on:contextmenu'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
178
- 'on:dblclick'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
179
- 'on:drag'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
180
- 'on:dragend'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
181
- 'on:dragenter'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
182
- 'on:dragexit'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
183
- 'on:dragleave'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
184
- 'on:dragover'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
185
- 'on:dragstart'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
186
- 'on:drop'?: import("svelte/elements").DragEventHandler<HTMLPreElement>;
187
- 'on:mousedown'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
188
- 'on:mouseenter'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
189
- 'on:mouseleave'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
190
- 'on:mousemove'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
191
- 'on:mouseout'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
192
- 'on:mouseover'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
193
- 'on:mouseup'?: import("svelte/elements").MouseEventHandler<HTMLPreElement>;
194
- 'on:select'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
195
- 'on:selectionchange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
196
- 'on:selectstart'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
197
- 'on:touchcancel'?: import("svelte/elements").TouchEventHandler<HTMLPreElement>;
198
- 'on:touchend'?: import("svelte/elements").TouchEventHandler<HTMLPreElement>;
199
- 'on:touchmove'?: import("svelte/elements").TouchEventHandler<HTMLPreElement>;
200
- 'on:touchstart'?: import("svelte/elements").TouchEventHandler<HTMLPreElement>;
201
- 'on:gotpointercapture'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
202
- 'on:pointercancel'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
203
- 'on:pointerdown'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
204
- 'on:pointerenter'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
205
- 'on:pointerleave'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
206
- 'on:pointermove'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
207
- 'on:pointerout'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
208
- 'on:pointerover'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
209
- 'on:pointerup'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
210
- 'on:lostpointercapture'?: import("svelte/elements").PointerEventHandler<HTMLPreElement>;
211
- 'on:scroll'?: import("svelte/elements").UIEventHandler<HTMLPreElement>;
212
- 'on:resize'?: import("svelte/elements").UIEventHandler<HTMLPreElement>;
213
- 'on:wheel'?: import("svelte/elements").WheelEventHandler<HTMLPreElement>;
214
- 'on:animationstart'?: import("svelte/elements").AnimationEventHandler<HTMLPreElement>;
215
- 'on:animationend'?: import("svelte/elements").AnimationEventHandler<HTMLPreElement>;
216
- 'on:animationiteration'?: import("svelte/elements").AnimationEventHandler<HTMLPreElement>;
217
- 'on:transitionstart'?: import("svelte/elements").TransitionEventHandler<HTMLPreElement>;
218
- 'on:transitionrun'?: import("svelte/elements").TransitionEventHandler<HTMLPreElement>;
219
- 'on:transitionend'?: import("svelte/elements").TransitionEventHandler<HTMLPreElement>;
220
- 'on:transitioncancel'?: import("svelte/elements").TransitionEventHandler<HTMLPreElement>;
221
- 'on:outrostart'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLPreElement>;
222
- 'on:outroend'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLPreElement>;
223
- 'on:introstart'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLPreElement>;
224
- 'on:introend'?: import("svelte/elements").EventHandler<CustomEvent<null>, HTMLPreElement>;
225
- 'on:message'?: import("svelte/elements").MessageEventHandler<HTMLPreElement>;
226
- 'on:messageerror'?: import("svelte/elements").MessageEventHandler<HTMLPreElement>;
227
- 'on:visibilitychange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
228
- 'on:cancel'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
229
- 'on:close'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
230
- 'on:fullscreenchange'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
231
- 'on:fullscreenerror'?: import("svelte/elements").EventHandler<Event, HTMLPreElement>;
232
- };
233
- slots: Slots;
234
- events: Events<import("./shared").HighlightedCode>;
1
+ import type { SvelteComponentTyped } from "svelte";
2
+ import type { HTMLAttributes } from "svelte/elements";
3
+ import type { LanguageType } from "./languages";
4
+
5
+ export type HighlightProps = HTMLAttributes<HTMLPreElement> & {
6
+ /**
7
+ * Specify the text to highlight.
8
+ */
9
+ code: any;
10
+
11
+ /**
12
+ * Provide the language grammar used to highlight the code.
13
+ * Import languages from `svelte-highlight/languages/*`.
14
+ * @example
15
+ * import typescript from "svelte-highlight/languages/typescript";
16
+ */
17
+ language: LanguageType<string>;
18
+
19
+ /**
20
+ * Set to `true` for the language name to be
21
+ * displayed at the top right of the code block.
22
+ *
23
+ * Use style props to customize styles:
24
+ * - `--langtag-background`
25
+ * - `--langtag-color`
26
+ * - `--langtag-border-radius`
27
+ *
28
+ * @default false
29
+ */
30
+ langtag?: boolean;
31
+
32
+ /**
33
+ * Customize the background color of the langtag.
34
+ */
35
+ "--langtag-background"?: string;
36
+
37
+ /**
38
+ * Customize the text color of the langtag.
39
+ */
40
+ "--langtag-color"?: string;
41
+
42
+ /**
43
+ * Customize the border radius of the langtag.
44
+ */
45
+ "--langtag-border-radius"?: string;
235
46
  };
236
- export type HighlightProps = typeof __propDef.props;
237
- export type HighlightEvents = typeof __propDef.events;
238
- export type HighlightSlots = typeof __propDef.slots;
239
- export default class Highlight extends SvelteComponentTyped<HighlightProps, HighlightEvents, HighlightSlots> {
240
- }
241
- export {};
47
+
48
+ export type HighlightEvents = {
49
+ highlight: CustomEvent<{
50
+ /**
51
+ * The highlighted HTML as a string.
52
+ * @example "<span>...</span>"
53
+ */
54
+ highlighted: string;
55
+ }>;
56
+ };
57
+
58
+ export type HighlightSlots = {
59
+ default: {
60
+ /**
61
+ * The highlighted HTML as a string.
62
+ * @example "<span>...</span>"
63
+ */
64
+ highlighted: string;
65
+ };
66
+ };
67
+
68
+ export default class Highlight extends SvelteComponentTyped<
69
+ HighlightProps,
70
+ HighlightEvents,
71
+ HighlightSlots
72
+ > {}
@@ -1,19 +1,33 @@
1
- <script context="module"></script>
2
-
3
- <script>import LangTag from "./LangTag.svelte";
4
- export let code;
5
- export let langtag = false;
6
- import hljs from "highlight.js";
7
- import { createEventDispatcher, afterUpdate } from "svelte";
8
- const dispatch = createEventDispatcher();
9
- let highlighted = "";
10
- let language = void 0;
11
- afterUpdate(() => {
12
- if (highlighted)
13
- dispatch("highlight", { highlighted, language });
14
- });
15
- $:
16
- ({ value: highlighted, language } = hljs.highlightAuto(code));
1
+ <script>
2
+ // @ts-check
3
+ import LangTag from "./LangTag.svelte";
4
+
5
+ /** @type {any} */
6
+ export let code;
7
+
8
+ /** @type {boolean} */
9
+ export let langtag = false;
10
+
11
+ import hljs from "highlight.js";
12
+ import { createEventDispatcher, afterUpdate } from "svelte";
13
+
14
+ /**
15
+ * @typedef {{ highlighted: string; language: string; }} HighlightEventDetail
16
+ * @type {import("svelte").EventDispatcher<{ highlight: HighlightEventDetail}>}
17
+ */
18
+ const dispatch = createEventDispatcher();
19
+
20
+ /** @type {string} */
21
+ let highlighted = "";
22
+
23
+ /** @type {string} */
24
+ let language = "";
25
+
26
+ afterUpdate(() => {
27
+ if (highlighted) dispatch("highlight", { highlighted, language });
28
+ });
29
+
30
+ $: ({ value: highlighted, language = "" } = hljs.highlightAuto(code));
17
31
  </script>
18
32
 
19
33
  <slot {highlighted}>