@slidev/types 0.30.0 → 0.30.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +28 -9
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -14,37 +14,41 @@ interface SlidevConfig {
14
14
  * String template to compose title
15
15
  *
16
16
  * @example "%s - Slidev" - to suffix " - Slidev" to all pages
17
- * @defult '%s'
17
+ * @default '%s - Slidev'
18
18
  */
19
19
  titleTemplate: string;
20
20
  /**
21
+ * Theme to use for the slides
22
+ *
21
23
  * @see https://sli.dev/themes/use.html
22
- * @defult 'default'
24
+ * @default 'default'
23
25
  */
24
26
  theme: string;
25
27
  /**
26
- * @defult true
28
+ * Download remote assets in local using vite-plugin-remote-assets
29
+ *
30
+ * @default true
27
31
  */
28
32
  remoteAssets: boolean | 'dev' | 'build';
29
33
  /**
30
34
  * Enable Monaco
31
35
  *
32
36
  * @see https://sli.dev/custom/config-monaco.html
33
- * @defult 'dev'
37
+ * @default 'dev'
34
38
  */
35
39
  monaco: boolean | 'dev' | 'build';
36
40
  /**
37
41
  * Show a download button in the SPA build,
38
42
  * could also be a link to custom pdf
39
43
  *
40
- * @default true
44
+ * @default false
41
45
  */
42
46
  download: boolean | string;
43
47
  /**
44
48
  * Information shows on the built SPA
45
49
  * Can be a markdown string
46
50
  *
47
- * @default true
51
+ * @default false
48
52
  */
49
53
  info: string | boolean;
50
54
  /**
@@ -69,7 +73,7 @@ interface SlidevConfig {
69
73
  /**
70
74
  * Router mode for vue-router
71
75
  *
72
- * @default 'hash'
76
+ * @default 'history'
73
77
  */
74
78
  routerMode: 'hash' | 'history';
75
79
  /**
@@ -86,10 +90,17 @@ interface SlidevConfig {
86
90
  * @default '980'
87
91
  */
88
92
  canvasWidth: number;
93
+ /**
94
+ * Force the filename used when exporting the presentation.
95
+ * The extension, e.g. .pdf, gets automatically added.
96
+ *
97
+ * @default ''
98
+ */
99
+ exportFilename: string | null;
89
100
  /**
90
101
  * Controls whether texts in slides are selectable
91
102
  *
92
- * @default false
103
+ * @default true
93
104
  */
94
105
  selectable: boolean;
95
106
  /**
@@ -116,6 +127,8 @@ interface SlidevConfig {
116
127
  favicon: string;
117
128
  /**
118
129
  * Options for drawings
130
+ *
131
+ * @default {}
119
132
  */
120
133
  drawings: ResolvedDrawingsOptions;
121
134
  /**
@@ -124,6 +137,12 @@ interface SlidevConfig {
124
137
  * @default https://www.plantuml.com/plantuml
125
138
  */
126
139
  plantUmlServer: string;
140
+ /**
141
+ * Enable slides recording
142
+ *
143
+ * @default 'dev'
144
+ */
145
+ record: boolean | 'dev' | 'build';
127
146
  }
128
147
  interface FontOptions {
129
148
  /**
@@ -182,7 +201,7 @@ interface DrawingsOptions {
182
201
  */
183
202
  persist?: boolean | string;
184
203
  /**
185
- * @defult true
204
+ * @default true
186
205
  */
187
206
  enabled?: boolean | 'dev' | 'build';
188
207
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@slidev/types",
3
- "version": "0.30.0",
3
+ "version": "0.30.3",
4
4
  "description": "Shared types declerations for Slidev",
5
5
  "homepage": "https://sli.dev",
6
6
  "bugs": "https://github.com/slidevjs/slidev/issues",