svelte-highlight 7.11.0 → 7.13.0

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.
Files changed (108) hide show
  1. package/AnsiOutput.svelte +193 -0
  2. package/AnsiOutput.svelte.d.ts +112 -0
  3. package/CodeWindow.svelte +110 -0
  4. package/CodeWindow.svelte.d.ts +136 -0
  5. package/CopyButton.svelte +115 -0
  6. package/CopyButton.svelte.d.ts +134 -0
  7. package/FileTabs.svelte +161 -0
  8. package/FileTabs.svelte.d.ts +96 -0
  9. package/Highlight.svelte.d.ts +9 -10
  10. package/HighlightAuto.svelte.d.ts +2 -2
  11. package/HighlightEditable.svelte +385 -0
  12. package/HighlightEditable.svelte.d.ts +113 -0
  13. package/HighlightStyle.svelte +40 -0
  14. package/HighlightStyle.svelte.d.ts +50 -0
  15. package/HighlightSvelte.svelte.d.ts +1 -1
  16. package/LangTag.svelte +10 -1
  17. package/LangTag.svelte.d.ts +3 -3
  18. package/LineNumbers.svelte +18 -6
  19. package/LineNumbers.svelte.d.ts +24 -8
  20. package/README.md +832 -7
  21. package/Typewriter.svelte +238 -0
  22. package/Typewriter.svelte.d.ts +65 -0
  23. package/action.d.ts +20 -0
  24. package/action.js +25 -0
  25. package/ansi.d.ts +36 -0
  26. package/ansi.js +198 -0
  27. package/index.d.ts +12 -0
  28. package/index.js +10 -0
  29. package/langtag.css +1 -0
  30. package/languages/bibtex.d.ts +2 -0
  31. package/languages/bibtex.js +47 -0
  32. package/languages/bicep.d.ts +2 -0
  33. package/languages/bicep.js +72 -0
  34. package/languages/blade.d.ts +2 -0
  35. package/languages/blade.js +56 -0
  36. package/languages/caddy.d.ts +2 -0
  37. package/languages/caddy.js +59 -0
  38. package/languages/cairo.d.ts +2 -0
  39. package/languages/cairo.js +69 -0
  40. package/languages/clarity.d.ts +2 -0
  41. package/languages/clarity.js +55 -0
  42. package/languages/cue.d.ts +2 -0
  43. package/languages/cue.js +76 -0
  44. package/languages/cypher.d.ts +2 -0
  45. package/languages/cypher.js +61 -0
  46. package/languages/d2.d.ts +2 -0
  47. package/languages/d2.js +61 -0
  48. package/languages/dhall.d.ts +2 -0
  49. package/languages/dhall.js +74 -0
  50. package/languages/dotenv.d.ts +2 -0
  51. package/languages/dotenv.js +44 -0
  52. package/languages/fish.d.ts +2 -0
  53. package/languages/fish.js +68 -0
  54. package/languages/gleam.d.ts +2 -0
  55. package/languages/gleam.js +63 -0
  56. package/languages/groq.d.ts +2 -0
  57. package/languages/groq.js +69 -0
  58. package/languages/hcl.d.ts +2 -0
  59. package/languages/hcl.js +84 -0
  60. package/languages/index.d.ts +73 -1
  61. package/languages/index.js +36 -0
  62. package/languages/json5.d.ts +2 -0
  63. package/languages/json5.js +55 -0
  64. package/languages/jsonc.d.ts +2 -0
  65. package/languages/jsonc.js +36 -0
  66. package/languages/jsonnet.d.ts +2 -0
  67. package/languages/jsonnet.js +64 -0
  68. package/languages/liquid.d.ts +2 -0
  69. package/languages/liquid.js +55 -0
  70. package/languages/move.d.ts +2 -0
  71. package/languages/move.js +72 -0
  72. package/languages/nickel.d.ts +2 -0
  73. package/languages/nickel.js +65 -0
  74. package/languages/nushell.d.ts +2 -0
  75. package/languages/nushell.js +77 -0
  76. package/languages/odin.d.ts +2 -0
  77. package/languages/odin.js +78 -0
  78. package/languages/pkl.d.ts +2 -0
  79. package/languages/pkl.js +82 -0
  80. package/languages/prisma.d.ts +2 -0
  81. package/languages/prisma.js +70 -0
  82. package/languages/promql.d.ts +2 -0
  83. package/languages/promql.js +61 -0
  84. package/languages/pug.d.ts +2 -0
  85. package/languages/pug.js +50 -0
  86. package/languages/razor.d.ts +2 -0
  87. package/languages/razor.js +69 -0
  88. package/languages/rescript.d.ts +2 -0
  89. package/languages/rescript.js +71 -0
  90. package/languages/solidity.d.ts +2 -0
  91. package/languages/solidity.js +101 -0
  92. package/languages/starlark.d.ts +2 -0
  93. package/languages/starlark.js +54 -0
  94. package/languages/toml.d.ts +2 -0
  95. package/languages/toml.js +74 -0
  96. package/languages/v.d.ts +2 -0
  97. package/languages/v.js +90 -0
  98. package/languages/vyper.d.ts +2 -0
  99. package/languages/vyper.js +57 -0
  100. package/languages/wgsl.d.ts +2 -0
  101. package/languages/wgsl.js +56 -0
  102. package/languages/zig.d.ts +2 -0
  103. package/languages/zig.js +100 -0
  104. package/load-language.d.ts +9 -0
  105. package/load-language.js +15 -0
  106. package/package.json +1 -1
  107. package/scoped.d.ts +23 -0
  108. package/scoped.js +307 -0
@@ -0,0 +1,134 @@
1
+ import type { SvelteComponentTyped } from "svelte";
2
+ import type { HTMLButtonAttributes } from "svelte/elements";
3
+
4
+ export type CopyButtonProps = HTMLButtonAttributes & {
5
+ /**
6
+ * Text to copy.
7
+ */
8
+ code: string;
9
+
10
+ /**
11
+ * Copy handler. Defaults to `navigator.clipboard.writeText`.
12
+ * @default (code) => navigator.clipboard.writeText(code)
13
+ */
14
+ copy?: (code: string) => void | Promise<void>;
15
+
16
+ /**
17
+ * How long the "copied" state lasts (ms).
18
+ * @default 2000
19
+ */
20
+ timeout?: number;
21
+
22
+ /**
23
+ * Copy button `aria-label`.
24
+ * Used as the fallback text only if the default icon slot is overridden.
25
+ * @default "Copy"
26
+ */
27
+ text?: string;
28
+
29
+ /**
30
+ * Copied state `aria-label`.
31
+ * Used as the fallback text only if the default icon slot is overridden.
32
+ * @default "Copied!"
33
+ */
34
+ copiedText?: string;
35
+
36
+ /**
37
+ * Top offset.
38
+ * @default "0.5em"
39
+ */
40
+ "--copy-top"?: string;
41
+
42
+ /**
43
+ * Right offset.
44
+ * @default "0.5em"
45
+ */
46
+ "--copy-right"?: string;
47
+
48
+ /**
49
+ * Button size.
50
+ * @default "2em"
51
+ */
52
+ "--copy-size"?: string;
53
+
54
+ /**
55
+ * Button padding.
56
+ * @default "0.5em"
57
+ */
58
+ "--copy-padding"?: string;
59
+
60
+ /**
61
+ * Button background.
62
+ * @default "inherit"
63
+ */
64
+ "--copy-background"?: string;
65
+
66
+ /**
67
+ * Button color.
68
+ * @default "inherit"
69
+ */
70
+ "--copy-color"?: string;
71
+
72
+ /**
73
+ * Button border radius.
74
+ * @default "4px"
75
+ */
76
+ "--copy-border-radius"?: string;
77
+
78
+ /**
79
+ * Button border.
80
+ * @default "none"
81
+ */
82
+ "--copy-border"?: string;
83
+
84
+ /**
85
+ * Button z-index.
86
+ * @default 2
87
+ */
88
+ "--copy-z-index"?: string | number;
89
+ };
90
+
91
+ export type CopyButtonEvents = {
92
+ copy: CustomEvent<{
93
+ /**
94
+ * The code that was copied.
95
+ */
96
+ code: string;
97
+ }>;
98
+ error: CustomEvent<{
99
+ /**
100
+ * The error thrown by the copy behavior.
101
+ */
102
+ error: unknown;
103
+ }>;
104
+
105
+ /**
106
+ * Useful for prefetching an async copy on hover.
107
+ */
108
+ mouseenter: MouseEvent;
109
+
110
+ /**
111
+ * Forwarded from the `button` element.
112
+ */
113
+ mouseleave: MouseEvent;
114
+ };
115
+
116
+ export type CopyButtonSlots = {
117
+ default: {
118
+ /**
119
+ * `true` while the "copied" state is active.
120
+ */
121
+ copied: boolean;
122
+
123
+ /**
124
+ * `true` while async `copy` is in flight.
125
+ */
126
+ copying: boolean;
127
+ };
128
+ };
129
+
130
+ export default class CopyButton extends SvelteComponentTyped<
131
+ CopyButtonProps,
132
+ CopyButtonEvents,
133
+ CopyButtonSlots
134
+ > {}
@@ -0,0 +1,161 @@
1
+ <script context="module">
2
+ let uid = 0;
3
+ </script>
4
+
5
+ <script>
6
+ /** @type {string[]} */
7
+ export let files;
8
+
9
+ /** @type {string} */
10
+ export let active = files[0];
11
+
12
+ import { afterUpdate, createEventDispatcher } from "svelte";
13
+
14
+ const dispatch = createEventDispatcher();
15
+
16
+ const baseId = `svelte-highlight-file-tabs-${uid++}`;
17
+
18
+ /** @type {HTMLDivElement} */
19
+ let root;
20
+
21
+ /** @type {HTMLButtonElement[]} */
22
+ let tabs = [];
23
+
24
+ $: activeIndex = files.indexOf(active);
25
+
26
+ /** @param {string} file */
27
+ function selectTab(file) {
28
+ if (file === active) return;
29
+ active = file;
30
+ dispatch("change", { active });
31
+ }
32
+
33
+ /**
34
+ * WAI-ARIA tabs keyboard navigation.
35
+ * @param {KeyboardEvent} event
36
+ * @param {number} index
37
+ */
38
+ function handleKeydown(event, index) {
39
+ const lastIndex = files.length - 1;
40
+ let nextIndex = index;
41
+
42
+ switch (event.key) {
43
+ case "ArrowRight":
44
+ case "ArrowDown":
45
+ nextIndex = index === lastIndex ? 0 : index + 1;
46
+ break;
47
+ case "ArrowLeft":
48
+ case "ArrowUp":
49
+ nextIndex = index === 0 ? lastIndex : index - 1;
50
+ break;
51
+ case "Home":
52
+ nextIndex = 0;
53
+ break;
54
+ case "End":
55
+ nextIndex = lastIndex;
56
+ break;
57
+ default:
58
+ return;
59
+ }
60
+
61
+ event.preventDefault();
62
+ selectTab(files[nextIndex]);
63
+ tabs[nextIndex]?.focus();
64
+ }
65
+
66
+ // Match active tab colors to `.hljs`; transparent/inherit at SSR.
67
+ afterUpdate(() => {
68
+ const code = root?.querySelector(".tabpanel .hljs");
69
+
70
+ if (code) {
71
+ const { backgroundColor, color } = getComputedStyle(code);
72
+ root.style.setProperty(
73
+ "--tab-active-resolved-background",
74
+ backgroundColor,
75
+ );
76
+ root.style.setProperty("--tab-active-resolved-color", color);
77
+ }
78
+ });
79
+ </script>
80
+
81
+ <div class="file-tabs" bind:this={root} {...$$restProps}>
82
+ <div role="tablist" class="tablist">
83
+ {#each files as file, index (file)}
84
+ <button
85
+ bind:this={tabs[index]}
86
+ type="button"
87
+ role="tab"
88
+ id="{baseId}-tab-{index}"
89
+ class="tab"
90
+ class:active={file === active}
91
+ aria-controls="{baseId}-panel"
92
+ tabindex={file === active ? 0 : -1}
93
+ {...{
94
+ // Spread sidesteps Biome `useValidAriaValues` on templated booleans.
95
+ "aria-selected": file === active,
96
+ }}
97
+ on:click={() => selectTab(file)}
98
+ on:keydown={(event) => handleKeydown(event, index)}
99
+ >
100
+ {file}
101
+ </button>
102
+ {/each}
103
+ </div>
104
+
105
+ <div
106
+ role="tabpanel"
107
+ id="{baseId}-panel"
108
+ class="tabpanel"
109
+ aria-labelledby="{baseId}-tab-{activeIndex}"
110
+ >
111
+ <slot {active} />
112
+ </div>
113
+ </div>
114
+
115
+ <style>
116
+ .file-tabs {
117
+ display: flex;
118
+ flex-direction: column;
119
+ }
120
+
121
+ .tablist {
122
+ display: flex;
123
+ gap: var(--file-tabs-gap, 0);
124
+ background: var(--file-tabs-background, inherit);
125
+ overflow-x: auto;
126
+ }
127
+
128
+ .tab {
129
+ display: inline-flex;
130
+ align-items: center;
131
+ padding: var(--tab-padding, 0.5em 1em);
132
+ font: inherit;
133
+ color: var(--tab-color, inherit);
134
+ background: var(--tab-background, transparent);
135
+ border: 0;
136
+ cursor: pointer;
137
+ white-space: nowrap;
138
+ opacity: var(--tab-inactive-opacity, 0.55);
139
+ transition:
140
+ opacity 0.1s ease,
141
+ background-color 0.1s ease;
142
+ }
143
+
144
+ .tab:hover {
145
+ opacity: 1;
146
+ }
147
+
148
+ .tab.active {
149
+ opacity: 1;
150
+ color: var(--tab-active-color, var(--tab-active-resolved-color, inherit));
151
+ background: var(
152
+ --tab-active-background,
153
+ var(--tab-active-resolved-background, transparent)
154
+ );
155
+ }
156
+
157
+ .tab:focus-visible {
158
+ outline: var(--tab-focus-outline, 2px solid currentColor);
159
+ outline-offset: -2px;
160
+ }
161
+ </style>
@@ -0,0 +1,96 @@
1
+ import type { SvelteComponentTyped } from "svelte";
2
+ import type { HTMLAttributes } from "svelte/elements";
3
+
4
+ export type FileTabsProps = HTMLAttributes<HTMLDivElement> & {
5
+ /**
6
+ * Tab labels.
7
+ * @example ["App.svelte", "index.js"]
8
+ */
9
+ files: string[];
10
+
11
+ /**
12
+ * Active file (`bind:active`).
13
+ * @default files[0]
14
+ */
15
+ active?: string;
16
+
17
+ /**
18
+ * Gap between tabs.
19
+ * @default 0
20
+ */
21
+ "--file-tabs-gap"?: string | number;
22
+
23
+ /**
24
+ * Tab strip background.
25
+ * @default "inherit"
26
+ */
27
+ "--file-tabs-background"?: string;
28
+
29
+ /**
30
+ * Tab padding.
31
+ * @default "0.5em 1em"
32
+ */
33
+ "--tab-padding"?: string;
34
+
35
+ /**
36
+ * Inactive tab text color.
37
+ * @default "inherit"
38
+ */
39
+ "--tab-color"?: string;
40
+
41
+ /**
42
+ * Inactive tab background.
43
+ * @default "transparent"
44
+ */
45
+ "--tab-background"?: string;
46
+
47
+ /**
48
+ * Inactive tab opacity. Active/hovered tabs stay opaque.
49
+ * @default 0.55
50
+ */
51
+ "--tab-inactive-opacity"?: string | number;
52
+
53
+ /**
54
+ * Active tab text color.
55
+ * Defaults to the highlighted code block's text color.
56
+ * @default the highlighted code's color
57
+ */
58
+ "--tab-active-color"?: string;
59
+
60
+ /**
61
+ * Active tab background.
62
+ * Defaults to the highlighted code block's background.
63
+ * @default the highlighted code's background
64
+ */
65
+ "--tab-active-background"?: string;
66
+
67
+ /**
68
+ * Keyboard focus outline.
69
+ * @default "2px solid currentColor"
70
+ */
71
+ "--tab-focus-outline"?: string;
72
+ };
73
+
74
+ export type FileTabsEvents = {
75
+ change: CustomEvent<{
76
+ /**
77
+ * The newly active file.
78
+ */
79
+ active: string;
80
+ }>;
81
+ };
82
+
83
+ export type FileTabsSlots = {
84
+ default: {
85
+ /**
86
+ * The active file.
87
+ */
88
+ active: string;
89
+ };
90
+ };
91
+
92
+ export default class FileTabs extends SvelteComponentTyped<
93
+ FileTabsProps,
94
+ FileTabsEvents,
95
+ FileTabsSlots
96
+ > {}
@@ -4,8 +4,7 @@ import type { LanguageType } from "./languages";
4
4
 
5
5
  export type LangtagProps = {
6
6
  /**
7
- * Set to `true` for the language name to be
8
- * displayed at the top right of the code block.
7
+ * Set to `true` to show the language name at the top right.
9
8
  *
10
9
  * Use style props to customize styles:
11
10
  * - `--langtag-top`
@@ -20,37 +19,37 @@ export type LangtagProps = {
20
19
  langtag?: boolean;
21
20
 
22
21
  /**
23
- * Customize the top position of the langtag.
22
+ * Langtag top offset.
24
23
  * @default 0
25
24
  */
26
25
  "--langtag-top"?: string | number;
27
26
 
28
27
  /**
29
- * Customize the right position of the langtag.
28
+ * Langtag right offset.
30
29
  * @default 0
31
30
  */
32
31
  "--langtag-right"?: string | number;
33
32
 
34
33
  /**
35
- * Customize the background color of the langtag.
34
+ * Langtag background.
36
35
  * @default "inherit"
37
36
  */
38
37
  "--langtag-background"?: string;
39
38
 
40
39
  /**
41
- * Customize the text color of the langtag.
40
+ * Langtag text color.
42
41
  * @default "inherit"
43
42
  */
44
43
  "--langtag-color"?: string;
45
44
 
46
45
  /**
47
- * Customize the border radius of the langtag.
46
+ * Langtag border radius.
48
47
  * @default 0
49
48
  */
50
49
  "--langtag-border-radius"?: string;
51
50
 
52
51
  /**
53
- * Customize the padding of the langtag.
52
+ * Langtag padding.
54
53
  * @default "1em"
55
54
  */
56
55
  "--langtag-padding"?: string;
@@ -59,12 +58,12 @@ export type LangtagProps = {
59
58
  export type HighlightProps = HTMLAttributes<HTMLPreElement> &
60
59
  LangtagProps & {
61
60
  /**
62
- * Specify the text to highlight.
61
+ * Code to highlight.
63
62
  */
64
63
  code: any;
65
64
 
66
65
  /**
67
- * Provide the language grammar used to highlight the code.
66
+ * highlight.js language module.
68
67
  * Import languages from `svelte-highlight/languages/*`.
69
68
  * @example
70
69
  * import typescript from "svelte-highlight/languages/typescript";
@@ -6,12 +6,12 @@ import type { LanguageName } from "./languages";
6
6
  export type HighlightAutoProps = HTMLAttributes<HTMLPreElement> &
7
7
  LangtagProps & {
8
8
  /**
9
- * Specify the text to highlight.
9
+ * Code to highlight.
10
10
  */
11
11
  code: any;
12
12
 
13
13
  /**
14
- * Specify a subset of language names to restrict language auto-detection to.
14
+ * Languages to consider for auto-detection.
15
15
  * This can improve performance and accuracy.
16
16
  * @example ["javascript", "typescript"]
17
17
  */