@workday/canvas-kit-docs 15.0.0-alpha.0077-next.0 → 15.0.0-alpha.0090-next.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.
- package/dist/es6/lib/docs.js +1036 -6
- package/dist/es6/lib/stackblitzFiles/packageJSONFile.js +5 -5
- package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts +5 -5
- package/dist/mdx/10.0-UPGRADE-GUIDE.mdx +1 -1
- package/dist/mdx/5.0-UPGRADE-GUIDE.mdx +3 -3
- package/dist/mdx/7.0-UPGRADE-GUIDE.mdx +4 -4
- package/dist/mdx/8.0-UPGRADE-GUIDE.mdx +5 -5
- package/dist/mdx/9.0-UPGRADE-GUIDE.mdx +2 -2
- package/dist/mdx/CONTRIBUTING.mdx +4 -4
- package/dist/mdx/CREATING_COMPOUND_COMPONENTS.mdx +1 -1
- package/dist/mdx/labs-react/side-panel/SidePanel.mdx +85 -54
- package/dist/mdx/labs-react/side-panel/examples/AlwaysOpen.tsx +3 -3
- package/dist/mdx/labs-react/side-panel/examples/Basic.tsx +17 -37
- package/dist/mdx/labs-react/side-panel/examples/ExternalControl.tsx +6 -20
- package/dist/mdx/labs-react/side-panel/examples/{HiddenName.tsx → Heading.tsx} +4 -3
- package/dist/mdx/labs-react/side-panel/examples/OnStateTransition.tsx +3 -1
- package/dist/mdx/labs-react/side-panel/examples/RightOrigin.tsx +3 -9
- package/dist/mdx/labs-react/side-panel/examples/Variant.tsx +2 -8
- package/dist/mdx/preview-react/multi-select/MultiSelect.mdx +3 -3
- package/dist/mdx/preview-react/status-indicator/StatusIndicator.mdx +1 -1
- package/dist/mdx/react/action-bar/ActionBar.mdx +1 -1
- package/dist/mdx/react/banner/Banner.mdx +1 -1
- package/dist/mdx/react/breadcrumbs/Breadcrumbs.mdx +1 -1
- package/dist/mdx/react/card/card.mdx +1 -1
- package/dist/mdx/react/common/mdx/CompoundComponentUtilities.mdx +1 -1
- package/dist/mdx/react/layout/Box.mdx +13 -13
- package/dist/mdx/react/layout/Flex.mdx +3 -3
- package/dist/mdx/react/layout/Grid.mdx +3 -3
- package/dist/mdx/react/pagination/pagination.mdx +4 -4
- package/dist/mdx/react/popup/Popup.mdx +1 -1
- package/dist/mdx/react/select/Select.mdx +4 -4
- package/dist/mdx/react/tabs/Tabs.mdx +2 -2
- package/dist/mdx/react/text/Text.mdx +1 -1
- package/dist/mdx/react/toast/toast.mdx +1 -1
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -2415,10 +2415,1040 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
2415
2415
|
}
|
|
2416
2416
|
],
|
|
2417
2417
|
"tags": {}
|
|
2418
|
+
},
|
|
2419
|
+
{
|
|
2420
|
+
"name": "Heading",
|
|
2421
|
+
"symbol": "SidePanelHeading",
|
|
2422
|
+
"description": "`SidePanel.Heading` is a styled heading that provides the accessible name for the SidePanel.\nThe heading's `id` is automatically linked to the panel's `aria-labelledby` attribute.\nBy default, the heading is hidden when the panel is collapsed.",
|
|
2423
|
+
"declarations": [
|
|
2424
|
+
{
|
|
2425
|
+
"name": "Heading",
|
|
2426
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanel.tsx"
|
|
2427
|
+
},
|
|
2428
|
+
{
|
|
2429
|
+
"name": "SidePanelHeading",
|
|
2430
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
|
|
2431
|
+
}
|
|
2432
|
+
],
|
|
2433
|
+
"tags": {}
|
|
2418
2434
|
}
|
|
2419
2435
|
]
|
|
2420
2436
|
}
|
|
2421
2437
|
},
|
|
2438
|
+
{
|
|
2439
|
+
"name": "SidePanelHeadingProps",
|
|
2440
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
|
|
2441
|
+
"description": "",
|
|
2442
|
+
"declarations": [
|
|
2443
|
+
{
|
|
2444
|
+
"name": "SidePanelHeadingProps",
|
|
2445
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
|
|
2446
|
+
}
|
|
2447
|
+
],
|
|
2448
|
+
"tags": {},
|
|
2449
|
+
"type": {
|
|
2450
|
+
"kind": "alias",
|
|
2451
|
+
"name": "SidePanelHeading"
|
|
2452
|
+
}
|
|
2453
|
+
},
|
|
2454
|
+
{
|
|
2455
|
+
"name": "sidePanelHeadingStencil",
|
|
2456
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
|
|
2457
|
+
"description": "",
|
|
2458
|
+
"declarations": [
|
|
2459
|
+
{
|
|
2460
|
+
"name": "sidePanelHeadingStencil",
|
|
2461
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
|
|
2462
|
+
}
|
|
2463
|
+
],
|
|
2464
|
+
"tags": {},
|
|
2465
|
+
"type": {
|
|
2466
|
+
"kind": "function",
|
|
2467
|
+
"parameters": [
|
|
2468
|
+
{
|
|
2469
|
+
"kind": "parameter",
|
|
2470
|
+
"name": "options",
|
|
2471
|
+
"type": {
|
|
2472
|
+
"kind": "conditional",
|
|
2473
|
+
"check": {
|
|
2474
|
+
"kind": "tuple",
|
|
2475
|
+
"value": [
|
|
2476
|
+
{
|
|
2477
|
+
"kind": "symbol",
|
|
2478
|
+
"name": "E",
|
|
2479
|
+
"value": "E"
|
|
2480
|
+
}
|
|
2481
|
+
]
|
|
2482
|
+
},
|
|
2483
|
+
"extends": {
|
|
2484
|
+
"kind": "tuple",
|
|
2485
|
+
"value": [
|
|
2486
|
+
{
|
|
2487
|
+
"kind": "primitive",
|
|
2488
|
+
"value": "never"
|
|
2489
|
+
}
|
|
2490
|
+
]
|
|
2491
|
+
},
|
|
2492
|
+
"trueType": {
|
|
2493
|
+
"kind": "intersection",
|
|
2494
|
+
"value": [
|
|
2495
|
+
{
|
|
2496
|
+
"kind": "symbol",
|
|
2497
|
+
"name": "ModifierValuesStencil",
|
|
2498
|
+
"typeParameters": [
|
|
2499
|
+
{
|
|
2500
|
+
"kind": "symbol",
|
|
2501
|
+
"name": "M",
|
|
2502
|
+
"value": "M"
|
|
2503
|
+
},
|
|
2504
|
+
{
|
|
2505
|
+
"kind": "symbol",
|
|
2506
|
+
"name": "V",
|
|
2507
|
+
"value": "V"
|
|
2508
|
+
}
|
|
2509
|
+
],
|
|
2510
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
2511
|
+
},
|
|
2512
|
+
{
|
|
2513
|
+
"kind": "symbol",
|
|
2514
|
+
"name": "VariableValuesStencil",
|
|
2515
|
+
"typeParameters": [
|
|
2516
|
+
{
|
|
2517
|
+
"kind": "symbol",
|
|
2518
|
+
"name": "V",
|
|
2519
|
+
"value": "V"
|
|
2520
|
+
}
|
|
2521
|
+
],
|
|
2522
|
+
"value": "VariableValuesStencil<V>"
|
|
2523
|
+
}
|
|
2524
|
+
]
|
|
2525
|
+
},
|
|
2526
|
+
"falseType": {
|
|
2527
|
+
"kind": "conditional",
|
|
2528
|
+
"check": {
|
|
2529
|
+
"kind": "symbol",
|
|
2530
|
+
"name": "E",
|
|
2531
|
+
"value": "E"
|
|
2532
|
+
},
|
|
2533
|
+
"extends": {
|
|
2534
|
+
"kind": "symbol",
|
|
2535
|
+
"name": "BaseStencil",
|
|
2536
|
+
"typeParameters": [
|
|
2537
|
+
{
|
|
2538
|
+
"kind": "infer",
|
|
2539
|
+
"value": {
|
|
2540
|
+
"kind": "typeParameter",
|
|
2541
|
+
"name": "ME",
|
|
2542
|
+
"required": true
|
|
2543
|
+
}
|
|
2544
|
+
},
|
|
2545
|
+
{
|
|
2546
|
+
"kind": "primitive",
|
|
2547
|
+
"value": "any"
|
|
2548
|
+
},
|
|
2549
|
+
{
|
|
2550
|
+
"kind": "infer",
|
|
2551
|
+
"value": {
|
|
2552
|
+
"kind": "typeParameter",
|
|
2553
|
+
"name": "VE",
|
|
2554
|
+
"required": true
|
|
2555
|
+
}
|
|
2556
|
+
},
|
|
2557
|
+
{
|
|
2558
|
+
"kind": "primitive",
|
|
2559
|
+
"value": "any"
|
|
2560
|
+
},
|
|
2561
|
+
{
|
|
2562
|
+
"kind": "primitive",
|
|
2563
|
+
"value": "any"
|
|
2564
|
+
}
|
|
2565
|
+
],
|
|
2566
|
+
"value": "BaseStencil<M, P, V, E, ID>"
|
|
2567
|
+
},
|
|
2568
|
+
"trueType": {
|
|
2569
|
+
"kind": "intersection",
|
|
2570
|
+
"value": [
|
|
2571
|
+
{
|
|
2572
|
+
"kind": "symbol",
|
|
2573
|
+
"name": "ModifierValuesStencil",
|
|
2574
|
+
"typeParameters": [
|
|
2575
|
+
{
|
|
2576
|
+
"kind": "intersection",
|
|
2577
|
+
"value": [
|
|
2578
|
+
{
|
|
2579
|
+
"kind": "symbol",
|
|
2580
|
+
"name": "ME",
|
|
2581
|
+
"value": "ME"
|
|
2582
|
+
},
|
|
2583
|
+
{
|
|
2584
|
+
"kind": "symbol",
|
|
2585
|
+
"name": "M",
|
|
2586
|
+
"value": "M"
|
|
2587
|
+
}
|
|
2588
|
+
]
|
|
2589
|
+
},
|
|
2590
|
+
{
|
|
2591
|
+
"kind": "intersection",
|
|
2592
|
+
"value": [
|
|
2593
|
+
{
|
|
2594
|
+
"kind": "symbol",
|
|
2595
|
+
"name": "VE",
|
|
2596
|
+
"value": "VE"
|
|
2597
|
+
},
|
|
2598
|
+
{
|
|
2599
|
+
"kind": "symbol",
|
|
2600
|
+
"name": "V",
|
|
2601
|
+
"value": "V"
|
|
2602
|
+
}
|
|
2603
|
+
]
|
|
2604
|
+
}
|
|
2605
|
+
],
|
|
2606
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
2607
|
+
},
|
|
2608
|
+
{
|
|
2609
|
+
"kind": "symbol",
|
|
2610
|
+
"name": "VariableValuesStencil",
|
|
2611
|
+
"typeParameters": [
|
|
2612
|
+
{
|
|
2613
|
+
"kind": "intersection",
|
|
2614
|
+
"value": [
|
|
2615
|
+
{
|
|
2616
|
+
"kind": "symbol",
|
|
2617
|
+
"name": "VE",
|
|
2618
|
+
"value": "VE"
|
|
2619
|
+
},
|
|
2620
|
+
{
|
|
2621
|
+
"kind": "symbol",
|
|
2622
|
+
"name": "V",
|
|
2623
|
+
"value": "V"
|
|
2624
|
+
}
|
|
2625
|
+
]
|
|
2626
|
+
}
|
|
2627
|
+
],
|
|
2628
|
+
"value": "VariableValuesStencil<V>"
|
|
2629
|
+
}
|
|
2630
|
+
]
|
|
2631
|
+
},
|
|
2632
|
+
"falseType": {
|
|
2633
|
+
"kind": "primitive",
|
|
2634
|
+
"value": "never"
|
|
2635
|
+
}
|
|
2636
|
+
}
|
|
2637
|
+
},
|
|
2638
|
+
"required": false,
|
|
2639
|
+
"rest": false,
|
|
2640
|
+
"description": "",
|
|
2641
|
+
"declarations": [
|
|
2642
|
+
{
|
|
2643
|
+
"name": "options",
|
|
2644
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
2645
|
+
}
|
|
2646
|
+
],
|
|
2647
|
+
"tags": {}
|
|
2648
|
+
}
|
|
2649
|
+
],
|
|
2650
|
+
"members": [
|
|
2651
|
+
{
|
|
2652
|
+
"kind": "property",
|
|
2653
|
+
"name": "parts",
|
|
2654
|
+
"required": true,
|
|
2655
|
+
"type": {
|
|
2656
|
+
"kind": "conditional",
|
|
2657
|
+
"check": {
|
|
2658
|
+
"kind": "tuple",
|
|
2659
|
+
"value": [
|
|
2660
|
+
{
|
|
2661
|
+
"kind": "symbol",
|
|
2662
|
+
"name": "E",
|
|
2663
|
+
"value": "E"
|
|
2664
|
+
}
|
|
2665
|
+
]
|
|
2666
|
+
},
|
|
2667
|
+
"extends": {
|
|
2668
|
+
"kind": "tuple",
|
|
2669
|
+
"value": [
|
|
2670
|
+
{
|
|
2671
|
+
"kind": "symbol",
|
|
2672
|
+
"name": "BaseStencil",
|
|
2673
|
+
"typeParameters": [
|
|
2674
|
+
{
|
|
2675
|
+
"kind": "primitive",
|
|
2676
|
+
"value": "any"
|
|
2677
|
+
},
|
|
2678
|
+
{
|
|
2679
|
+
"kind": "infer",
|
|
2680
|
+
"value": {
|
|
2681
|
+
"kind": "typeParameter",
|
|
2682
|
+
"name": "PE",
|
|
2683
|
+
"required": true
|
|
2684
|
+
}
|
|
2685
|
+
},
|
|
2686
|
+
{
|
|
2687
|
+
"kind": "primitive",
|
|
2688
|
+
"value": "any"
|
|
2689
|
+
},
|
|
2690
|
+
{
|
|
2691
|
+
"kind": "primitive",
|
|
2692
|
+
"value": "any"
|
|
2693
|
+
},
|
|
2694
|
+
{
|
|
2695
|
+
"kind": "primitive",
|
|
2696
|
+
"value": "any"
|
|
2697
|
+
}
|
|
2698
|
+
],
|
|
2699
|
+
"value": "BaseStencil<M, P, V, E, ID>"
|
|
2700
|
+
}
|
|
2701
|
+
]
|
|
2702
|
+
},
|
|
2703
|
+
"trueType": {
|
|
2704
|
+
"kind": "symbol",
|
|
2705
|
+
"name": "StencilPartProps",
|
|
2706
|
+
"typeParameters": [
|
|
2707
|
+
{
|
|
2708
|
+
"kind": "intersection",
|
|
2709
|
+
"value": [
|
|
2710
|
+
{
|
|
2711
|
+
"kind": "symbol",
|
|
2712
|
+
"name": "PE",
|
|
2713
|
+
"value": "PE"
|
|
2714
|
+
},
|
|
2715
|
+
{
|
|
2716
|
+
"kind": "symbol",
|
|
2717
|
+
"name": "P",
|
|
2718
|
+
"value": "P"
|
|
2719
|
+
}
|
|
2720
|
+
]
|
|
2721
|
+
}
|
|
2722
|
+
],
|
|
2723
|
+
"value": "StencilPartProps<T>"
|
|
2724
|
+
},
|
|
2725
|
+
"falseType": {
|
|
2726
|
+
"kind": "symbol",
|
|
2727
|
+
"name": "StencilPartProps",
|
|
2728
|
+
"typeParameters": [
|
|
2729
|
+
{
|
|
2730
|
+
"kind": "symbol",
|
|
2731
|
+
"name": "P",
|
|
2732
|
+
"value": "P"
|
|
2733
|
+
}
|
|
2734
|
+
],
|
|
2735
|
+
"value": "StencilPartProps<T>"
|
|
2736
|
+
}
|
|
2737
|
+
},
|
|
2738
|
+
"description": "",
|
|
2739
|
+
"declarations": [
|
|
2740
|
+
{
|
|
2741
|
+
"name": "parts",
|
|
2742
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
2743
|
+
}
|
|
2744
|
+
],
|
|
2745
|
+
"tags": {}
|
|
2746
|
+
},
|
|
2747
|
+
{
|
|
2748
|
+
"kind": "property",
|
|
2749
|
+
"name": "vars",
|
|
2750
|
+
"required": true,
|
|
2751
|
+
"type": {
|
|
2752
|
+
"kind": "symbol",
|
|
2753
|
+
"name": "StencilDefaultVars",
|
|
2754
|
+
"typeParameters": [
|
|
2755
|
+
{
|
|
2756
|
+
"kind": "symbol",
|
|
2757
|
+
"name": "V",
|
|
2758
|
+
"value": "V"
|
|
2759
|
+
},
|
|
2760
|
+
{
|
|
2761
|
+
"kind": "symbol",
|
|
2762
|
+
"name": "E",
|
|
2763
|
+
"value": "E"
|
|
2764
|
+
},
|
|
2765
|
+
{
|
|
2766
|
+
"kind": "symbol",
|
|
2767
|
+
"name": "ID",
|
|
2768
|
+
"value": "ID"
|
|
2769
|
+
}
|
|
2770
|
+
],
|
|
2771
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
2772
|
+
},
|
|
2773
|
+
"description": "",
|
|
2774
|
+
"declarations": [
|
|
2775
|
+
{
|
|
2776
|
+
"name": "vars",
|
|
2777
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
2778
|
+
}
|
|
2779
|
+
],
|
|
2780
|
+
"tags": {}
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
"kind": "property",
|
|
2784
|
+
"name": "base",
|
|
2785
|
+
"required": true,
|
|
2786
|
+
"type": {
|
|
2787
|
+
"kind": "primitive",
|
|
2788
|
+
"value": "string"
|
|
2789
|
+
},
|
|
2790
|
+
"description": "",
|
|
2791
|
+
"declarations": [
|
|
2792
|
+
{
|
|
2793
|
+
"name": "base",
|
|
2794
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
2795
|
+
}
|
|
2796
|
+
],
|
|
2797
|
+
"tags": {}
|
|
2798
|
+
},
|
|
2799
|
+
{
|
|
2800
|
+
"kind": "property",
|
|
2801
|
+
"name": "modifiers",
|
|
2802
|
+
"required": true,
|
|
2803
|
+
"type": {
|
|
2804
|
+
"kind": "conditional",
|
|
2805
|
+
"check": {
|
|
2806
|
+
"kind": "tuple",
|
|
2807
|
+
"value": [
|
|
2808
|
+
{
|
|
2809
|
+
"kind": "symbol",
|
|
2810
|
+
"name": "E",
|
|
2811
|
+
"value": "E"
|
|
2812
|
+
}
|
|
2813
|
+
]
|
|
2814
|
+
},
|
|
2815
|
+
"extends": {
|
|
2816
|
+
"kind": "tuple",
|
|
2817
|
+
"value": [
|
|
2818
|
+
{
|
|
2819
|
+
"kind": "symbol",
|
|
2820
|
+
"name": "BaseStencil",
|
|
2821
|
+
"typeParameters": [
|
|
2822
|
+
{
|
|
2823
|
+
"kind": "infer",
|
|
2824
|
+
"value": {
|
|
2825
|
+
"kind": "typeParameter",
|
|
2826
|
+
"name": "ME",
|
|
2827
|
+
"required": true
|
|
2828
|
+
}
|
|
2829
|
+
},
|
|
2830
|
+
{
|
|
2831
|
+
"kind": "primitive",
|
|
2832
|
+
"value": "any"
|
|
2833
|
+
},
|
|
2834
|
+
{
|
|
2835
|
+
"kind": "infer",
|
|
2836
|
+
"value": {
|
|
2837
|
+
"kind": "typeParameter",
|
|
2838
|
+
"name": "VE",
|
|
2839
|
+
"required": true
|
|
2840
|
+
}
|
|
2841
|
+
},
|
|
2842
|
+
{
|
|
2843
|
+
"kind": "primitive",
|
|
2844
|
+
"value": "any"
|
|
2845
|
+
},
|
|
2846
|
+
{
|
|
2847
|
+
"kind": "primitive",
|
|
2848
|
+
"value": "any"
|
|
2849
|
+
}
|
|
2850
|
+
],
|
|
2851
|
+
"value": "BaseStencil<M, P, V, E, ID>"
|
|
2852
|
+
}
|
|
2853
|
+
]
|
|
2854
|
+
},
|
|
2855
|
+
"trueType": {
|
|
2856
|
+
"kind": "symbol",
|
|
2857
|
+
"name": "StencilModifierReturn",
|
|
2858
|
+
"typeParameters": [
|
|
2859
|
+
{
|
|
2860
|
+
"kind": "intersection",
|
|
2861
|
+
"value": [
|
|
2862
|
+
{
|
|
2863
|
+
"kind": "symbol",
|
|
2864
|
+
"name": "ME",
|
|
2865
|
+
"value": "ME"
|
|
2866
|
+
},
|
|
2867
|
+
{
|
|
2868
|
+
"kind": "symbol",
|
|
2869
|
+
"name": "M",
|
|
2870
|
+
"value": "M"
|
|
2871
|
+
}
|
|
2872
|
+
]
|
|
2873
|
+
},
|
|
2874
|
+
{
|
|
2875
|
+
"kind": "intersection",
|
|
2876
|
+
"value": [
|
|
2877
|
+
{
|
|
2878
|
+
"kind": "symbol",
|
|
2879
|
+
"name": "VE",
|
|
2880
|
+
"value": "VE"
|
|
2881
|
+
},
|
|
2882
|
+
{
|
|
2883
|
+
"kind": "symbol",
|
|
2884
|
+
"name": "V",
|
|
2885
|
+
"value": "V"
|
|
2886
|
+
}
|
|
2887
|
+
]
|
|
2888
|
+
}
|
|
2889
|
+
],
|
|
2890
|
+
"value": "StencilModifierReturn<M, V>"
|
|
2891
|
+
},
|
|
2892
|
+
"falseType": {
|
|
2893
|
+
"kind": "symbol",
|
|
2894
|
+
"name": "StencilModifierReturn",
|
|
2895
|
+
"typeParameters": [
|
|
2896
|
+
{
|
|
2897
|
+
"kind": "symbol",
|
|
2898
|
+
"name": "M",
|
|
2899
|
+
"value": "M"
|
|
2900
|
+
},
|
|
2901
|
+
{
|
|
2902
|
+
"kind": "symbol",
|
|
2903
|
+
"name": "V",
|
|
2904
|
+
"value": "V"
|
|
2905
|
+
}
|
|
2906
|
+
],
|
|
2907
|
+
"value": "StencilModifierReturn<M, V>"
|
|
2908
|
+
}
|
|
2909
|
+
},
|
|
2910
|
+
"description": "",
|
|
2911
|
+
"declarations": [
|
|
2912
|
+
{
|
|
2913
|
+
"name": "modifiers",
|
|
2914
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
2915
|
+
}
|
|
2916
|
+
],
|
|
2917
|
+
"tags": {}
|
|
2918
|
+
},
|
|
2919
|
+
{
|
|
2920
|
+
"kind": "property",
|
|
2921
|
+
"name": "defaultModifiers",
|
|
2922
|
+
"required": true,
|
|
2923
|
+
"type": {
|
|
2924
|
+
"kind": "conditional",
|
|
2925
|
+
"check": {
|
|
2926
|
+
"kind": "tuple",
|
|
2927
|
+
"value": [
|
|
2928
|
+
{
|
|
2929
|
+
"kind": "symbol",
|
|
2930
|
+
"name": "E",
|
|
2931
|
+
"value": "E"
|
|
2932
|
+
}
|
|
2933
|
+
]
|
|
2934
|
+
},
|
|
2935
|
+
"extends": {
|
|
2936
|
+
"kind": "tuple",
|
|
2937
|
+
"value": [
|
|
2938
|
+
{
|
|
2939
|
+
"kind": "symbol",
|
|
2940
|
+
"name": "BaseStencil",
|
|
2941
|
+
"typeParameters": [
|
|
2942
|
+
{
|
|
2943
|
+
"kind": "infer",
|
|
2944
|
+
"value": {
|
|
2945
|
+
"kind": "typeParameter",
|
|
2946
|
+
"name": "ME",
|
|
2947
|
+
"required": true
|
|
2948
|
+
}
|
|
2949
|
+
},
|
|
2950
|
+
{
|
|
2951
|
+
"kind": "primitive",
|
|
2952
|
+
"value": "any"
|
|
2953
|
+
},
|
|
2954
|
+
{
|
|
2955
|
+
"kind": "primitive",
|
|
2956
|
+
"value": "any"
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
"kind": "primitive",
|
|
2960
|
+
"value": "any"
|
|
2961
|
+
},
|
|
2962
|
+
{
|
|
2963
|
+
"kind": "primitive",
|
|
2964
|
+
"value": "any"
|
|
2965
|
+
}
|
|
2966
|
+
],
|
|
2967
|
+
"value": "BaseStencil<M, P, V, E, ID>"
|
|
2968
|
+
}
|
|
2969
|
+
]
|
|
2970
|
+
},
|
|
2971
|
+
"trueType": {
|
|
2972
|
+
"kind": "symbol",
|
|
2973
|
+
"name": "StencilDefaultModifierReturn",
|
|
2974
|
+
"typeParameters": [
|
|
2975
|
+
{
|
|
2976
|
+
"kind": "intersection",
|
|
2977
|
+
"value": [
|
|
2978
|
+
{
|
|
2979
|
+
"kind": "symbol",
|
|
2980
|
+
"name": "ME",
|
|
2981
|
+
"value": "ME"
|
|
2982
|
+
},
|
|
2983
|
+
{
|
|
2984
|
+
"kind": "symbol",
|
|
2985
|
+
"name": "M",
|
|
2986
|
+
"value": "M"
|
|
2987
|
+
}
|
|
2988
|
+
]
|
|
2989
|
+
}
|
|
2990
|
+
],
|
|
2991
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
2992
|
+
},
|
|
2993
|
+
"falseType": {
|
|
2994
|
+
"kind": "symbol",
|
|
2995
|
+
"name": "StencilDefaultModifierReturn",
|
|
2996
|
+
"typeParameters": [
|
|
2997
|
+
{
|
|
2998
|
+
"kind": "symbol",
|
|
2999
|
+
"name": "M",
|
|
3000
|
+
"value": "M"
|
|
3001
|
+
}
|
|
3002
|
+
],
|
|
3003
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
3004
|
+
}
|
|
3005
|
+
},
|
|
3006
|
+
"description": "",
|
|
3007
|
+
"declarations": [
|
|
3008
|
+
{
|
|
3009
|
+
"name": "defaultModifiers",
|
|
3010
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3011
|
+
}
|
|
3012
|
+
],
|
|
3013
|
+
"tags": {}
|
|
3014
|
+
},
|
|
3015
|
+
{
|
|
3016
|
+
"kind": "property",
|
|
3017
|
+
"name": "__extends",
|
|
3018
|
+
"required": false,
|
|
3019
|
+
"type": {
|
|
3020
|
+
"kind": "symbol",
|
|
3021
|
+
"name": "E",
|
|
3022
|
+
"value": "E"
|
|
3023
|
+
},
|
|
3024
|
+
"description": "",
|
|
3025
|
+
"declarations": [
|
|
3026
|
+
{
|
|
3027
|
+
"name": "__extends",
|
|
3028
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3029
|
+
}
|
|
3030
|
+
],
|
|
3031
|
+
"tags": {}
|
|
3032
|
+
},
|
|
3033
|
+
{
|
|
3034
|
+
"kind": "property",
|
|
3035
|
+
"name": "__vars",
|
|
3036
|
+
"required": true,
|
|
3037
|
+
"type": {
|
|
3038
|
+
"kind": "symbol",
|
|
3039
|
+
"name": "V",
|
|
3040
|
+
"value": "V"
|
|
3041
|
+
},
|
|
3042
|
+
"description": "",
|
|
3043
|
+
"declarations": [
|
|
3044
|
+
{
|
|
3045
|
+
"name": "__vars",
|
|
3046
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3047
|
+
}
|
|
3048
|
+
],
|
|
3049
|
+
"tags": {}
|
|
3050
|
+
},
|
|
3051
|
+
{
|
|
3052
|
+
"kind": "property",
|
|
3053
|
+
"name": "__modifiers",
|
|
3054
|
+
"required": true,
|
|
3055
|
+
"type": {
|
|
3056
|
+
"kind": "symbol",
|
|
3057
|
+
"name": "M",
|
|
3058
|
+
"value": "M"
|
|
3059
|
+
},
|
|
3060
|
+
"description": "",
|
|
3061
|
+
"declarations": [
|
|
3062
|
+
{
|
|
3063
|
+
"name": "__modifiers",
|
|
3064
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3065
|
+
}
|
|
3066
|
+
],
|
|
3067
|
+
"tags": {}
|
|
3068
|
+
},
|
|
3069
|
+
{
|
|
3070
|
+
"kind": "property",
|
|
3071
|
+
"name": "__id",
|
|
3072
|
+
"required": true,
|
|
3073
|
+
"type": {
|
|
3074
|
+
"kind": "symbol",
|
|
3075
|
+
"name": "ID",
|
|
3076
|
+
"value": "ID"
|
|
3077
|
+
},
|
|
3078
|
+
"description": "",
|
|
3079
|
+
"declarations": [
|
|
3080
|
+
{
|
|
3081
|
+
"name": "__id",
|
|
3082
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3083
|
+
}
|
|
3084
|
+
],
|
|
3085
|
+
"tags": {}
|
|
3086
|
+
},
|
|
3087
|
+
{
|
|
3088
|
+
"kind": "property",
|
|
3089
|
+
"name": "__parts",
|
|
3090
|
+
"required": false,
|
|
3091
|
+
"type": {
|
|
3092
|
+
"kind": "symbol",
|
|
3093
|
+
"name": "P",
|
|
3094
|
+
"value": "P"
|
|
3095
|
+
},
|
|
3096
|
+
"description": "",
|
|
3097
|
+
"declarations": [
|
|
3098
|
+
{
|
|
3099
|
+
"name": "__parts",
|
|
3100
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3101
|
+
}
|
|
3102
|
+
],
|
|
3103
|
+
"tags": {}
|
|
3104
|
+
}
|
|
3105
|
+
],
|
|
3106
|
+
"returnType": {
|
|
3107
|
+
"kind": "object",
|
|
3108
|
+
"properties": [
|
|
3109
|
+
{
|
|
3110
|
+
"kind": "property",
|
|
3111
|
+
"name": "className",
|
|
3112
|
+
"required": true,
|
|
3113
|
+
"type": {
|
|
3114
|
+
"kind": "primitive",
|
|
3115
|
+
"value": "string"
|
|
3116
|
+
},
|
|
3117
|
+
"description": "",
|
|
3118
|
+
"declarations": [
|
|
3119
|
+
{
|
|
3120
|
+
"name": "className",
|
|
3121
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3122
|
+
}
|
|
3123
|
+
],
|
|
3124
|
+
"tags": {}
|
|
3125
|
+
},
|
|
3126
|
+
{
|
|
3127
|
+
"kind": "property",
|
|
3128
|
+
"name": "style",
|
|
3129
|
+
"required": false,
|
|
3130
|
+
"type": {
|
|
3131
|
+
"kind": "external",
|
|
3132
|
+
"name": "Record",
|
|
3133
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
3134
|
+
"typeParameters": [
|
|
3135
|
+
{
|
|
3136
|
+
"kind": "primitive",
|
|
3137
|
+
"value": "string"
|
|
3138
|
+
},
|
|
3139
|
+
{
|
|
3140
|
+
"kind": "primitive",
|
|
3141
|
+
"value": "string"
|
|
3142
|
+
}
|
|
3143
|
+
]
|
|
3144
|
+
},
|
|
3145
|
+
"description": "",
|
|
3146
|
+
"declarations": [
|
|
3147
|
+
{
|
|
3148
|
+
"name": "style",
|
|
3149
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3150
|
+
}
|
|
3151
|
+
],
|
|
3152
|
+
"tags": {}
|
|
3153
|
+
}
|
|
3154
|
+
]
|
|
3155
|
+
}
|
|
3156
|
+
}
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
"name": "useSidePanelHeading",
|
|
3160
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
|
|
3161
|
+
"description": "Adds the necessary props to the SidePanelHeading subcomponent.\nThis sets the `id` to the `labelId` from the model for accessibility purposes,\nand hides the heading when the panel is not expanded.",
|
|
3162
|
+
"declarations": [
|
|
3163
|
+
{
|
|
3164
|
+
"name": "useSidePanelHeading",
|
|
3165
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
|
|
3166
|
+
}
|
|
3167
|
+
],
|
|
3168
|
+
"tags": {},
|
|
3169
|
+
"type": {
|
|
3170
|
+
"kind": "function",
|
|
3171
|
+
"name": {
|
|
3172
|
+
"kind": "symbol",
|
|
3173
|
+
"name": "createElemPropsHook"
|
|
3174
|
+
},
|
|
3175
|
+
"parameters": [
|
|
3176
|
+
{
|
|
3177
|
+
"kind": "parameter",
|
|
3178
|
+
"name": "model",
|
|
3179
|
+
"description": "",
|
|
3180
|
+
"tags": {},
|
|
3181
|
+
"declarations": [],
|
|
3182
|
+
"type": {
|
|
3183
|
+
"kind": "symbol",
|
|
3184
|
+
"name": "SidePanelModel"
|
|
3185
|
+
},
|
|
3186
|
+
"required": true
|
|
3187
|
+
},
|
|
3188
|
+
{
|
|
3189
|
+
"kind": "parameter",
|
|
3190
|
+
"name": "elemProps",
|
|
3191
|
+
"description": "",
|
|
3192
|
+
"tags": {},
|
|
3193
|
+
"declarations": [],
|
|
3194
|
+
"type": {
|
|
3195
|
+
"kind": "object",
|
|
3196
|
+
"properties": []
|
|
3197
|
+
},
|
|
3198
|
+
"required": false
|
|
3199
|
+
},
|
|
3200
|
+
{
|
|
3201
|
+
"kind": "parameter",
|
|
3202
|
+
"name": "ref",
|
|
3203
|
+
"description": "",
|
|
3204
|
+
"tags": {},
|
|
3205
|
+
"declarations": [],
|
|
3206
|
+
"type": {
|
|
3207
|
+
"kind": "external",
|
|
3208
|
+
"name": "React.Ref",
|
|
3209
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html"
|
|
3210
|
+
},
|
|
3211
|
+
"required": false
|
|
3212
|
+
}
|
|
3213
|
+
],
|
|
3214
|
+
"returnType": {
|
|
3215
|
+
"kind": "object",
|
|
3216
|
+
"properties": [
|
|
3217
|
+
{
|
|
3218
|
+
"kind": "property",
|
|
3219
|
+
"name": "id",
|
|
3220
|
+
"required": true,
|
|
3221
|
+
"type": {
|
|
3222
|
+
"kind": "primitive",
|
|
3223
|
+
"value": "string"
|
|
3224
|
+
},
|
|
3225
|
+
"description": "",
|
|
3226
|
+
"tags": {},
|
|
3227
|
+
"declarations": []
|
|
3228
|
+
},
|
|
3229
|
+
{
|
|
3230
|
+
"kind": "property",
|
|
3231
|
+
"name": "hidden",
|
|
3232
|
+
"required": true,
|
|
3233
|
+
"type": {
|
|
3234
|
+
"kind": "primitive",
|
|
3235
|
+
"value": "boolean"
|
|
3236
|
+
},
|
|
3237
|
+
"description": "",
|
|
3238
|
+
"tags": {},
|
|
3239
|
+
"declarations": []
|
|
3240
|
+
}
|
|
3241
|
+
]
|
|
3242
|
+
}
|
|
3243
|
+
}
|
|
3244
|
+
},
|
|
3245
|
+
{
|
|
3246
|
+
"name": "SidePanelHeading",
|
|
3247
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
|
|
3248
|
+
"description": "`SidePanel.Heading` is a styled heading component that provides the accessible name\nfor the SidePanel. The heading's `id` is automatically set to the model's `labelId`,\nwhich is used by the panel's `aria-labelledby` attribute.\n\nThe heading is automatically hidden when the panel is collapsed.",
|
|
3249
|
+
"declarations": [
|
|
3250
|
+
{
|
|
3251
|
+
"name": "SidePanelHeading",
|
|
3252
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
|
|
3253
|
+
}
|
|
3254
|
+
],
|
|
3255
|
+
"tags": {},
|
|
3256
|
+
"type": {
|
|
3257
|
+
"kind": "enhancedComponent",
|
|
3258
|
+
"componentType": "subcomponent",
|
|
3259
|
+
"elemPropsHook": "useSidePanelHeading",
|
|
3260
|
+
"displayName": "SidePanel.Heading",
|
|
3261
|
+
"props": [
|
|
3262
|
+
{
|
|
3263
|
+
"kind": "property",
|
|
3264
|
+
"name": "children",
|
|
3265
|
+
"required": false,
|
|
3266
|
+
"type": {
|
|
3267
|
+
"kind": "external",
|
|
3268
|
+
"name": "ReactNode",
|
|
3269
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
3270
|
+
},
|
|
3271
|
+
"description": "",
|
|
3272
|
+
"declarations": [
|
|
3273
|
+
{
|
|
3274
|
+
"name": "children",
|
|
3275
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
|
|
3276
|
+
}
|
|
3277
|
+
],
|
|
3278
|
+
"tags": {}
|
|
3279
|
+
},
|
|
3280
|
+
{
|
|
3281
|
+
"kind": "property",
|
|
3282
|
+
"name": "size",
|
|
3283
|
+
"required": true,
|
|
3284
|
+
"type": {
|
|
3285
|
+
"kind": "symbol",
|
|
3286
|
+
"name": "Size",
|
|
3287
|
+
"value": "Size"
|
|
3288
|
+
},
|
|
3289
|
+
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
3290
|
+
"declarations": [
|
|
3291
|
+
{
|
|
3292
|
+
"name": "size",
|
|
3293
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
|
|
3294
|
+
}
|
|
3295
|
+
],
|
|
3296
|
+
"tags": {},
|
|
3297
|
+
"defaultValue": {
|
|
3298
|
+
"kind": "string",
|
|
3299
|
+
"value": "small"
|
|
3300
|
+
}
|
|
3301
|
+
},
|
|
3302
|
+
{
|
|
3303
|
+
"kind": "property",
|
|
3304
|
+
"name": "cs",
|
|
3305
|
+
"required": false,
|
|
3306
|
+
"type": {
|
|
3307
|
+
"kind": "symbol",
|
|
3308
|
+
"name": "CSToPropsInput",
|
|
3309
|
+
"value": "CSToPropsInput"
|
|
3310
|
+
},
|
|
3311
|
+
"description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
|
|
3312
|
+
"declarations": [
|
|
3313
|
+
{
|
|
3314
|
+
"name": "cs",
|
|
3315
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
3316
|
+
}
|
|
3317
|
+
],
|
|
3318
|
+
"tags": {}
|
|
3319
|
+
},
|
|
3320
|
+
{
|
|
3321
|
+
"kind": "property",
|
|
3322
|
+
"name": "variant",
|
|
3323
|
+
"required": false,
|
|
3324
|
+
"type": {
|
|
3325
|
+
"kind": "union",
|
|
3326
|
+
"value": [
|
|
3327
|
+
{
|
|
3328
|
+
"kind": "string",
|
|
3329
|
+
"value": "error"
|
|
3330
|
+
},
|
|
3331
|
+
{
|
|
3332
|
+
"kind": "string",
|
|
3333
|
+
"value": "hint"
|
|
3334
|
+
},
|
|
3335
|
+
{
|
|
3336
|
+
"kind": "string",
|
|
3337
|
+
"value": "inverse"
|
|
3338
|
+
}
|
|
3339
|
+
]
|
|
3340
|
+
},
|
|
3341
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
3342
|
+
"declarations": [
|
|
3343
|
+
{
|
|
3344
|
+
"name": "variant",
|
|
3345
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
3346
|
+
}
|
|
3347
|
+
],
|
|
3348
|
+
"tags": {}
|
|
3349
|
+
},
|
|
3350
|
+
{
|
|
3351
|
+
"kind": "property",
|
|
3352
|
+
"name": "as",
|
|
3353
|
+
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
|
|
3354
|
+
"tags": {},
|
|
3355
|
+
"declarations": [],
|
|
3356
|
+
"type": {
|
|
3357
|
+
"kind": "external",
|
|
3358
|
+
"name": "React.ElementType",
|
|
3359
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
3360
|
+
},
|
|
3361
|
+
"defaultValue": {
|
|
3362
|
+
"kind": "symbol",
|
|
3363
|
+
"name": "Heading"
|
|
3364
|
+
}
|
|
3365
|
+
},
|
|
3366
|
+
{
|
|
3367
|
+
"kind": "property",
|
|
3368
|
+
"name": "ref",
|
|
3369
|
+
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
|
|
3370
|
+
"tags": {},
|
|
3371
|
+
"declarations": [],
|
|
3372
|
+
"type": {
|
|
3373
|
+
"kind": "external",
|
|
3374
|
+
"name": "React.Ref",
|
|
3375
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
3376
|
+
"typeParameters": [
|
|
3377
|
+
{
|
|
3378
|
+
"kind": "typeParameter",
|
|
3379
|
+
"name": "R",
|
|
3380
|
+
"required": true,
|
|
3381
|
+
"defaultValue": {
|
|
3382
|
+
"kind": "symbol",
|
|
3383
|
+
"name": "Heading"
|
|
3384
|
+
}
|
|
3385
|
+
}
|
|
3386
|
+
]
|
|
3387
|
+
}
|
|
3388
|
+
},
|
|
3389
|
+
{
|
|
3390
|
+
"kind": "property",
|
|
3391
|
+
"name": "model",
|
|
3392
|
+
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
3393
|
+
"tags": {},
|
|
3394
|
+
"declarations": [],
|
|
3395
|
+
"type": {
|
|
3396
|
+
"kind": "symbol",
|
|
3397
|
+
"name": "SidePanelModel"
|
|
3398
|
+
}
|
|
3399
|
+
},
|
|
3400
|
+
{
|
|
3401
|
+
"kind": "property",
|
|
3402
|
+
"name": "elemPropsHook",
|
|
3403
|
+
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
3404
|
+
"tags": {},
|
|
3405
|
+
"declarations": [],
|
|
3406
|
+
"type": {
|
|
3407
|
+
"kind": "function",
|
|
3408
|
+
"parameters": [
|
|
3409
|
+
{
|
|
3410
|
+
"kind": "parameter",
|
|
3411
|
+
"description": "",
|
|
3412
|
+
"tags": {},
|
|
3413
|
+
"declarations": [],
|
|
3414
|
+
"name": "model",
|
|
3415
|
+
"type": {
|
|
3416
|
+
"kind": "symbol",
|
|
3417
|
+
"name": "SidePanelModel"
|
|
3418
|
+
},
|
|
3419
|
+
"required": true
|
|
3420
|
+
},
|
|
3421
|
+
{
|
|
3422
|
+
"kind": "parameter",
|
|
3423
|
+
"description": "",
|
|
3424
|
+
"tags": {},
|
|
3425
|
+
"declarations": [],
|
|
3426
|
+
"name": "elemProps",
|
|
3427
|
+
"type": {
|
|
3428
|
+
"kind": "generic",
|
|
3429
|
+
"name": "TProps"
|
|
3430
|
+
}
|
|
3431
|
+
}
|
|
3432
|
+
],
|
|
3433
|
+
"returnType": {
|
|
3434
|
+
"kind": "external",
|
|
3435
|
+
"name": "HTML Attributes",
|
|
3436
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
3437
|
+
}
|
|
3438
|
+
}
|
|
3439
|
+
}
|
|
3440
|
+
],
|
|
3441
|
+
"baseElement": {
|
|
3442
|
+
"kind": "symbol",
|
|
3443
|
+
"name": "Heading"
|
|
3444
|
+
},
|
|
3445
|
+
"styleComponent": {
|
|
3446
|
+
"kind": "symbol",
|
|
3447
|
+
"name": "Box"
|
|
3448
|
+
},
|
|
3449
|
+
"model": "SidePanelModel"
|
|
3450
|
+
}
|
|
3451
|
+
},
|
|
2422
3452
|
{
|
|
2423
3453
|
"name": "SidePanelToggleButtonProps",
|
|
2424
3454
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelToggleButton.tsx",
|
|
@@ -3212,7 +4242,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3212
4242
|
},
|
|
3213
4243
|
{
|
|
3214
4244
|
"kind": "property",
|
|
3215
|
-
"name": "aria-
|
|
4245
|
+
"name": "aria-pressed",
|
|
3216
4246
|
"required": true,
|
|
3217
4247
|
"type": {
|
|
3218
4248
|
"kind": "primitive",
|
|
@@ -3224,7 +4254,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3224
4254
|
},
|
|
3225
4255
|
{
|
|
3226
4256
|
"kind": "property",
|
|
3227
|
-
"name": "aria-
|
|
4257
|
+
"name": "aria-describedby",
|
|
3228
4258
|
"required": true,
|
|
3229
4259
|
"type": {
|
|
3230
4260
|
"kind": "primitive",
|
|
@@ -373341,7 +374371,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
373341
374371
|
{
|
|
373342
374372
|
"name": "Tabs",
|
|
373343
374373
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/Tabs.tsx",
|
|
373344
|
-
"description": "`Tabs` is a container component that is responsible for creating a {@link TabsModel } and sharing\nit with its subcomponents using React context. It does not represent a real element.\n\n```tsx\n<Tabs onSelect={data => console.log('Selected tab', data.id)}>\n {child components}\n</Tabs>\n```\n\nAlternatively, you may pass in a model using the hoisted model pattern.\n\n```tsx\nconst model = useTabsModel({\n onSelect(data) {\n console.log('Activated Tab', data.id);\n },\n});\n\n<Tabs model={model}>{child components}</Tabs>\n```\n\nSee [Configuring a\nModel](/
|
|
374374
|
+
"description": "`Tabs` is a container component that is responsible for creating a {@link TabsModel } and sharing\nit with its subcomponents using React context. It does not represent a real element.\n\n```tsx\n<Tabs onSelect={data => console.log('Selected tab', data.id)}>\n {child components}\n</Tabs>\n```\n\nAlternatively, you may pass in a model using the hoisted model pattern.\n\n```tsx\nconst model = useTabsModel({\n onSelect(data) {\n console.log('Activated Tab', data.id);\n },\n});\n\n<Tabs model={model}>{child components}</Tabs>\n```\n\nSee [Configuring a\nModel](/get-started/for-developers/documentation/compound-components/#configuring-a-model) for\nmore information on model configuration.",
|
|
373345
374375
|
"declarations": [
|
|
373346
374376
|
{
|
|
373347
374377
|
"name": "Tabs",
|
|
@@ -386741,7 +387771,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
386741
387771
|
{
|
|
386742
387772
|
"name": "useTabsModel",
|
|
386743
387773
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/useTabsModel.tsx",
|
|
386744
|
-
"description": "The TabsModel extends the [Collection\nSystem](/
|
|
387774
|
+
"description": "The TabsModel extends the [Collection\nSystem](/get-started/for-developers/guides/collection-api/). Tabs have tab items and\npanels. Tabs can be overflowed if there isn't enough room to render and will overflow to a\n{@link MenuModel } sub-model.\n\n```tsx\nconst model = useTabsModel({\n onSelect(data) {\n console.log('Selected Tab', data)\n }\n})\n\n<Tabs model={model}>{Tabs child components}</Tabs>\n```",
|
|
386745
387775
|
"declarations": [
|
|
386746
387776
|
{
|
|
386747
387777
|
"name": "useTabsModel",
|
|
@@ -387273,7 +388303,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
387273
388303
|
{
|
|
387274
388304
|
"name": "TabsModel",
|
|
387275
388305
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/useTabsModel.tsx",
|
|
387276
|
-
"description": "The TabsModel extends the [Collection\nSystem](/
|
|
388306
|
+
"description": "The TabsModel extends the [Collection\nSystem](/get-started/for-developers/guides/collection-api/). Tabs have tab items and\npanels. Tabs can be overflowed if there isn't enough room to render and will overflow to a\n{@link MenuModel } sub-model.\n\n```tsx\nconst model = useTabsModel({\n onSelect(data) {\n console.log('Selected Tab', data)\n }\n})\n\n<Tabs model={model}>{Tabs child components}</Tabs>\n```",
|
|
387277
388307
|
"declarations": [
|
|
387278
388308
|
{
|
|
387279
388309
|
"name": "useTabsModel",
|
|
@@ -389627,7 +390657,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
389627
390657
|
{
|
|
389628
390658
|
"name": "TabsModelConfig",
|
|
389629
390659
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/useTabsModel.tsx",
|
|
389630
|
-
"description": "The TabsModel extends the [Collection\nSystem](/
|
|
390660
|
+
"description": "The TabsModel extends the [Collection\nSystem](/get-started/for-developers/guides/collection-api/). Tabs have tab items and\npanels. Tabs can be overflowed if there isn't enough room to render and will overflow to a\n{@link MenuModel } sub-model.\n\n```tsx\nconst model = useTabsModel({\n onSelect(data) {\n console.log('Selected Tab', data)\n }\n})\n\n<Tabs model={model}>{Tabs child components}</Tabs>\n```",
|
|
389631
390661
|
"declarations": [
|
|
389632
390662
|
{
|
|
389633
390663
|
"name": "useTabsModel",
|