Skip to content

Commit 5e38a6a

Browse files
SSShooterSSShooter
committed
docs: add type to Theme
1 parent 706469b commit 5e38a6a

File tree

6 files changed

+99
-128
lines changed

6 files changed

+99
-128
lines changed

‎api/mind-elixir.api.json‎

Lines changed: 50 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"metadata": {
33
"toolPackage": "@microsoft/api-extractor",
4-
"toolVersion": "7.47.0",
4+
"toolVersion": "7.47.11",
55
"schemaVersion": 1011,
66
"oldestForwardsCompatibleVersion": 1001,
77
"tsdocConfig": {
@@ -728,7 +728,7 @@
728728
},
729729
{
730730
"kind": "Content",
731-
"text": "'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es'"
731+
"text": "'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es' | 'fr' | 'ko'"
732732
},
733733
{
734734
"kind": "Content",
@@ -3062,33 +3062,6 @@
30623062
"endIndex": 2
30633063
}
30643064
},
3065-
{
3066-
"kind": "PropertySignature",
3067-
"canonicalReference": "mind-elixir!MindElixirInstance#mobileMenu:member",
3068-
"docComment": "",
3069-
"excerptTokens": [
3070-
{
3071-
"kind": "Content",
3072-
"text": "mobileMenu: "
3073-
},
3074-
{
3075-
"kind": "Content",
3076-
"text": "boolean"
3077-
},
3078-
{
3079-
"kind": "Content",
3080-
"text": ";"
3081-
}
3082-
],
3083-
"isReadonly": false,
3084-
"isOptional": false,
3085-
"releaseTag": "Public",
3086-
"name": "mobileMenu",
3087-
"propertyTypeTokenRange": {
3088-
"startIndex": 1,
3089-
"endIndex": 2
3090-
}
3091-
},
30923065
{
30933066
"kind": "PropertySignature",
30943067
"canonicalReference": "mind-elixir!MindElixirInstance#mouseSelectionButton:member",
@@ -3420,6 +3393,38 @@
34203393
"endIndex": 2
34213394
}
34223395
},
3396+
{
3397+
"kind": "PropertySignature",
3398+
"canonicalReference": "mind-elixir!MindElixirInstance#selectionContainer:member",
3399+
"docComment": "",
3400+
"excerptTokens": [
3401+
{
3402+
"kind": "Content",
3403+
"text": "selectionContainer?: "
3404+
},
3405+
{
3406+
"kind": "Content",
3407+
"text": "string | "
3408+
},
3409+
{
3410+
"kind": "Reference",
3411+
"text": "HTMLElement",
3412+
"canonicalReference": "!HTMLElement:interface"
3413+
},
3414+
{
3415+
"kind": "Content",
3416+
"text": ";"
3417+
}
3418+
],
3419+
"isReadonly": false,
3420+
"isOptional": true,
3421+
"releaseTag": "Public",
3422+
"name": "selectionContainer",
3423+
"propertyTypeTokenRange": {
3424+
"startIndex": 1,
3425+
"endIndex": 3
3426+
}
3427+
},
34233428
{
34243429
"kind": "PropertySignature",
34253430
"canonicalReference": "mind-elixir!MindElixirInstance#subBranchStyle:member",
@@ -3744,7 +3749,7 @@
37443749
},
37453750
{
37463751
"kind": "Content",
3747-
"text": "[];\n tags?: string[];\n icons?: string[];\n hyperLink?: string;\n expanded?: boolean;\n direction?: number;\n root?: boolean;\n image?: {\n url: string;\n width: number;\n height: number;\n };\n branchColor?: string;\n parent?: "
3752+
"text": "[];\n tags?: string[];\n icons?: string[];\n hyperLink?: string;\n expanded?: boolean;\n direction?: number;\n image?: {\n url: string;\n width: number;\n height: number;\n };\n branchColor?: string;\n parent?: "
37483753
},
37493754
{
37503755
"kind": "Reference",
@@ -3900,7 +3905,7 @@
39003905
},
39013906
{
39023907
"kind": "Content",
3903-
"text": ";\n mobileMenu?: boolean;\n theme?: "
3908+
"text": ";\n theme?: "
39043909
},
39053910
{
39063911
"kind": "Reference",
@@ -3909,7 +3914,16 @@
39093914
},
39103915
{
39113916
"kind": "Content",
3912-
"text": ";\n nodeMenu?: boolean;\n}"
3917+
"text": ";\n nodeMenu?: boolean;\n selectionContainer?: string | "
3918+
},
3919+
{
3920+
"kind": "Reference",
3921+
"text": "HTMLElement",
3922+
"canonicalReference": "!HTMLElement:interface"
3923+
},
3924+
{
3925+
"kind": "Content",
3926+
"text": ";\n}"
39133927
},
39143928
{
39153929
"kind": "Content",
@@ -3921,7 +3935,7 @@
39213935
"name": "Options",
39223936
"typeTokenRange": {
39233937
"startIndex": 1,
3924-
"endIndex": 22
3938+
"endIndex": 24
39253939
}
39263940
},
39273941
{
@@ -4259,15 +4273,15 @@
42594273
{
42604274
"kind": "TypeAlias",
42614275
"canonicalReference": "mind-elixir!Theme:type",
4262-
"docComment": "",
4276+
"docComment": "/**\n * MindElixir Theme\n *\n * @public\n */\n",
42634277
"excerptTokens": [
42644278
{
42654279
"kind": "Content",
42664280
"text": "export type Theme = "
42674281
},
42684282
{
42694283
"kind": "Content",
4270-
"text": "{\n name: string;\n palette: string[];\n cssVar: "
4284+
"text": "{\n name: string;\n type?: 'light' | 'dark';\n palette: string[];\n cssVar: "
42714285
},
42724286
{
42734287
"kind": "Reference",
@@ -4276,7 +4290,7 @@
42764290
},
42774291
{
42784292
"kind": "Content",
4279-
"text": "<{\n '--main-color': string;\n '--main-bgcolor': string;\n '--color': string;\n '--bgcolor': string;\n '--selected': string;\n '--panel-color': string;\n '--panel-bgcolor': string;\n '--root-color': string;\n '--root-bgcolor': string;\n '--root-radius': string;\n '--main-radius': string;\n '--topic-padding': string;\n '--panel-border-color': string;\n }>;\n}"
4293+
"text": "<{\n '--gap': string;\n '--main-color': string;\n '--main-bgcolor': string;\n '--color': string;\n '--bgcolor': string;\n '--selected': string;\n '--root-color': string;\n '--root-bgcolor': string;\n '--root-border-color': string;\n '--root-radius': string;\n '--main-radius': string;\n '--topic-padding': string;\n '--panel-color': string;\n '--panel-bgcolor': string;\n '--panel-border-color': string;\n }>;\n}"
42804294
},
42814295
{
42824296
"kind": "Content",

‎api/mind-elixir.api.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export interface Expander extends HTMLElement {
6363
}
6464

6565
// @public (undocumented)
66-
export type Locale = 'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es';
66+
export type Locale = 'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es' | 'fr' | 'ko';
6767

6868
// @public (undocumented)
6969
export type MainLineParams = {
@@ -240,8 +240,6 @@ export interface MindElixirInstance extends MindElixirMethods {
240240
// (undocumented)
241241
mindElixirBox: HTMLElement;
242242
// (undocumented)
243-
mobileMenu: boolean;
244-
// (undocumented)
245243
mouseSelectionButton: 0 | 2;
246244
// (undocumented)
247245
newTopicName: string;
@@ -266,6 +264,8 @@ export interface MindElixirInstance extends MindElixirMethods {
266264
// (undocumented)
267265
selection: SelectionArea;
268266
// (undocumented)
267+
selectionContainer?: string | HTMLElement;
268+
// (undocumented)
269269
subBranchStyle: number;
270270
// (undocumented)
271271
summaries: Summary[];
@@ -304,7 +304,6 @@ export type NodeObj = {
304304
hyperLink?: string;
305305
expanded?: boolean;
306306
direction?: number;
307-
root?: boolean;
308307
image?: {
309308
url: string;
310309
width: number;
@@ -336,9 +335,9 @@ export type Options = {
336335
overflowHidden?: boolean;
337336
generateMainBranch?: (this: MindElixirInstance, params: MainLineParams) => PathString;
338337
generateSubBranch?: (this: MindElixirInstance, params: SubLineParams) => PathString;
339-
mobileMenu?: boolean;
340338
theme?: Theme;
341339
nodeMenu?: boolean;
340+
selectionContainer?: string | HTMLElement;
342341
};
343342

344343
// @public (undocumented)
@@ -386,23 +385,26 @@ export type SummarySvgGroup = SVGGElement & {
386385
summaryObj: Summary;
387386
};
388387

389-
// @public (undocumented)
388+
// @public
390389
export type Theme = {
391390
name: string;
391+
type?: 'light' | 'dark';
392392
palette: string[];
393393
cssVar: Partial<{
394+
'--gap': string;
394395
'--main-color': string;
395396
'--main-bgcolor': string;
396397
'--color': string;
397398
'--bgcolor': string;
398399
'--selected': string;
399-
'--panel-color': string;
400-
'--panel-bgcolor': string;
401400
'--root-color': string;
402401
'--root-bgcolor': string;
402+
'--root-border-color': string;
403403
'--root-radius': string;
404404
'--main-radius': string;
405405
'--topic-padding': string;
406+
'--panel-color': string;
407+
'--panel-bgcolor': string;
406408
'--panel-border-color': string;
407409
}>;
408410
};

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@
7070
"devDependencies": {
7171
"@commitlint/cli": "^17.8.1",
7272
"@commitlint/config-conventional": "^17.8.1",
73-
"@microsoft/api-documenter": "^7.25.14",
74-
"@microsoft/api-extractor": "^7.47.0",
73+
"@microsoft/api-documenter": "^7.25.21",
74+
"@microsoft/api-extractor": "^7.47.11",
7575
"@playwright/test": "^1.44.1",
7676
"@rollup/plugin-strip": "^3.0.4",
7777
"@types/node": "^20.14.2",

0 commit comments

Comments
 (0)