Skip to content
This repository was archived by the owner on Apr 21, 2025. It is now read-only.

Commit d0b71d6

Browse files
committed
docs: Updated API
1 parent d924166 commit d0b71d6

File tree

101 files changed

+25868
-22945
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

101 files changed

+25868
-22945
lines changed

docs/assets/icons.js

Lines changed: 17 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/icons.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/assets/main.js

Lines changed: 212 additions & 197 deletions
Large diffs are not rendered by default.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/style.css

Lines changed: 69 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
--light-color-text: #222;
1111
--light-color-text-aside: #6e6e6e;
1212
--light-color-link: #1f70c2;
13+
--light-color-focus-outline: #3584e4;
1314

1415
--light-color-ts-keyword: #056bd6;
1516
--light-color-ts-project: #b111c9;
@@ -35,6 +36,7 @@
3536
--light-color-ts-set-signature: var(--light-color-ts-accessor);
3637
--light-color-ts-type-alias: #d51270;
3738
/* reference not included as links will be colored with the kind that it points to */
39+
--light-color-document: #000000;
3840

3941
--light-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23000' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
4042
--light-color-scheme: light;
@@ -50,6 +52,7 @@
5052
--dark-color-text: #f5f5f5;
5153
--dark-color-text-aside: #dddddd;
5254
--dark-color-link: #00aff4;
55+
--dark-color-focus-outline: #4c97f2;
5356

5457
--dark-color-ts-keyword: #3399ff;
5558
--dark-color-ts-project: #e358ff;
@@ -75,6 +78,7 @@
7578
--dark-color-ts-set-signature: var(--dark-color-ts-accessor);
7679
--dark-color-ts-type-alias: #ff6492;
7780
/* reference not included as links will be colored with the kind that it points to */
81+
--dark-color-document: #ffffff;
7882

7983
--dark-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23fff' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
8084
--dark-color-scheme: dark;
@@ -92,6 +96,7 @@
9296
--color-text: var(--light-color-text);
9397
--color-text-aside: var(--light-color-text-aside);
9498
--color-link: var(--light-color-link);
99+
--color-focus-outline: var(--light-color-focus-outline);
95100

96101
--color-ts-keyword: var(--light-color-ts-keyword);
97102
--color-ts-module: var(--light-color-ts-module);
@@ -114,6 +119,7 @@
114119
--color-ts-get-signature: var(--light-color-ts-get-signature);
115120
--color-ts-set-signature: var(--light-color-ts-set-signature);
116121
--color-ts-type-alias: var(--light-color-ts-type-alias);
122+
--color-document: var(--light-color-document);
117123

118124
--external-icon: var(--light-external-icon);
119125
--color-scheme: var(--light-color-scheme);
@@ -132,6 +138,7 @@
132138
--color-text: var(--dark-color-text);
133139
--color-text-aside: var(--dark-color-text-aside);
134140
--color-link: var(--dark-color-link);
141+
--color-focus-outline: var(--dark-color-focus-outline);
135142

136143
--color-ts-keyword: var(--dark-color-ts-keyword);
137144
--color-ts-module: var(--dark-color-ts-module);
@@ -154,6 +161,7 @@
154161
--color-ts-get-signature: var(--dark-color-ts-get-signature);
155162
--color-ts-set-signature: var(--dark-color-ts-set-signature);
156163
--color-ts-type-alias: var(--dark-color-ts-type-alias);
164+
--color-document: var(--dark-color-document);
157165

158166
--external-icon: var(--dark-external-icon);
159167
--color-scheme: var(--dark-color-scheme);
@@ -179,6 +187,7 @@ body {
179187
--color-text: var(--light-color-text);
180188
--color-text-aside: var(--light-color-text-aside);
181189
--color-link: var(--light-color-link);
190+
--color-focus-outline: var(--light-color-focus-outline);
182191

183192
--color-ts-keyword: var(--light-color-ts-keyword);
184193
--color-ts-module: var(--light-color-ts-module);
@@ -201,6 +210,7 @@ body {
201210
--color-ts-get-signature: var(--light-color-ts-get-signature);
202211
--color-ts-set-signature: var(--light-color-ts-set-signature);
203212
--color-ts-type-alias: var(--light-color-ts-type-alias);
213+
--color-document: var(--light-color-document);
204214

205215
--external-icon: var(--light-external-icon);
206216
--color-scheme: var(--light-color-scheme);
@@ -217,6 +227,7 @@ body {
217227
--color-text: var(--dark-color-text);
218228
--color-text-aside: var(--dark-color-text-aside);
219229
--color-link: var(--dark-color-link);
230+
--color-focus-outline: var(--dark-color-focus-outline);
220231

221232
--color-ts-keyword: var(--dark-color-ts-keyword);
222233
--color-ts-module: var(--dark-color-ts-module);
@@ -239,11 +250,17 @@ body {
239250
--color-ts-get-signature: var(--dark-color-ts-get-signature);
240251
--color-ts-set-signature: var(--dark-color-ts-set-signature);
241252
--color-ts-type-alias: var(--dark-color-ts-type-alias);
253+
--color-document: var(--dark-color-document);
242254

243255
--external-icon: var(--dark-external-icon);
244256
--color-scheme: var(--dark-color-scheme);
245257
}
246258

259+
*:focus-visible,
260+
.tsd-accordion-summary:focus-visible svg {
261+
outline: 2px solid var(--color-focus-outline);
262+
}
263+
247264
.always-visible,
248265
.always-visible .tsd-signatures {
249266
display: inherit !important;
@@ -258,16 +275,6 @@ h6 {
258275
line-height: 1.2;
259276
}
260277

261-
h1 > a:not(.link),
262-
h2 > a:not(.link),
263-
h3 > a:not(.link),
264-
h4 > a:not(.link),
265-
h5 > a:not(.link),
266-
h6 > a:not(.link) {
267-
text-decoration: none;
268-
color: var(--color-text);
269-
}
270-
271278
h1 {
272279
font-size: 1.875rem;
273280
margin: 0.67rem 0;
@@ -298,10 +305,6 @@ h6 {
298305
margin: 2.33rem 0;
299306
}
300307

301-
.uppercase {
302-
text-transform: uppercase;
303-
}
304-
305308
dl,
306309
menu,
307310
ol,
@@ -319,17 +322,14 @@ dd {
319322
}
320323

321324
/* Footer */
322-
.tsd-generator {
325+
footer {
323326
border-top: 1px solid var(--color-accent);
324327
padding-top: 1rem;
325328
padding-bottom: 1rem;
326329
max-height: 3.5rem;
327330
}
328-
329-
.tsd-generator > p {
330-
margin-top: 0;
331-
margin-bottom: 0;
332-
padding: 0 1rem;
331+
footer > p {
332+
margin: 0 1em;
333333
}
334334

335335
.container-main {
@@ -416,6 +416,9 @@ a.external[target='_blank'] {
416416
background-repeat: no-repeat;
417417
padding-right: 13px;
418418
}
419+
a.tsd-anchor-link {
420+
color: var(--color-text);
421+
}
419422

420423
code,
421424
pre {
@@ -575,13 +578,13 @@ dl.tsd-comment-tag-group p {
575578
}
576579
.tsd-filter-input {
577580
display: flex;
578-
width: fit-content;
579581
width: -moz-fit-content;
582+
width: fit-content;
580583
align-items: center;
581-
user-select: none;
582584
-webkit-user-select: none;
583585
-moz-user-select: none;
584586
-ms-user-select: none;
587+
user-select: none;
585588
cursor: pointer;
586589
}
587590
.tsd-filter-input input[type='checkbox'] {
@@ -604,11 +607,8 @@ dl.tsd-comment-tag-group p {
604607
Don't remove unless you know what you're doing. */
605608
opacity: 0.99;
606609
}
607-
.tsd-filter-input input[type='checkbox']:focus + svg {
608-
transform: scale(0.95);
609-
}
610-
.tsd-filter-input input[type='checkbox']:focus:not(:focus-visible) + svg {
611-
transform: scale(1);
610+
.tsd-filter-input input[type='checkbox']:focus-visible + svg {
611+
outline: 2px solid var(--color-focus-outline);
612612
}
613613
.tsd-checkbox-background {
614614
fill: var(--color-accent);
@@ -625,13 +625,18 @@ input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark {
625625
stroke: var(--color-accent);
626626
}
627627

628-
.tsd-theme-toggle {
629-
padding-top: 0.75rem;
628+
.settings-label {
629+
font-weight: bold;
630+
text-transform: uppercase;
631+
display: inline-block;
630632
}
631-
.tsd-theme-toggle > h4 {
632-
display: inline;
633-
vertical-align: middle;
634-
margin-right: 0.75rem;
633+
634+
.tsd-filter-visibility .settings-label {
635+
margin: 0.75rem 0 0.5rem 0;
636+
}
637+
638+
.tsd-theme-toggle .settings-label {
639+
margin: 0.75rem 0.75rem 0 0;
635640
}
636641

637642
.tsd-hierarchy {
@@ -764,6 +769,9 @@ input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark {
764769
padding: 0;
765770
max-width: 100%;
766771
}
772+
.tsd-navigation .tsd-nav-link {
773+
display: none;
774+
}
767775
.tsd-nested-navigation {
768776
margin-left: 3rem;
769777
}
@@ -777,6 +785,15 @@ input[type='checkbox']:checked ~ svg .tsd-checkbox-checkmark {
777785
margin-left: -1.5rem;
778786
}
779787

788+
.tsd-page-navigation-section {
789+
margin-left: 10px;
790+
}
791+
.tsd-page-navigation-section > summary {
792+
padding: 0.25rem;
793+
}
794+
.tsd-page-navigation-section > div {
795+
margin-left: 20px;
796+
}
780797
.tsd-page-navigation ul {
781798
padding-left: 1.75rem;
782799
}
@@ -807,10 +824,10 @@ a.tsd-index-link {
807824
}
808825
.tsd-accordion-summary,
809826
.tsd-accordion-summary a {
810-
user-select: none;
811827
-moz-user-select: none;
812828
-webkit-user-select: none;
813829
-ms-user-select: none;
830+
user-select: none;
814831

815832
cursor: pointer;
816833
}
@@ -823,8 +840,9 @@ a.tsd-index-link {
823840
padding-top: 0;
824841
padding-bottom: 0;
825842
}
826-
.tsd-index-accordion .tsd-accordion-summary > svg {
843+
.tsd-accordion .tsd-accordion-summary > svg {
827844
margin-left: 0.25rem;
845+
vertical-align: text-top;
828846
}
829847
.tsd-index-content > :not(:first-child) {
830848
margin-top: 0.75rem;
@@ -872,14 +890,17 @@ a.tsd-index-link {
872890
}
873891

874892
.tsd-panel-group {
875-
margin: 4rem 0;
893+
margin: 2rem 0;
876894
}
877895
.tsd-panel-group.tsd-index-group {
878896
margin: 2rem 0;
879897
}
880898
.tsd-panel-group.tsd-index-group details {
881899
margin: 2rem 0;
882900
}
901+
.tsd-panel-group > .tsd-accordion-summary {
902+
margin-bottom: 1rem;
903+
}
883904

884905
#tsd-search {
885906
transition: background-color 0.2s;
@@ -1029,6 +1050,12 @@ a.tsd-index-link {
10291050
border-width: 1px 0;
10301051
transition: background-color 0.1s;
10311052
}
1053+
.tsd-signatures .tsd-index-signature:not(:last-child) {
1054+
margin-bottom: 1em;
1055+
}
1056+
.tsd-signatures .tsd-index-signature .tsd-signature {
1057+
border-width: 1px;
1058+
}
10321059
.tsd-description .tsd-signatures .tsd-signature {
10331060
border-width: 1px;
10341061
}
@@ -1342,6 +1369,12 @@ img {
13421369
.has-menu .tsd-navigation {
13431370
max-height: 100%;
13441371
}
1372+
#tsd-toolbar-links {
1373+
display: none;
1374+
}
1375+
.tsd-navigation .tsd-nav-link {
1376+
display: flex;
1377+
}
13451378
}
13461379

13471380
/* one sidebar */

0 commit comments

Comments
 (0)