@primer/view-components 0.6.0-rc.b9e3d3e2 → 0.6.0-rc.c042fbe7

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.
@@ -125,17 +125,17 @@
125
125
  ],
126
126
  "subcomponents": [
127
127
  {
128
- "fully_qualified_name": "Primer::Alpha::ActionBar::Item",
128
+ "fully_qualified_name": "Primer::Alpha::ActionBar::Divider",
129
129
  "description": "ActionBar::Item is an internal component that wraps the items in a div with the `ActionBar-item` class.",
130
130
  "is_form_component": false,
131
131
  "is_published": true,
132
132
  "requires_js": false,
133
- "component": "ActionBar::Item",
133
+ "component": "ActionBar::Divider",
134
134
  "status": "alpha",
135
135
  "a11y_reviewed": false,
136
- "short_name": "ActionBarItem",
137
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/item.rb",
138
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/item/default/",
136
+ "short_name": "ActionBarDivider",
137
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/divider.rb",
138
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/divider/default/",
139
139
  "parameters": [
140
140
 
141
141
  ],
@@ -153,17 +153,17 @@
153
153
  ]
154
154
  },
155
155
  {
156
- "fully_qualified_name": "Primer::Alpha::ActionBar::Divider",
156
+ "fully_qualified_name": "Primer::Alpha::ActionBar::Item",
157
157
  "description": "ActionBar::Item is an internal component that wraps the items in a div with the `ActionBar-item` class.",
158
158
  "is_form_component": false,
159
159
  "is_published": true,
160
160
  "requires_js": false,
161
- "component": "ActionBar::Divider",
161
+ "component": "ActionBar::Item",
162
162
  "status": "alpha",
163
163
  "a11y_reviewed": false,
164
- "short_name": "ActionBarDivider",
165
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/divider.rb",
166
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/divider/default/",
164
+ "short_name": "ActionBarItem",
165
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/item.rb",
166
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/item/default/",
167
167
  "parameters": [
168
168
 
169
169
  ],
@@ -728,6 +728,143 @@
728
728
  }
729
729
  ],
730
730
  "subcomponents": [
731
+ {
732
+ "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
733
+ "description": "Separator with optional text rendered above groups or between individual items.",
734
+ "is_form_component": false,
735
+ "is_published": true,
736
+ "requires_js": false,
737
+ "component": "ActionList::Divider",
738
+ "status": "alpha",
739
+ "a11y_reviewed": false,
740
+ "short_name": "ActionListDivider",
741
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
742
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
743
+ "parameters": [
744
+ {
745
+ "name": "scheme",
746
+ "type": "Symbol",
747
+ "default": "`:subtle`",
748
+ "description": "Display a background color if scheme is `filled`."
749
+ },
750
+ {
751
+ "name": "system_arguments",
752
+ "type": "Hash",
753
+ "default": "N/A",
754
+ "description": "{{link_to_system_arguments_docs}}"
755
+ }
756
+ ],
757
+ "slots": [
758
+
759
+ ],
760
+ "methods": [
761
+
762
+ ],
763
+ "previews": [
764
+
765
+ ],
766
+ "subcomponents": [
767
+
768
+ ]
769
+ },
770
+ {
771
+ "fully_qualified_name": "Primer::Alpha::ActionList::Heading",
772
+ "description": "Heading used to describe each sub list within an action list.",
773
+ "is_form_component": false,
774
+ "is_published": true,
775
+ "requires_js": false,
776
+ "component": "ActionList::Heading",
777
+ "status": "alpha",
778
+ "a11y_reviewed": false,
779
+ "short_name": "ActionListHeading",
780
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
781
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
782
+ "parameters": [
783
+ {
784
+ "name": "title",
785
+ "type": "String",
786
+ "default": "N/A",
787
+ "description": "Sub list title."
788
+ },
789
+ {
790
+ "name": "heading_level",
791
+ "type": "Integer",
792
+ "default": "`3`",
793
+ "description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
794
+ },
795
+ {
796
+ "name": "subtitle",
797
+ "type": "String",
798
+ "default": "`nil`",
799
+ "description": "Optional sub list description."
800
+ },
801
+ {
802
+ "name": "scheme",
803
+ "type": "Symbol",
804
+ "default": "`:subtle`",
805
+ "description": "Display a background color if scheme is `filled`."
806
+ },
807
+ {
808
+ "name": "system_arguments",
809
+ "type": "Hash",
810
+ "default": "N/A",
811
+ "description": "{{link_to_system_arguments_docs}}"
812
+ }
813
+ ],
814
+ "slots": [
815
+
816
+ ],
817
+ "methods": [
818
+ {
819
+ "name": "title_id",
820
+ "description": "Returns the value of attribute title_id.",
821
+ "parameters": [
822
+
823
+ ]
824
+ },
825
+ {
826
+ "name": "subtitle_id",
827
+ "description": "Returns the value of attribute subtitle_id.",
828
+ "parameters": [
829
+
830
+ ]
831
+ }
832
+ ],
833
+ "previews": [
834
+
835
+ ],
836
+ "subcomponents": [
837
+
838
+ ]
839
+ },
840
+ {
841
+ "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
842
+ "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
843
+ "is_form_component": false,
844
+ "is_published": true,
845
+ "requires_js": false,
846
+ "component": "ActionList::FormWrapper",
847
+ "status": "alpha",
848
+ "a11y_reviewed": false,
849
+ "short_name": "ActionListFormWrapper",
850
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
851
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
852
+ "parameters": [
853
+
854
+ ],
855
+ "slots": [
856
+
857
+ ],
858
+ "methods": [
859
+
860
+ ],
861
+ "previews": [
862
+
863
+ ],
864
+ "subcomponents": [
865
+
866
+ ]
867
+ },
731
868
  {
732
869
  "fully_qualified_name": "Primer::Alpha::ActionList::Item",
733
870
  "description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.",
@@ -966,143 +1103,6 @@
966
1103
  ],
967
1104
  "subcomponents": [
968
1105
 
969
- ]
970
- },
971
- {
972
- "fully_qualified_name": "Primer::Alpha::ActionList::Heading",
973
- "description": "Heading used to describe each sub list within an action list.",
974
- "is_form_component": false,
975
- "is_published": true,
976
- "requires_js": false,
977
- "component": "ActionList::Heading",
978
- "status": "alpha",
979
- "a11y_reviewed": false,
980
- "short_name": "ActionListHeading",
981
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
982
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
983
- "parameters": [
984
- {
985
- "name": "title",
986
- "type": "String",
987
- "default": "N/A",
988
- "description": "Sub list title."
989
- },
990
- {
991
- "name": "heading_level",
992
- "type": "Integer",
993
- "default": "`3`",
994
- "description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
995
- },
996
- {
997
- "name": "subtitle",
998
- "type": "String",
999
- "default": "`nil`",
1000
- "description": "Optional sub list description."
1001
- },
1002
- {
1003
- "name": "scheme",
1004
- "type": "Symbol",
1005
- "default": "`:subtle`",
1006
- "description": "Display a background color if scheme is `filled`."
1007
- },
1008
- {
1009
- "name": "system_arguments",
1010
- "type": "Hash",
1011
- "default": "N/A",
1012
- "description": "{{link_to_system_arguments_docs}}"
1013
- }
1014
- ],
1015
- "slots": [
1016
-
1017
- ],
1018
- "methods": [
1019
- {
1020
- "name": "title_id",
1021
- "description": "Returns the value of attribute title_id.",
1022
- "parameters": [
1023
-
1024
- ]
1025
- },
1026
- {
1027
- "name": "subtitle_id",
1028
- "description": "Returns the value of attribute subtitle_id.",
1029
- "parameters": [
1030
-
1031
- ]
1032
- }
1033
- ],
1034
- "previews": [
1035
-
1036
- ],
1037
- "subcomponents": [
1038
-
1039
- ]
1040
- },
1041
- {
1042
- "fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
1043
- "description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
1044
- "is_form_component": false,
1045
- "is_published": true,
1046
- "requires_js": false,
1047
- "component": "ActionList::FormWrapper",
1048
- "status": "alpha",
1049
- "a11y_reviewed": false,
1050
- "short_name": "ActionListFormWrapper",
1051
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
1052
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
1053
- "parameters": [
1054
-
1055
- ],
1056
- "slots": [
1057
-
1058
- ],
1059
- "methods": [
1060
-
1061
- ],
1062
- "previews": [
1063
-
1064
- ],
1065
- "subcomponents": [
1066
-
1067
- ]
1068
- },
1069
- {
1070
- "fully_qualified_name": "Primer::Alpha::ActionList::Divider",
1071
- "description": "Separator with optional text rendered above groups or between individual items.",
1072
- "is_form_component": false,
1073
- "is_published": true,
1074
- "requires_js": false,
1075
- "component": "ActionList::Divider",
1076
- "status": "alpha",
1077
- "a11y_reviewed": false,
1078
- "short_name": "ActionListDivider",
1079
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
1080
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
1081
- "parameters": [
1082
- {
1083
- "name": "scheme",
1084
- "type": "Symbol",
1085
- "default": "`:subtle`",
1086
- "description": "Display a background color if scheme is `filled`."
1087
- },
1088
- {
1089
- "name": "system_arguments",
1090
- "type": "Hash",
1091
- "default": "N/A",
1092
- "description": "{{link_to_system_arguments_docs}}"
1093
- }
1094
- ],
1095
- "slots": [
1096
-
1097
- ],
1098
- "methods": [
1099
-
1100
- ],
1101
- "previews": [
1102
-
1103
- ],
1104
- "subcomponents": [
1105
-
1106
1106
  ]
1107
1107
  }
1108
1108
  ]
@@ -2040,10 +2040,10 @@
2040
2040
  "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
2041
2041
  },
2042
2042
  {
2043
- "name": "dismiss_scheme",
2044
- "type": "Symbol",
2045
- "default": "`:none`",
2046
- "description": "Whether the component can be dismissed with an \"x\" button. One of `:hide`, `:none`, or `:remove`."
2043
+ "name": "dismissible",
2044
+ "type": "Boolean",
2045
+ "default": "`false`",
2046
+ "description": "Whether the component can be dismissed with an \"x\" button."
2047
2047
  },
2048
2048
  {
2049
2049
  "name": "description",
@@ -2063,6 +2063,12 @@
2063
2063
  "default": "`:default`",
2064
2064
  "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
2065
2065
  },
2066
+ {
2067
+ "name": "reappear",
2068
+ "type": "Boolean",
2069
+ "default": "`false`",
2070
+ "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
2071
+ },
2066
2072
  {
2067
2073
  "name": "system_arguments",
2068
2074
  "type": "Hash",
@@ -2162,8 +2168,8 @@
2162
2168
  }
2163
2169
  },
2164
2170
  {
2165
- "preview_path": "primer/alpha/banner/dismissible",
2166
- "name": "dismissible",
2171
+ "preview_path": "primer/alpha/banner/dismissable",
2172
+ "name": "dismissable",
2167
2173
  "snapshot": "true",
2168
2174
  "skip_rules": {
2169
2175
  "wont_fix": [
@@ -3044,41 +3050,23 @@
3044
3050
  ],
3045
3051
  "subcomponents": [
3046
3052
  {
3047
- "fully_qualified_name": "Primer::Alpha::Dialog::Header",
3048
- "description": "A `Dialog::Header` is a compositional component, used to render the\nHeader of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
3053
+ "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
3054
+ "description": "A `Dialog::Footer` is a compositional component, used to render the\nFooter of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
3049
3055
  "is_form_component": false,
3050
3056
  "is_published": true,
3051
3057
  "requires_js": false,
3052
- "component": "Dialog::Header",
3058
+ "component": "Dialog::Footer",
3053
3059
  "status": "alpha",
3054
3060
  "a11y_reviewed": true,
3055
- "short_name": "DialogHeader",
3056
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
3057
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
3061
+ "short_name": "DialogFooter",
3062
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
3063
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
3058
3064
  "parameters": [
3059
- {
3060
- "name": "title",
3061
- "type": "String",
3062
- "default": "N/A",
3063
- "description": "Describes the content of the dialog."
3064
- },
3065
- {
3066
- "name": "subtitle",
3067
- "type": "String",
3068
- "default": "`nil`",
3069
- "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
3070
- },
3071
3065
  {
3072
3066
  "name": "show_divider",
3073
3067
  "type": "Boolean",
3074
3068
  "default": "`false`",
3075
- "description": "Show a divider between the header and body."
3076
- },
3077
- {
3078
- "name": "visually_hide_title",
3079
- "type": "Boolean",
3080
- "default": "`false`",
3081
- "description": "Visually hide the `title` while maintaining a label for assistive technologies."
3069
+ "description": "Show a divider between the footer and body."
3082
3070
  },
3083
3071
  {
3084
3072
  "name": "system_arguments",
@@ -3101,24 +3089,18 @@
3101
3089
  ]
3102
3090
  },
3103
3091
  {
3104
- "fully_qualified_name": "Primer::Alpha::Dialog::Footer",
3105
- "description": "A `Dialog::Footer` is a compositional component, used to render the\nFooter of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
3092
+ "fully_qualified_name": "Primer::Alpha::Dialog::Body",
3093
+ "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
3106
3094
  "is_form_component": false,
3107
3095
  "is_published": true,
3108
3096
  "requires_js": false,
3109
- "component": "Dialog::Footer",
3097
+ "component": "Dialog::Body",
3110
3098
  "status": "alpha",
3111
3099
  "a11y_reviewed": true,
3112
- "short_name": "DialogFooter",
3113
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
3114
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
3100
+ "short_name": "DialogBody",
3101
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
3102
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
3115
3103
  "parameters": [
3116
- {
3117
- "name": "show_divider",
3118
- "type": "Boolean",
3119
- "default": "`false`",
3120
- "description": "Show a divider between the footer and body."
3121
- },
3122
3104
  {
3123
3105
  "name": "system_arguments",
3124
3106
  "type": "Hash",
@@ -3140,18 +3122,42 @@
3140
3122
  ]
3141
3123
  },
3142
3124
  {
3143
- "fully_qualified_name": "Primer::Alpha::Dialog::Body",
3144
- "description": "A `Dialog::Body` is a compositional component, used to render the\nBody of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
3125
+ "fully_qualified_name": "Primer::Alpha::Dialog::Header",
3126
+ "description": "A `Dialog::Header` is a compositional component, used to render the\nHeader of a dialog. See {{#link_to_component}}Primer::Alpha::Dialog{{/link_to_component}}.",
3145
3127
  "is_form_component": false,
3146
3128
  "is_published": true,
3147
3129
  "requires_js": false,
3148
- "component": "Dialog::Body",
3130
+ "component": "Dialog::Header",
3149
3131
  "status": "alpha",
3150
3132
  "a11y_reviewed": true,
3151
- "short_name": "DialogBody",
3152
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
3153
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
3133
+ "short_name": "DialogHeader",
3134
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
3135
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
3154
3136
  "parameters": [
3137
+ {
3138
+ "name": "title",
3139
+ "type": "String",
3140
+ "default": "N/A",
3141
+ "description": "Describes the content of the dialog."
3142
+ },
3143
+ {
3144
+ "name": "subtitle",
3145
+ "type": "String",
3146
+ "default": "`nil`",
3147
+ "description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
3148
+ },
3149
+ {
3150
+ "name": "show_divider",
3151
+ "type": "Boolean",
3152
+ "default": "`false`",
3153
+ "description": "Show a divider between the header and body."
3154
+ },
3155
+ {
3156
+ "name": "visually_hide_title",
3157
+ "type": "Boolean",
3158
+ "default": "`false`",
3159
+ "description": "Visually hide the `title` while maintaining a label for assistive technologies."
3160
+ },
3155
3161
  {
3156
3162
  "name": "system_arguments",
3157
3163
  "type": "Hash",
@@ -5084,6 +5090,45 @@
5084
5090
  }
5085
5091
  ],
5086
5092
  "subcomponents": [
5093
+ {
5094
+ "fully_qualified_name": "Primer::Alpha::NavList::Divider",
5095
+ "description": "Separator with optional text rendered above groups or between individual items.",
5096
+ "is_form_component": false,
5097
+ "is_published": true,
5098
+ "requires_js": false,
5099
+ "component": "NavList::Divider",
5100
+ "status": "alpha",
5101
+ "a11y_reviewed": false,
5102
+ "short_name": "NavListDivider",
5103
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
5104
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
5105
+ "parameters": [
5106
+ {
5107
+ "name": "scheme",
5108
+ "type": "Symbol",
5109
+ "default": "`:subtle`",
5110
+ "description": "Display a background color if scheme is `filled`."
5111
+ },
5112
+ {
5113
+ "name": "system_arguments",
5114
+ "type": "Hash",
5115
+ "default": "N/A",
5116
+ "description": "{{link_to_system_arguments_docs}}"
5117
+ }
5118
+ ],
5119
+ "slots": [
5120
+
5121
+ ],
5122
+ "methods": [
5123
+
5124
+ ],
5125
+ "previews": [
5126
+
5127
+ ],
5128
+ "subcomponents": [
5129
+
5130
+ ]
5131
+ },
5087
5132
  {
5088
5133
  "fully_qualified_name": "Primer::Alpha::NavList::Heading",
5089
5134
  "description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
@@ -5315,45 +5360,6 @@
5315
5360
 
5316
5361
  ]
5317
5362
  },
5318
- {
5319
- "fully_qualified_name": "Primer::Alpha::NavList::Divider",
5320
- "description": "Separator with optional text rendered above groups or between individual items.",
5321
- "is_form_component": false,
5322
- "is_published": true,
5323
- "requires_js": false,
5324
- "component": "NavList::Divider",
5325
- "status": "alpha",
5326
- "a11y_reviewed": false,
5327
- "short_name": "NavListDivider",
5328
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
5329
- "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
5330
- "parameters": [
5331
- {
5332
- "name": "scheme",
5333
- "type": "Symbol",
5334
- "default": "`:subtle`",
5335
- "description": "Display a background color if scheme is `filled`."
5336
- },
5337
- {
5338
- "name": "system_arguments",
5339
- "type": "Hash",
5340
- "default": "N/A",
5341
- "description": "{{link_to_system_arguments_docs}}"
5342
- }
5343
- ],
5344
- "slots": [
5345
-
5346
- ],
5347
- "methods": [
5348
-
5349
- ],
5350
- "previews": [
5351
-
5352
- ],
5353
- "subcomponents": [
5354
-
5355
- ]
5356
- },
5357
5363
  {
5358
5364
  "fully_qualified_name": "Primer::Alpha::NavList::Group",
5359
5365
  "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.",
@@ -1414,8 +1414,8 @@
1414
1414
  }
1415
1415
  },
1416
1416
  {
1417
- "preview_path": "primer/alpha/banner/dismissible",
1418
- "name": "dismissible",
1417
+ "preview_path": "primer/alpha/banner/dismissable",
1418
+ "name": "dismissable",
1419
1419
  "snapshot": "true",
1420
1420
  "skip_rules": {
1421
1421
  "wont_fix": [