@primer/view-components 0.1.8-rc.d128f1fa → 0.1.9-rc.167445f8

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.
@@ -97,6 +97,13 @@
97
97
  }
98
98
  ]
99
99
  },
100
+ {
101
+ "name": "id",
102
+ "description": "Returns the value of attribute id.",
103
+ "parameters": [
104
+
105
+ ]
106
+ },
100
107
  {
101
108
  "name": "select_variant",
102
109
  "description": "Returns the value of attribute select_variant.",
@@ -109,6 +116,13 @@
109
116
  "description": "Returns the value of attribute role.",
110
117
  "parameters": [
111
118
 
119
+ ]
120
+ },
121
+ {
122
+ "name": "post_list_content_block",
123
+ "description": "Returns the value of attribute post_list_content_block.",
124
+ "parameters": [
125
+
112
126
  ]
113
127
  }
114
128
  ],
@@ -467,12 +481,6 @@
467
481
  "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
468
482
  "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
469
483
  "parameters": [
470
- {
471
- "name": "id",
472
- "type": "String",
473
- "default": "`self.class.generate_id`",
474
- "description": "The group's identifier (ID attribute in HTML)."
475
- },
476
484
  {
477
485
  "name": "title",
478
486
  "type": "String",
@@ -497,12 +505,6 @@
497
505
  "default": "`:subtle`",
498
506
  "description": "Display a background color if scheme is `filled`."
499
507
  },
500
- {
501
- "name": "tag",
502
- "type": "Integer",
503
- "default": "N/A",
504
- "description": "Semantic tag for the heading."
505
- },
506
508
  {
507
509
  "name": "system_arguments",
508
510
  "type": "Hash",
@@ -515,8 +517,15 @@
515
517
  ],
516
518
  "methods": [
517
519
  {
518
- "name": "id",
519
- "description": "Returns the value of attribute id.",
520
+ "name": "title_id",
521
+ "description": "Returns the value of attribute title_id.",
522
+ "parameters": [
523
+
524
+ ]
525
+ },
526
+ {
527
+ "name": "subtitle_id",
528
+ "description": "Returns the value of attribute subtitle_id.",
520
529
  "parameters": [
521
530
 
522
531
  ]
@@ -556,7 +565,7 @@
556
565
  },
557
566
  {
558
567
  "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
559
- "description": "Group heading rendered above the group contents.",
568
+ "description": "Separator with optional text rendered above groups or between individual items.",
560
569
  "component": "ActionList::Divider",
561
570
  "status": "alpha",
562
571
  "a11y_reviewed": false,
@@ -1702,7 +1711,13 @@
1702
1711
  }
1703
1712
  ],
1704
1713
  "methods": [
1714
+ {
1715
+ "name": "id",
1716
+ "description": "The dialog's ID value.",
1717
+ "parameters": [
1705
1718
 
1719
+ ]
1720
+ }
1706
1721
  ],
1707
1722
  "previews": [
1708
1723
  {
@@ -2908,20 +2923,57 @@
2908
2923
  ],
2909
2924
  "slots": [
2910
2925
  {
2911
- "name": "groups",
2912
- "description": "Groups. Each group is a list of links and an optional heading.",
2926
+ "name": "heading",
2927
+ "description": null,
2928
+ "parameters": [
2929
+
2930
+ ]
2931
+ },
2932
+ {
2933
+ "name": "items",
2934
+ "description": "Items.",
2913
2935
  "parameters": [
2914
2936
  {
2915
2937
  "name": "system_arguments",
2916
2938
  "type": "Hash",
2917
2939
  "default": "N/A",
2918
- "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Group{{/link_to_component}}."
2940
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
2919
2941
  }
2920
2942
  ]
2921
2943
  }
2922
2944
  ],
2923
2945
  "methods": [
2946
+ {
2947
+ "name": "with_group",
2948
+ "description": "Groups. Each group is a list of links and a (required) heading.",
2949
+ "parameters": [
2950
+ {
2951
+ "name": "system_arguments",
2952
+ "type": "Hash",
2953
+ "default": "N/A",
2954
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Group{{/link_to_component}}."
2955
+ }
2956
+ ]
2957
+ },
2958
+ {
2959
+ "name": "with_divider",
2960
+ "description": "Adds a divider to the list of items.",
2961
+ "parameters": [
2962
+ {
2963
+ "name": "system_arguments",
2964
+ "type": "Hash",
2965
+ "default": "N/A",
2966
+ "description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Divider{{/link_to_component}}."
2967
+ }
2968
+ ]
2969
+ },
2970
+ {
2971
+ "name": "render_outer_list?",
2972
+ "description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
2973
+ "parameters": [
2924
2974
 
2975
+ ]
2976
+ }
2925
2977
  ],
2926
2978
  "previews": [
2927
2979
  {
@@ -2934,6 +2986,11 @@
2934
2986
  "preview_path": "/lookbook/preview/primer/alpha/nav_list/default",
2935
2987
  "name": "default"
2936
2988
  },
2989
+ {
2990
+ "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/top_level_items",
2991
+ "preview_path": "/lookbook/preview/primer/alpha/nav_list/top_level_items",
2992
+ "name": "top_level_items"
2993
+ },
2937
2994
  {
2938
2995
  "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/show_more_item",
2939
2996
  "preview_path": "/lookbook/preview/primer/alpha/nav_list/show_more_item",
@@ -3096,6 +3153,42 @@
3096
3153
 
3097
3154
  ]
3098
3155
  },
3156
+ {
3157
+ "fully_qualified_name": "Primer::Alpha::NavList::Divider",
3158
+ "description": "Separator with optional text rendered above groups or between individual items.",
3159
+ "component": "NavList::Divider",
3160
+ "status": "alpha",
3161
+ "a11y_reviewed": false,
3162
+ "short_name": "NavListDivider",
3163
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
3164
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
3165
+ "parameters": [
3166
+ {
3167
+ "name": "scheme",
3168
+ "type": "Symbol",
3169
+ "default": "`:subtle`",
3170
+ "description": "Display a background color if scheme is `filled`."
3171
+ },
3172
+ {
3173
+ "name": "system_arguments",
3174
+ "type": "Hash",
3175
+ "default": "N/A",
3176
+ "description": "{{link_to_system_arguments_docs}}"
3177
+ }
3178
+ ],
3179
+ "slots": [
3180
+
3181
+ ],
3182
+ "methods": [
3183
+
3184
+ ],
3185
+ "previews": [
3186
+
3187
+ ],
3188
+ "subcomponents": [
3189
+
3190
+ ]
3191
+ },
3099
3192
  {
3100
3193
  "fully_qualified_name": "Primer::Alpha::NavList::Group",
3101
3194
  "description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
@@ -3552,6 +3645,11 @@
3552
3645
  "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page",
3553
3646
  "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page",
3554
3647
  "name": "middle_of_page"
3648
+ },
3649
+ {
3650
+ "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page_with_relative_container",
3651
+ "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page_with_relative_container",
3652
+ "name": "middle_of_page_with_relative_container"
3555
3653
  }
3556
3654
  ],
3557
3655
  "subcomponents": [
@@ -3575,7 +3673,13 @@
3575
3673
  "name": "subtitle",
3576
3674
  "type": "String",
3577
3675
  "default": "`nil`",
3578
- "description": "Provides dditional context for the Overlay, also setting the `aria-describedby` attribute."
3676
+ "description": "Provides additional context for the Overlay, also setting the `aria-describedby` attribute."
3677
+ },
3678
+ {
3679
+ "name": "overlay_id",
3680
+ "type": "String",
3681
+ "default": "`nil`",
3682
+ "description": "Provides the id of the overlay element so the close button can close it"
3579
3683
  },
3580
3684
  {
3581
3685
  "name": "size",
@@ -1351,6 +1351,11 @@
1351
1351
  "preview_path": "/lookbook/preview/primer/alpha/nav_list/default",
1352
1352
  "name": "default"
1353
1353
  },
1354
+ {
1355
+ "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/top_level_items",
1356
+ "preview_path": "/lookbook/preview/primer/alpha/nav_list/top_level_items",
1357
+ "name": "top_level_items"
1358
+ },
1354
1359
  {
1355
1360
  "inspect_path": "/lookbook/inspect/primer/alpha/nav_list/show_more_item",
1356
1361
  "preview_path": "/lookbook/preview/primer/alpha/nav_list/show_more_item",
@@ -1406,6 +1411,11 @@
1406
1411
  "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page",
1407
1412
  "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page",
1408
1413
  "name": "middle_of_page"
1414
+ },
1415
+ {
1416
+ "inspect_path": "/lookbook/inspect/primer/alpha/overlay/middle_of_page_with_relative_container",
1417
+ "preview_path": "/lookbook/preview/primer/alpha/overlay/middle_of_page_with_relative_container",
1418
+ "name": "middle_of_page_with_relative_container"
1409
1419
  }
1410
1420
  ]
1411
1421
  },
@@ -31,6 +31,7 @@
31
31
  "Primer::Alpha::Menu": "alpha",
32
32
  "Primer::Alpha::MultiInput": "alpha",
33
33
  "Primer::Alpha::NavList": "alpha",
34
+ "Primer::Alpha::NavList::Divider": "alpha",
34
35
  "Primer::Alpha::NavList::Group": "alpha",
35
36
  "Primer::Alpha::NavList::Item": "alpha",
36
37
  "Primer::Alpha::Navigation::Tab": "alpha",