generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 220
Expand file tree
/
Copy pathdocumenter.test.ts.snap
More file actions
19197 lines (18903 loc) · 670 KB
/
documenter.test.ts.snap
File metadata and controls
19197 lines (18903 loc) · 670 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Documenter definition for alert matches the snapshot: alert 1`] = `
{
"events": [
{
"cancelable": false,
"description": "Fired when the user clicks the action button.
**Deprecated** Replaced by \`action\`.",
"name": "onButtonClick",
},
{
"cancelable": false,
"description": "Fired when the user clicks the close icon that is displayed
when the \`dismissible\` property is set to \`true\`.",
"name": "onDismiss",
},
],
"functions": [
{
"description": "Sets focus on the alert content.",
"name": "focus",
"parameters": [],
"returnType": "void",
},
],
"name": "Alert",
"properties": [
{
"deprecatedTag": "Custom CSS is not supported. For testing and other use cases, use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes).",
"description": "Adds the specified classes to the root element of the component.",
"name": "className",
"optional": true,
"type": "string",
},
{
"deprecatedTag": "Use \`i18nStrings.dismissAriaLabel\` instead.
If the label is assigned via the \`i18nStrings\` property, this label will be ignored.",
"description": "Adds an aria-label to the dismiss button.",
"i18nTag": true,
"name": "dismissAriaLabel",
"optional": true,
"type": "string",
},
{
"description": "Adds a close button to the alert when set to \`true\`.
An \`onDismiss\` event is fired when a user clicks the button.",
"name": "dismissible",
"optional": true,
"type": "boolean",
},
{
"description": "An object containing all the necessary localized strings required by the component.",
"i18nTag": true,
"inlineType": {
"name": "AlertProps.I18nStrings",
"properties": [
{
"name": "dismissAriaLabel",
"optional": true,
"type": "string",
},
{
"name": "errorIconAriaLabel",
"optional": true,
"type": "string",
},
{
"name": "infoIconAriaLabel",
"optional": true,
"type": "string",
},
{
"name": "successIconAriaLabel",
"optional": true,
"type": "string",
},
{
"name": "warningIconAriaLabel",
"optional": true,
"type": "string",
},
],
"type": "object",
},
"name": "i18nStrings",
"optional": true,
"type": "AlertProps.I18nStrings",
},
{
"deprecatedTag": "The usage of the \`id\` attribute is reserved for internal use cases. For testing and other use cases,
use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes). If you must
use the \`id\` attribute, consider setting it on a parent element instead.",
"description": "Adds the specified ID to the root element of the component.",
"name": "id",
"optional": true,
"type": "string",
},
{
"deprecatedTag": "Use the label properties inside \`i18nStrings\` instead.
If the label is assigned via the \`i18nStrings\` property, this label will be ignored.",
"description": "Provides a text alternative for the icon.",
"name": "statusIconAriaLabel",
"optional": true,
"type": "string",
},
{
"defaultValue": "'info'",
"description": "Specifies the type of message you want to display.",
"inlineType": {
"name": "AlertProps.Type",
"type": "union",
"values": [
"success",
"error",
"warning",
"info",
],
},
"name": "type",
"optional": true,
"type": "string",
},
{
"defaultValue": "true",
"deprecatedTag": "Use conditional rendering in your code instead of this prop.",
"description": "Determines whether the alert is displayed.",
"name": "visible",
"optional": true,
"type": "boolean",
},
],
"regions": [
{
"description": "Specifies an action for the alert message.
Although it is technically possible to insert any content, our UX guidelines only allow you to add a button.",
"isDefault": false,
"name": "action",
},
{
"deprecatedTag": "Replaced by \`action\`.",
"description": "Displays an action button next to the message area when set.
An \`onButtonClick\` event is fired when the user clicks it.",
"isDefault": false,
"name": "buttonText",
},
{
"description": "Primary text displayed in the element.",
"isDefault": true,
"name": "children",
},
{
"description": "Heading text.",
"isDefault": false,
"name": "header",
},
],
"releaseStatus": "stable",
}
`;
exports[`Documenter definition for anchor-navigation matches the snapshot: anchor-navigation 1`] = `
{
"events": [
{
"cancelable": false,
"description": "Fired when an active anchor link changes.
Note: This event is triggered both by the component's internal scroll-spy logic,
or when the \`activeHref\` prop is manually updated.
",
"detailInlineType": {
"name": "AnchorNavigationProps.Anchor",
"properties": [
{
"name": "href",
"optional": false,
"type": "string",
},
{
"name": "info",
"optional": true,
"type": "string",
},
{
"name": "level",
"optional": false,
"type": "number",
},
{
"name": "text",
"optional": false,
"type": "string",
},
],
"type": "object",
},
"detailType": "AnchorNavigationProps.Anchor",
"name": "onActiveHrefChange",
},
{
"cancelable": true,
"description": "Fired when an anchor link is clicked without any modifier keys.",
"detailInlineType": {
"name": "AnchorNavigationProps.Anchor",
"properties": [
{
"name": "href",
"optional": false,
"type": "string",
},
{
"name": "info",
"optional": true,
"type": "string",
},
{
"name": "level",
"optional": false,
"type": "number",
},
{
"name": "text",
"optional": false,
"type": "string",
},
],
"type": "object",
},
"detailType": "AnchorNavigationProps.Anchor",
"name": "onFollow",
},
],
"functions": [],
"name": "AnchorNavigation",
"properties": [
{
"description": "Specifies the active anchor href. When set, the component will operate in a
controlled manner, and internal scroll-spy will be disabled.",
"name": "activeHref",
"optional": true,
"type": "string",
},
{
"description": "List of anchors. Each anchor object has the following properties:
* \`text\` (string) - The text for the anchor item.
* \`href\` (string) - The \`id\` attribute of the target HTML element that the anchor refers to.
For example: \`"#section1.1"\`
* \`level\` (number) - Level of nesting of the anchor.
* \`info\` (string | undefined) - Additional information to display next to the link, for example: "New" or "Updated".
Note: The list of anchors should be sorted in the order they appear on the page.
",
"name": "anchors",
"optional": false,
"type": "Array<AnchorNavigationProps.Anchor>",
},
{
"description": "Adds \`aria-labelledby\` to the component.
Use this property for identifying the header or title that labels the anchor navigation.
To use it correctly, define an ID for the element either as label, and set the property to that ID.
",
"name": "ariaLabelledby",
"optional": true,
"type": "string",
},
{
"deprecatedTag": "Custom CSS is not supported. For testing and other use cases, use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes).",
"description": "Adds the specified classes to the root element of the component.",
"name": "className",
"optional": true,
"type": "string",
},
{
"deprecatedTag": "The usage of the \`id\` attribute is reserved for internal use cases. For testing and other use cases,
use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes). If you must
use the \`id\` attribute, consider setting it on a parent element instead.",
"description": "Adds the specified ID to the root element of the component.",
"name": "id",
"optional": true,
"type": "string",
},
{
"defaultValue": "0",
"description": "Specifies the height (in pixels) to be considered as an offset when activating anchors.
This is useful when you have a fixed or sticky header that might overlap with the content as you scroll.
Defaults to 0.
",
"name": "scrollSpyOffset",
"optional": true,
"type": "number",
},
],
"regions": [],
"releaseStatus": "stable",
}
`;
exports[`Documenter definition for annotation-context matches the snapshot: annotation-context 1`] = `
{
"events": [
{
"cancelable": false,
"description": "Fired when the user exits the current tutorial.",
"detailInlineType": {
"name": "TutorialPanelProps.TutorialDetail",
"properties": [
{
"name": "tutorial",
"optional": false,
"type": "TutorialPanelProps.Tutorial",
},
],
"type": "object",
},
"detailType": "TutorialPanelProps.TutorialDetail",
"name": "onExitTutorial",
},
{
"cancelable": false,
"description": "Fired when the user clicks the "Finish" button on the last step of
the tutorial.",
"detailType": "void",
"name": "onFinish",
},
{
"cancelable": false,
"description": "Fired when the user selects a tutorial from the list.",
"detailInlineType": {
"name": "TutorialPanelProps.TutorialDetail",
"properties": [
{
"name": "tutorial",
"optional": false,
"type": "TutorialPanelProps.Tutorial",
},
],
"type": "object",
},
"detailType": "TutorialPanelProps.TutorialDetail",
"name": "onStartTutorial",
},
{
"cancelable": false,
"description": "This event is fired when a user clicks the "Next" or "Previous"
button on a popover, when the user clicks on a closed hotspot icon,
or when the AnnotationOverlay determines that the current hotspot
has disappeared from the page and a different one should be
selected (e.g. when navigating between pages).
Use the \`reason\` property of the event detail to determine why
this event was fired.
",
"detailInlineType": {
"name": "AnnotationContextProps.StepChangeDetail",
"properties": [
{
"name": "reason",
"optional": false,
"type": ""auto-fallback" | "next" | "open" | "previous"",
},
{
"name": "step",
"optional": false,
"type": "number",
},
],
"type": "object",
},
"detailType": "AnnotationContextProps.StepChangeDetail",
"name": "onStepChange",
},
],
"functions": [],
"name": "AnnotationContext",
"properties": [
{
"description": "The currently launched tutorial. This should be the object received
in the \`detail\` property of the \`onStartTutorial\` event.",
"name": "currentTutorial",
"optional": false,
"type": "AnnotationContextProps.Tutorial | null",
},
{
"description": "An object containing all the necessary localized strings required by
the component.",
"inlineType": {
"name": "AnnotationContextProps.I18nStrings",
"properties": [
{
"name": "finishButtonText",
"optional": false,
"type": "string",
},
{
"name": "labelDismissAnnotation",
"optional": false,
"type": "string",
},
{
"name": "labelHotspot",
"optional": false,
"type": "(openState: boolean, stepIndex: number, totalStepCount: number) => string",
},
{
"name": "nextButtonText",
"optional": false,
"type": "string",
},
{
"name": "previousButtonText",
"optional": false,
"type": "string",
},
{
"name": "stepCounterText",
"optional": false,
"type": "(stepIndex: number, totalStepCount: number) => string",
},
{
"name": "taskTitle",
"optional": false,
"type": "(taskIndex: number, taskTitle: string) => string",
},
],
"type": "object",
},
"name": "i18nStrings",
"optional": false,
"type": "AnnotationContextProps.I18nStrings",
},
],
"regions": [
{
"description": "Put all page content inside this component's children. This component
will provide a context which is used by the Hotspot elements throughout
the page.",
"isDefault": true,
"name": "children",
},
],
"releaseStatus": "stable",
}
`;
exports[`Documenter definition for app-layout matches the snapshot: app-layout 1`] = `
{
"events": [
{
"cancelable": false,
"description": "Fired when the active drawer is toggled.",
"detailInlineType": {
"name": "AppLayoutProps.DrawerChangeDetail",
"properties": [
{
"name": "activeDrawerId",
"optional": false,
"type": "null | string",
},
],
"type": "object",
},
"detailType": "AppLayoutProps.DrawerChangeDetail",
"name": "onDrawerChange",
},
{
"cancelable": false,
"description": "Fired when the navigation drawer is toggled.",
"detailInlineType": {
"name": "AppLayoutProps.ChangeDetail",
"properties": [
{
"name": "open",
"optional": false,
"type": "boolean",
},
],
"type": "object",
},
"detailType": "AppLayoutProps.ChangeDetail",
"name": "onNavigationChange",
},
{
"cancelable": false,
"description": "Fired when the split panel preferences change.",
"detailInlineType": {
"name": "AppLayoutProps.SplitPanelPreferences",
"properties": [
{
"name": "position",
"optional": false,
"type": ""bottom" | "side"",
},
],
"type": "object",
},
"detailType": "AppLayoutProps.SplitPanelPreferences",
"name": "onSplitPanelPreferencesChange",
},
{
"cancelable": false,
"description": "Fired when the split panel is resized.",
"detailInlineType": {
"name": "AppLayoutProps.SplitPanelResizeDetail",
"properties": [
{
"name": "size",
"optional": false,
"type": "number",
},
],
"type": "object",
},
"detailType": "AppLayoutProps.SplitPanelResizeDetail",
"name": "onSplitPanelResize",
},
{
"cancelable": false,
"description": "Fired when the split panel is toggled.",
"detailInlineType": {
"name": "AppLayoutProps.ChangeDetail",
"properties": [
{
"name": "open",
"optional": false,
"type": "boolean",
},
],
"type": "object",
},
"detailType": "AppLayoutProps.ChangeDetail",
"name": "onSplitPanelToggle",
},
{
"cancelable": false,
"description": "Fired when the tools drawer is toggled.",
"detailInlineType": {
"name": "AppLayoutProps.ChangeDetail",
"properties": [
{
"name": "open",
"optional": false,
"type": "boolean",
},
],
"type": "object",
},
"detailType": "AppLayoutProps.ChangeDetail",
"name": "onToolsChange",
},
],
"functions": [
{
"description": "Manually closes the navigation drawer if it is necessary for the current
viewport size.",
"name": "closeNavigationIfNecessary",
"parameters": [],
"returnType": "void",
},
{
"description": "Focuses the active drawer. Use this to focus the active drawer after opening it programmatically.",
"name": "focusActiveDrawer",
"parameters": [],
"returnType": "void",
},
{
"description": "Focuses the split panel if it is open.",
"name": "focusSplitPanel",
"parameters": [],
"returnType": "void",
},
{
"description": "Focuses the tools panel if it is open. Use this to focus the tools panel
after changing the content, for example when clicking on an 'info' link while
the panel is already open.",
"name": "focusToolsClose",
"parameters": [],
"returnType": "void",
},
{
"description": "Opens the tools panel if it is not already open. Note that it is preferable
to control the state by listening to \`toolsChange\` and providing \`toolsOpen\`.",
"name": "openTools",
"parameters": [],
"returnType": "void",
},
],
"name": "AppLayout",
"properties": [
{
"description": "The active drawer id. If you want to clear the active drawer, use \`null\`.",
"name": "activeDrawerId",
"optional": true,
"type": "null | string",
},
{
"analyticsTag": "",
"description": "Specifies additional analytics-related metadata.
* \`instanceIdentifier\` - A unique string that identifies this component instance in your application.
* \`flowType\` - Identifies the type of flow represented by the component.
**Note:** This API is currently experimental.",
"inlineType": {
"name": "AppLayoutProps.AnalyticsMetadata",
"properties": [
{
"name": "flowType",
"optional": true,
"type": "FlowType",
},
{
"name": "instanceIdentifier",
"optional": true,
"type": "string",
},
],
"type": "object",
},
"name": "analyticsMetadata",
"optional": true,
"type": "AppLayoutProps.AnalyticsMetadata",
},
{
"description": "Aria labels for the drawer operating buttons. Use this property to ensure accessibility.
* \`navigation\` (string) - Label for the landmark that wraps the navigation drawer.
* \`navigationClose\` (string) - Label for the button that closes the navigation drawer.
* \`navigationToggle\` (string) - Label for the button that opens the navigation drawer.
* \`notification\` (string) - Label for the region that contains notification messages.
* \`tools\` (string) - Label for the landmark that wraps the tools drawer.
* \`toolsClose\` (string) - Label for the button that closes the tools drawer.
* \`toolsToggle\` (string) - Label for the button that opens the tools drawer.
* \`drawers\` (string) - Label for the landmark that wraps the active drawer.
* \`drawersOverflow\` (string) - Label for the ellipsis button with any overflow drawers.
* \`drawersOverflowWithBadge\` (string) - Label for the ellipsis button with any overflow drawers, with a badge.
Example:
\`\`\`
{
navigation: "Navigation drawer",
navigationClose: "Close navigation drawer",
navigationToggle: "Open navigation drawer",
notifications: "Notifications",
tools: "Help panel",
toolsClose: "Close help panel",
toolsToggle: "Open help panel",
drawers: "Drawers",
drawersOverflow: "Overflow drawers",
drawersOverflowWithBadge: "Overflow drawers (Unread notifications)"
}
\`\`\`",
"i18nTag": true,
"inlineType": {
"name": "AppLayoutProps.Labels",
"properties": [
{
"name": "drawers",
"optional": true,
"type": "string",
},
{
"name": "drawersOverflow",
"optional": true,
"type": "string",
},
{
"name": "drawersOverflowWithBadge",
"optional": true,
"type": "string",
},
{
"name": "navigation",
"optional": true,
"type": "string",
},
{
"name": "navigationClose",
"optional": true,
"type": "string",
},
{
"name": "navigationToggle",
"optional": true,
"type": "string",
},
{
"name": "notifications",
"optional": true,
"type": "string",
},
{
"name": "tools",
"optional": true,
"type": "string",
},
{
"name": "toolsClose",
"optional": true,
"type": "string",
},
{
"name": "toolsToggle",
"optional": true,
"type": "string",
},
],
"type": "object",
},
"name": "ariaLabels",
"optional": true,
"type": "AppLayoutProps.Labels",
},
{
"deprecatedTag": "Custom CSS is not supported. For testing and other use cases, use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes).",
"description": "Adds the specified classes to the root element of the component.",
"name": "className",
"optional": true,
"type": "string",
},
{
"defaultValue": "'default'",
"description": "Determines the default behavior of the component based on some predefined page layouts.
Individual properties will always take precedence over the default coming from the content type.",
"inlineType": {
"name": "AppLayoutProps.ContentType",
"type": "union",
"values": [
"default",
"form",
"table",
"cards",
"wizard",
"dashboard",
],
},
"name": "contentType",
"optional": true,
"type": "string",
},
{
"deprecatedTag": "This layout is being phased out and may miss some features.",
"description": "Activates a backwards-compatibility mode for applications with non-fixed headers and footers.",
"name": "disableBodyScroll",
"optional": true,
"type": "boolean",
},
{
"deprecatedTag": "Replaced by the \`disableOverlap\` property of the [content layout](/components/content-layout/) component.",
"description": "Disables overlap between \`contentHeader\` and \`content\` slots.",
"name": "disableContentHeaderOverlap",
"optional": true,
"type": "boolean",
"visualRefreshTag": "",
},
{
"description": "If \`true\`, disables outer paddings for the content slot.",
"name": "disableContentPaddings",
"optional": true,
"type": "boolean",
},
{
"description": "Drawers property. If you set both \`drawers\` and \`tools\`, \`drawers\` will take precedence.
Each Drawer is an item in the drawers wrapper with the following properties:
* id (string) - the id of the drawer.
* content (React.ReactNode) - the content in the drawer.
* trigger (DrawerTrigger) - the button that opens and closes the active drawer.
* ariaLabels (DrawerAriaLabels) - the labels for the interactive elements of the drawer.
* badge (boolean) - Adds a badge to the corner of the icon to indicate a state change. For example: Unread notifications.
* resizable (boolean) - if the drawer is resizable or not.
* defaultSize (number) - starting size of the drawer. if not set, defaults to 290.
* onResize (({ size: number }) => void) - Fired when the active drawer is resized.
#### DrawerTrigger
- \`iconName\` (IconProps.Name) - (Optional) Specifies the icon to be displayed.
- \`iconSvg\` (React.ReactNode) - (Optional) Specifies the SVG of a custom icon. For more information, see [SVG icon guidelines](/components/icon/?tabId=api#slots)
#### DrawerAriaLabels
- \`drawerName\` (string) - Label for the drawer itself, and for the drawer trigger button tooltip text.
- \`closeButton\` (string) - (Optional) Label for the close button.
- \`triggerButton\` (string) - (Optional) Label for the trigger button.
- \`resizeHandle\` (string) - (Optional) Label for the resize handle.
",
"name": "drawers",
"optional": true,
"type": "Array<AppLayoutProps.Drawer>",
},
{
"defaultValue": "'#b #f'",
"description": "CSS selector for the application footer.",
"name": "footerSelector",
"optional": true,
"type": "string",
},
{
"defaultValue": "'#b #h'",
"description": "CSS selector for the application header.",
"name": "headerSelector",
"optional": true,
"type": "string",
},
{
"description": "Determines the visual treatment for the breadcrumbs and notifications slots. Specifically:
* \`default\` - Does not apply any visual treatment.
* \`high-contrast\` - Applies high-contrast to both slots. Use in conjunction with \`headerVariant="high-contrast"\` in ContentLayout.",
"inlineType": {
"name": "",
"type": "union",
"values": [
"default",
"high-contrast",
],
},
"name": "headerVariant",
"optional": true,
"type": "string",
"visualRefreshTag": "",
},
{
"deprecatedTag": "The usage of the \`id\` attribute is reserved for internal use cases. For testing and other use cases,
use [data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes). If you must
use the \`id\` attribute, consider setting it on a parent element instead.",
"description": "Adds the specified ID to the root element of the component.",
"name": "id",
"optional": true,
"type": "string",
},
{
"description": "Maximum main content panel width in pixels.
If set to \`Number.MAX_VALUE\`, the main content panel will occupy the full available width.
",
"name": "maxContentWidth",
"optional": true,
"type": "number",
},
{
"description": "Minimum main content panel width in pixels.",
"name": "minContentWidth",
"optional": true,
"type": "number",
},
{
"description": "If \`true\`, the navigation drawer is not displayed at all.",
"name": "navigationHide",
"optional": true,
"type": "boolean",
},
{
"description": "State of the navigation drawer.",
"name": "navigationOpen",
"optional": true,
"type": "boolean",
},
{
"defaultValue": "280",
"description": "Navigation drawer width in pixels.",
"name": "navigationWidth",
"optional": true,
"type": "number",
},
{
"description": "State of the split panel.",
"name": "splitPanelOpen",
"optional": true,
"type": "boolean",
},
{
"description": "Controls the split panel preferences.
By default, the preference is \`{ position: 'bottom' }\`
",
"inlineType": {
"name": "AppLayoutProps.SplitPanelPreferences",
"properties": [
{
"name": "position",
"optional": false,
"type": ""bottom" | "side"",
},
],
"type": "object",
},
"name": "splitPanelPreferences",
"optional": true,
"type": "AppLayoutProps.SplitPanelPreferences",
},
{
"description": "The size of the split panel in pixels.",
"name": "splitPanelSize",
"optional": true,
"type": "number",
},
{
"description": "If true, the notification slot is rendered above the scrollable
content area so it is always visible.",
"name": "stickyNotifications",
"optional": true,
"type": "boolean",
},
{
"description": "If \`true\`, the tools drawer is not displayed at all.",
"name": "toolsHide",
"optional": true,
"type": "boolean",
},
{
"description": "State of the tools drawer.",
"name": "toolsOpen",
"optional": true,
"type": "boolean",
},
{
"defaultValue": "290",
"description": "Tools drawer width in pixels.",
"name": "toolsWidth",
"optional": true,
"type": "number",
},
],
"regions": [
{
"description": "Use this slot to add the [breadcrumb group component](/components/breadcrumb-group/) to the app layout.",
"isDefault": false,
"name": "breadcrumbs",
},
{
"description": "Main content.",
"isDefault": false,
"name": "content",
},
{
"deprecatedTag": "Replaced by the \`header\` slot of the [content layout](/components/content-layout/) component.",
"description": "Top area of the page content.",
"isDefault": false,
"name": "contentHeader",
"visualRefreshTag": "",
},
{
"description": "Navigation drawer.",
"isDefault": false,
"name": "navigation",
},
{
"description": "Displayed on top of the main content in the scrollable area.
Conceived to contain notifications (flash messages).
",
"isDefault": false,
"name": "notifications",
},
{
"description": "Use this slot to add the [split panel component](/components/split-panel/) to the app layout.
Note: If provided, this property should be set to \`null\` or \`undefined\` if a split panel should not be rendered.
",
"isDefault": false,
"name": "splitPanel",
},
{
"description": "Tools drawer.",
"isDefault": false,
"name": "tools",
},
],
"releaseStatus": "stable",
}
`;
exports[`Documenter definition for area-chart matches the snapshot: area-chart 1`] = `
{
"events": [
{
"cancelable": false,
"description": "Called when the values of the internal filter component changed.
This will **not** be called for any custom filter components you have defined in \`additionalFilters\`.",
"detailInlineType": {
"name": "CartesianChartProps.FilterChangeDetail",
"properties": [
{
"name": "visibleSeries",
"optional": false,
"type": "ReadonlyArray<Series>",
},
],
"type": "object",
},
"detailType": "CartesianChartProps.FilterChangeDetail<AreaChartProps.Series<T>>",
"name": "onFilterChange",
},
{
"cancelable": false,
"description": "Called when the highlighted series has changed because of user interaction.",
"detailInlineType": {
"name": "CartesianChartProps.HighlightChangeDetail",
"properties": [
{
"name": "highlightedSeries",
"optional": false,
"type": "Series | null",
},
],
"type": "object",
},
"detailType": "CartesianChartProps.HighlightChangeDetail<AreaChartProps.Series<T>>",
"name": "onHighlightChange",
},
{
"cancelable": false,