@primer/view-components 0.10.0-rc.a91a254c → 0.10.0-rc.abb11b6b
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/app/assets/javascripts/primer_view_components.js +1 -1
- package/app/assets/javascripts/primer_view_components.js.map +1 -1
- package/app/assets/styles/primer_view_components.css +1 -1
- package/app/assets/styles/primer_view_components.css.map +1 -1
- package/app/components/primer/alpha/overlay.css +1 -1
- package/app/components/primer/beta/link.css +1 -1
- package/app/components/primer/beta/link.css.json +1 -0
- package/package.json +3 -3
- package/static/arguments.json +1 -1
- package/static/classes.json +3 -0
- package/static/info_arch.json +609 -609
package/static/info_arch.json
CHANGED
@@ -732,146 +732,6 @@
|
|
732
732
|
}
|
733
733
|
],
|
734
734
|
"subcomponents": [
|
735
|
-
{
|
736
|
-
"fully_qualified_name": "Primer::Alpha::ActionList::Divider",
|
737
|
-
"description": "Separator with optional text rendered above groups or between individual items.",
|
738
|
-
"accessibility_docs": null,
|
739
|
-
"is_form_component": false,
|
740
|
-
"is_published": true,
|
741
|
-
"requires_js": false,
|
742
|
-
"component": "ActionList::Divider",
|
743
|
-
"status": "alpha",
|
744
|
-
"a11y_reviewed": false,
|
745
|
-
"short_name": "ActionListDivider",
|
746
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
|
747
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
|
748
|
-
"parameters": [
|
749
|
-
{
|
750
|
-
"name": "scheme",
|
751
|
-
"type": "Symbol",
|
752
|
-
"default": "`:subtle`",
|
753
|
-
"description": "Display a background color if scheme is `filled`."
|
754
|
-
},
|
755
|
-
{
|
756
|
-
"name": "system_arguments",
|
757
|
-
"type": "Hash",
|
758
|
-
"default": "N/A",
|
759
|
-
"description": "{{link_to_system_arguments_docs}}"
|
760
|
-
}
|
761
|
-
],
|
762
|
-
"slots": [
|
763
|
-
|
764
|
-
],
|
765
|
-
"methods": [
|
766
|
-
|
767
|
-
],
|
768
|
-
"previews": [
|
769
|
-
|
770
|
-
],
|
771
|
-
"subcomponents": [
|
772
|
-
|
773
|
-
]
|
774
|
-
},
|
775
|
-
{
|
776
|
-
"fully_qualified_name": "Primer::Alpha::ActionList::Heading",
|
777
|
-
"description": "Heading used to describe each sub list within an action list.",
|
778
|
-
"accessibility_docs": null,
|
779
|
-
"is_form_component": false,
|
780
|
-
"is_published": true,
|
781
|
-
"requires_js": false,
|
782
|
-
"component": "ActionList::Heading",
|
783
|
-
"status": "alpha",
|
784
|
-
"a11y_reviewed": false,
|
785
|
-
"short_name": "ActionListHeading",
|
786
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
|
787
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
|
788
|
-
"parameters": [
|
789
|
-
{
|
790
|
-
"name": "title",
|
791
|
-
"type": "String",
|
792
|
-
"default": "N/A",
|
793
|
-
"description": "Sub list title."
|
794
|
-
},
|
795
|
-
{
|
796
|
-
"name": "heading_level",
|
797
|
-
"type": "Integer",
|
798
|
-
"default": "`3`",
|
799
|
-
"description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
|
800
|
-
},
|
801
|
-
{
|
802
|
-
"name": "subtitle",
|
803
|
-
"type": "String",
|
804
|
-
"default": "`nil`",
|
805
|
-
"description": "Optional sub list description."
|
806
|
-
},
|
807
|
-
{
|
808
|
-
"name": "scheme",
|
809
|
-
"type": "Symbol",
|
810
|
-
"default": "`:subtle`",
|
811
|
-
"description": "Display a background color if scheme is `filled`."
|
812
|
-
},
|
813
|
-
{
|
814
|
-
"name": "system_arguments",
|
815
|
-
"type": "Hash",
|
816
|
-
"default": "N/A",
|
817
|
-
"description": "{{link_to_system_arguments_docs}}"
|
818
|
-
}
|
819
|
-
],
|
820
|
-
"slots": [
|
821
|
-
|
822
|
-
],
|
823
|
-
"methods": [
|
824
|
-
{
|
825
|
-
"name": "title_id",
|
826
|
-
"description": "Returns the value of attribute title_id.",
|
827
|
-
"parameters": [
|
828
|
-
|
829
|
-
]
|
830
|
-
},
|
831
|
-
{
|
832
|
-
"name": "subtitle_id",
|
833
|
-
"description": "Returns the value of attribute subtitle_id.",
|
834
|
-
"parameters": [
|
835
|
-
|
836
|
-
]
|
837
|
-
}
|
838
|
-
],
|
839
|
-
"previews": [
|
840
|
-
|
841
|
-
],
|
842
|
-
"subcomponents": [
|
843
|
-
|
844
|
-
]
|
845
|
-
},
|
846
|
-
{
|
847
|
-
"fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
|
848
|
-
"description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
|
849
|
-
"accessibility_docs": null,
|
850
|
-
"is_form_component": false,
|
851
|
-
"is_published": true,
|
852
|
-
"requires_js": false,
|
853
|
-
"component": "ActionList::FormWrapper",
|
854
|
-
"status": "alpha",
|
855
|
-
"a11y_reviewed": false,
|
856
|
-
"short_name": "ActionListFormWrapper",
|
857
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
|
858
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
|
859
|
-
"parameters": [
|
860
|
-
|
861
|
-
],
|
862
|
-
"slots": [
|
863
|
-
|
864
|
-
],
|
865
|
-
"methods": [
|
866
|
-
|
867
|
-
],
|
868
|
-
"previews": [
|
869
|
-
|
870
|
-
],
|
871
|
-
"subcomponents": [
|
872
|
-
|
873
|
-
]
|
874
|
-
},
|
875
735
|
{
|
876
736
|
"fully_qualified_name": "Primer::Alpha::ActionList::Item",
|
877
737
|
"description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.",
|
@@ -1112,112 +972,252 @@
|
|
1112
972
|
"subcomponents": [
|
1113
973
|
|
1114
974
|
]
|
1115
|
-
}
|
1116
|
-
]
|
1117
|
-
},
|
1118
|
-
{
|
1119
|
-
"fully_qualified_name": "Primer::Alpha::ActionMenu",
|
1120
|
-
"description": "ActionMenu is used for actions, navigation, to display secondary options, or single/multi select lists. They appear when users interact with buttons, actions, or other controls.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. The default is `:button`.",
|
1121
|
-
"accessibility_docs": "The action for the menu item needs to be on the element with `role=\"menuitem\"`. Semantics are removed for everything nested inside of it. When a menu item is selected, the menu will close immediately.\n\nAdditional information around the keyboard functionality and implementation can be found on the [WAI-ARIA Authoring Practices](https://www.w3.org/TR/wai-aria-practices-1.2/#menu).",
|
1122
|
-
"is_form_component": false,
|
1123
|
-
"is_published": true,
|
1124
|
-
"requires_js": true,
|
1125
|
-
"component": "ActionMenu",
|
1126
|
-
"status": "alpha",
|
1127
|
-
"a11y_reviewed": false,
|
1128
|
-
"short_name": "ActionMenu",
|
1129
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb",
|
1130
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/",
|
1131
|
-
"parameters": [
|
1132
|
-
{
|
1133
|
-
"name": "menu_id",
|
1134
|
-
"type": "String",
|
1135
|
-
"default": "`self.class.generate_id`",
|
1136
|
-
"description": "Id of the menu."
|
1137
|
-
},
|
1138
|
-
{
|
1139
|
-
"name": "anchor_align",
|
1140
|
-
"type": "Symbol",
|
1141
|
-
"default": "`:start`",
|
1142
|
-
"description": "One of `:center`, `:end`, or `:start`.."
|
1143
|
-
},
|
1144
|
-
{
|
1145
|
-
"name": "anchor_side",
|
1146
|
-
"type": "Symbol",
|
1147
|
-
"default": "`:outside_bottom`",
|
1148
|
-
"description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.."
|
1149
|
-
},
|
1150
|
-
{
|
1151
|
-
"name": "size",
|
1152
|
-
"type": "Symbol",
|
1153
|
-
"default": "`:auto`",
|
1154
|
-
"description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
|
1155
|
-
},
|
1156
|
-
{
|
1157
|
-
"name": "src",
|
1158
|
-
"type": "String",
|
1159
|
-
"default": "`nil`",
|
1160
|
-
"description": "Used with an `include-fragment` element to load menu content from the given source URL."
|
1161
|
-
},
|
1162
|
-
{
|
1163
|
-
"name": "preload",
|
1164
|
-
"type": "Boolean",
|
1165
|
-
"default": "`false`",
|
1166
|
-
"description": "When true, and src is present, loads the `include-fragment` on trigger hover."
|
1167
975
|
},
|
1168
976
|
{
|
1169
|
-
"
|
1170
|
-
"
|
1171
|
-
"
|
1172
|
-
"
|
1173
|
-
|
1174
|
-
|
1175
|
-
"
|
1176
|
-
"
|
1177
|
-
"
|
1178
|
-
"
|
1179
|
-
|
1180
|
-
|
1181
|
-
"name": "select_variant",
|
1182
|
-
"type": "Symbol",
|
1183
|
-
"default": "`:none`",
|
1184
|
-
"description": "One of `:multiple`, `:none`, or `:single`."
|
1185
|
-
},
|
1186
|
-
{
|
1187
|
-
"name": "form_arguments",
|
1188
|
-
"type": "Hash",
|
1189
|
-
"default": "`{}`",
|
1190
|
-
"description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission."
|
1191
|
-
},
|
1192
|
-
{
|
1193
|
-
"name": "system_arguments",
|
1194
|
-
"type": "Hash",
|
1195
|
-
"default": "N/A",
|
1196
|
-
"description": "{{link_to_system_arguments_docs}}."
|
1197
|
-
}
|
1198
|
-
],
|
1199
|
-
"slots": [
|
1200
|
-
{
|
1201
|
-
"name": "show_button",
|
1202
|
-
"description": "Button to activate the menu.",
|
977
|
+
"fully_qualified_name": "Primer::Alpha::ActionList::Heading",
|
978
|
+
"description": "Heading used to describe each sub list within an action list.",
|
979
|
+
"accessibility_docs": null,
|
980
|
+
"is_form_component": false,
|
981
|
+
"is_published": true,
|
982
|
+
"requires_js": false,
|
983
|
+
"component": "ActionList::Heading",
|
984
|
+
"status": "alpha",
|
985
|
+
"a11y_reviewed": false,
|
986
|
+
"short_name": "ActionListHeading",
|
987
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
|
988
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
|
1203
989
|
"parameters": [
|
1204
990
|
{
|
1205
|
-
"name": "
|
1206
|
-
"type": "
|
991
|
+
"name": "title",
|
992
|
+
"type": "String",
|
1207
993
|
"default": "N/A",
|
1208
|
-
"description": "
|
1209
|
-
}
|
1210
|
-
]
|
1211
|
-
},
|
1212
|
-
{
|
1213
|
-
"name": "items",
|
1214
|
-
"description": "Adds a new item to the list.",
|
1215
|
-
"parameters": [
|
994
|
+
"description": "Sub list title."
|
995
|
+
},
|
1216
996
|
{
|
1217
|
-
"name": "
|
1218
|
-
"type": "
|
1219
|
-
"default": "
|
1220
|
-
"description": "
|
997
|
+
"name": "heading_level",
|
998
|
+
"type": "Integer",
|
999
|
+
"default": "`3`",
|
1000
|
+
"description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
|
1001
|
+
},
|
1002
|
+
{
|
1003
|
+
"name": "subtitle",
|
1004
|
+
"type": "String",
|
1005
|
+
"default": "`nil`",
|
1006
|
+
"description": "Optional sub list description."
|
1007
|
+
},
|
1008
|
+
{
|
1009
|
+
"name": "scheme",
|
1010
|
+
"type": "Symbol",
|
1011
|
+
"default": "`:subtle`",
|
1012
|
+
"description": "Display a background color if scheme is `filled`."
|
1013
|
+
},
|
1014
|
+
{
|
1015
|
+
"name": "system_arguments",
|
1016
|
+
"type": "Hash",
|
1017
|
+
"default": "N/A",
|
1018
|
+
"description": "{{link_to_system_arguments_docs}}"
|
1019
|
+
}
|
1020
|
+
],
|
1021
|
+
"slots": [
|
1022
|
+
|
1023
|
+
],
|
1024
|
+
"methods": [
|
1025
|
+
{
|
1026
|
+
"name": "title_id",
|
1027
|
+
"description": "Returns the value of attribute title_id.",
|
1028
|
+
"parameters": [
|
1029
|
+
|
1030
|
+
]
|
1031
|
+
},
|
1032
|
+
{
|
1033
|
+
"name": "subtitle_id",
|
1034
|
+
"description": "Returns the value of attribute subtitle_id.",
|
1035
|
+
"parameters": [
|
1036
|
+
|
1037
|
+
]
|
1038
|
+
}
|
1039
|
+
],
|
1040
|
+
"previews": [
|
1041
|
+
|
1042
|
+
],
|
1043
|
+
"subcomponents": [
|
1044
|
+
|
1045
|
+
]
|
1046
|
+
},
|
1047
|
+
{
|
1048
|
+
"fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
|
1049
|
+
"description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
|
1050
|
+
"accessibility_docs": null,
|
1051
|
+
"is_form_component": false,
|
1052
|
+
"is_published": true,
|
1053
|
+
"requires_js": false,
|
1054
|
+
"component": "ActionList::FormWrapper",
|
1055
|
+
"status": "alpha",
|
1056
|
+
"a11y_reviewed": false,
|
1057
|
+
"short_name": "ActionListFormWrapper",
|
1058
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
|
1059
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
|
1060
|
+
"parameters": [
|
1061
|
+
|
1062
|
+
],
|
1063
|
+
"slots": [
|
1064
|
+
|
1065
|
+
],
|
1066
|
+
"methods": [
|
1067
|
+
|
1068
|
+
],
|
1069
|
+
"previews": [
|
1070
|
+
|
1071
|
+
],
|
1072
|
+
"subcomponents": [
|
1073
|
+
|
1074
|
+
]
|
1075
|
+
},
|
1076
|
+
{
|
1077
|
+
"fully_qualified_name": "Primer::Alpha::ActionList::Divider",
|
1078
|
+
"description": "Separator with optional text rendered above groups or between individual items.",
|
1079
|
+
"accessibility_docs": null,
|
1080
|
+
"is_form_component": false,
|
1081
|
+
"is_published": true,
|
1082
|
+
"requires_js": false,
|
1083
|
+
"component": "ActionList::Divider",
|
1084
|
+
"status": "alpha",
|
1085
|
+
"a11y_reviewed": false,
|
1086
|
+
"short_name": "ActionListDivider",
|
1087
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
|
1088
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
|
1089
|
+
"parameters": [
|
1090
|
+
{
|
1091
|
+
"name": "scheme",
|
1092
|
+
"type": "Symbol",
|
1093
|
+
"default": "`:subtle`",
|
1094
|
+
"description": "Display a background color if scheme is `filled`."
|
1095
|
+
},
|
1096
|
+
{
|
1097
|
+
"name": "system_arguments",
|
1098
|
+
"type": "Hash",
|
1099
|
+
"default": "N/A",
|
1100
|
+
"description": "{{link_to_system_arguments_docs}}"
|
1101
|
+
}
|
1102
|
+
],
|
1103
|
+
"slots": [
|
1104
|
+
|
1105
|
+
],
|
1106
|
+
"methods": [
|
1107
|
+
|
1108
|
+
],
|
1109
|
+
"previews": [
|
1110
|
+
|
1111
|
+
],
|
1112
|
+
"subcomponents": [
|
1113
|
+
|
1114
|
+
]
|
1115
|
+
}
|
1116
|
+
]
|
1117
|
+
},
|
1118
|
+
{
|
1119
|
+
"fully_qualified_name": "Primer::Alpha::ActionMenu",
|
1120
|
+
"description": "ActionMenu is used for actions, navigation, to display secondary options, or single/multi select lists. They appear when users interact with buttons, actions, or other controls.\n\nThe only allowed elements for the `Item` components are: `:a`, `:button`, and `:clipboard-copy`. The default is `:button`.",
|
1121
|
+
"accessibility_docs": "The action for the menu item needs to be on the element with `role=\"menuitem\"`. Semantics are removed for everything nested inside of it. When a menu item is selected, the menu will close immediately.\n\nAdditional information around the keyboard functionality and implementation can be found on the [WAI-ARIA Authoring Practices](https://www.w3.org/TR/wai-aria-practices-1.2/#menu).",
|
1122
|
+
"is_form_component": false,
|
1123
|
+
"is_published": true,
|
1124
|
+
"requires_js": true,
|
1125
|
+
"component": "ActionMenu",
|
1126
|
+
"status": "alpha",
|
1127
|
+
"a11y_reviewed": false,
|
1128
|
+
"short_name": "ActionMenu",
|
1129
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_menu.rb",
|
1130
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_menu/default/",
|
1131
|
+
"parameters": [
|
1132
|
+
{
|
1133
|
+
"name": "menu_id",
|
1134
|
+
"type": "String",
|
1135
|
+
"default": "`self.class.generate_id`",
|
1136
|
+
"description": "Id of the menu."
|
1137
|
+
},
|
1138
|
+
{
|
1139
|
+
"name": "anchor_align",
|
1140
|
+
"type": "Symbol",
|
1141
|
+
"default": "`:start`",
|
1142
|
+
"description": "One of `:center`, `:end`, or `:start`.."
|
1143
|
+
},
|
1144
|
+
{
|
1145
|
+
"name": "anchor_side",
|
1146
|
+
"type": "Symbol",
|
1147
|
+
"default": "`:outside_bottom`",
|
1148
|
+
"description": "One of `:inside_bottom`, `:inside_center`, `:inside_left`, `:inside_right`, `:inside_top`, `:outside_bottom`, `:outside_left`, `:outside_right`, or `:outside_top`.."
|
1149
|
+
},
|
1150
|
+
{
|
1151
|
+
"name": "size",
|
1152
|
+
"type": "Symbol",
|
1153
|
+
"default": "`:auto`",
|
1154
|
+
"description": "One of `:auto`, `:large`, `:medium`, `:medium_portrait`, `:small`, or `:xlarge`.."
|
1155
|
+
},
|
1156
|
+
{
|
1157
|
+
"name": "src",
|
1158
|
+
"type": "String",
|
1159
|
+
"default": "`nil`",
|
1160
|
+
"description": "Used with an `include-fragment` element to load menu content from the given source URL."
|
1161
|
+
},
|
1162
|
+
{
|
1163
|
+
"name": "preload",
|
1164
|
+
"type": "Boolean",
|
1165
|
+
"default": "`false`",
|
1166
|
+
"description": "When true, and src is present, loads the `include-fragment` on trigger hover."
|
1167
|
+
},
|
1168
|
+
{
|
1169
|
+
"name": "dynamic_label",
|
1170
|
+
"type": "Boolean",
|
1171
|
+
"default": "`false`",
|
1172
|
+
"description": "Whether or not to display the text of the currently selected item in the show button."
|
1173
|
+
},
|
1174
|
+
{
|
1175
|
+
"name": "dynamic_label_prefix",
|
1176
|
+
"type": "String",
|
1177
|
+
"default": "`nil`",
|
1178
|
+
"description": "If provided, the prefix is prepended to the dynamic label and displayed in the show button."
|
1179
|
+
},
|
1180
|
+
{
|
1181
|
+
"name": "select_variant",
|
1182
|
+
"type": "Symbol",
|
1183
|
+
"default": "`:none`",
|
1184
|
+
"description": "One of `:multiple`, `:none`, or `:single`."
|
1185
|
+
},
|
1186
|
+
{
|
1187
|
+
"name": "form_arguments",
|
1188
|
+
"type": "Hash",
|
1189
|
+
"default": "`{}`",
|
1190
|
+
"description": "Allows an `ActionMenu` to act as a select list in multi- and single-select modes. Pass the `builder:` and `name:` options to this hash. `builder:` should be an instance of `ActionView::Helpers::FormBuilder`, which are created by the standard Rails `#form_with` and `#form_for` helpers. The `name:` option is the desired name of the field that will be included in the params sent to the server on form submission."
|
1191
|
+
},
|
1192
|
+
{
|
1193
|
+
"name": "system_arguments",
|
1194
|
+
"type": "Hash",
|
1195
|
+
"default": "N/A",
|
1196
|
+
"description": "{{link_to_system_arguments_docs}}."
|
1197
|
+
}
|
1198
|
+
],
|
1199
|
+
"slots": [
|
1200
|
+
{
|
1201
|
+
"name": "show_button",
|
1202
|
+
"description": "Button to activate the menu.",
|
1203
|
+
"parameters": [
|
1204
|
+
{
|
1205
|
+
"name": "system_arguments",
|
1206
|
+
"type": "Hash",
|
1207
|
+
"default": "N/A",
|
1208
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}'s `show_button` slot."
|
1209
|
+
}
|
1210
|
+
]
|
1211
|
+
},
|
1212
|
+
{
|
1213
|
+
"name": "items",
|
1214
|
+
"description": "Adds a new item to the list.",
|
1215
|
+
"parameters": [
|
1216
|
+
{
|
1217
|
+
"name": "system_arguments",
|
1218
|
+
"type": "Hash",
|
1219
|
+
"default": "N/A",
|
1220
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
1221
1221
|
}
|
1222
1222
|
]
|
1223
1223
|
}
|
@@ -3086,24 +3086,42 @@
|
|
3086
3086
|
],
|
3087
3087
|
"subcomponents": [
|
3088
3088
|
{
|
3089
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
3090
|
-
"description": "A `Dialog::
|
3089
|
+
"fully_qualified_name": "Primer::Alpha::Dialog::Header",
|
3090
|
+
"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}}.",
|
3091
3091
|
"accessibility_docs": null,
|
3092
3092
|
"is_form_component": false,
|
3093
3093
|
"is_published": true,
|
3094
3094
|
"requires_js": false,
|
3095
|
-
"component": "Dialog::
|
3095
|
+
"component": "Dialog::Header",
|
3096
3096
|
"status": "alpha",
|
3097
3097
|
"a11y_reviewed": true,
|
3098
|
-
"short_name": "
|
3099
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
3100
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
3098
|
+
"short_name": "DialogHeader",
|
3099
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
|
3100
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
|
3101
3101
|
"parameters": [
|
3102
|
+
{
|
3103
|
+
"name": "title",
|
3104
|
+
"type": "String",
|
3105
|
+
"default": "N/A",
|
3106
|
+
"description": "Describes the content of the dialog."
|
3107
|
+
},
|
3108
|
+
{
|
3109
|
+
"name": "subtitle",
|
3110
|
+
"type": "String",
|
3111
|
+
"default": "`nil`",
|
3112
|
+
"description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
|
3113
|
+
},
|
3102
3114
|
{
|
3103
3115
|
"name": "show_divider",
|
3104
3116
|
"type": "Boolean",
|
3105
3117
|
"default": "`false`",
|
3106
|
-
"description": "Show a divider between the
|
3118
|
+
"description": "Show a divider between the header and body."
|
3119
|
+
},
|
3120
|
+
{
|
3121
|
+
"name": "visually_hide_title",
|
3122
|
+
"type": "Boolean",
|
3123
|
+
"default": "`false`",
|
3124
|
+
"description": "Visually hide the `title` while maintaining a label for assistive technologies."
|
3107
3125
|
},
|
3108
3126
|
{
|
3109
3127
|
"name": "system_arguments",
|
@@ -3126,19 +3144,25 @@
|
|
3126
3144
|
]
|
3127
3145
|
},
|
3128
3146
|
{
|
3129
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
3130
|
-
"description": "A `Dialog::
|
3147
|
+
"fully_qualified_name": "Primer::Alpha::Dialog::Footer",
|
3148
|
+
"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}}.",
|
3131
3149
|
"accessibility_docs": null,
|
3132
3150
|
"is_form_component": false,
|
3133
3151
|
"is_published": true,
|
3134
3152
|
"requires_js": false,
|
3135
|
-
"component": "Dialog::
|
3153
|
+
"component": "Dialog::Footer",
|
3136
3154
|
"status": "alpha",
|
3137
3155
|
"a11y_reviewed": true,
|
3138
|
-
"short_name": "
|
3139
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
3140
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
3156
|
+
"short_name": "DialogFooter",
|
3157
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/footer.rb",
|
3158
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/footer/default/",
|
3141
3159
|
"parameters": [
|
3160
|
+
{
|
3161
|
+
"name": "show_divider",
|
3162
|
+
"type": "Boolean",
|
3163
|
+
"default": "`false`",
|
3164
|
+
"description": "Show a divider between the footer and body."
|
3165
|
+
},
|
3142
3166
|
{
|
3143
3167
|
"name": "system_arguments",
|
3144
3168
|
"type": "Hash",
|
@@ -3160,43 +3184,19 @@
|
|
3160
3184
|
]
|
3161
3185
|
},
|
3162
3186
|
{
|
3163
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
3164
|
-
"description": "A `Dialog::
|
3187
|
+
"fully_qualified_name": "Primer::Alpha::Dialog::Body",
|
3188
|
+
"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}}.",
|
3165
3189
|
"accessibility_docs": null,
|
3166
3190
|
"is_form_component": false,
|
3167
3191
|
"is_published": true,
|
3168
3192
|
"requires_js": false,
|
3169
|
-
"component": "Dialog::
|
3193
|
+
"component": "Dialog::Body",
|
3170
3194
|
"status": "alpha",
|
3171
3195
|
"a11y_reviewed": true,
|
3172
|
-
"short_name": "
|
3173
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
3174
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
3196
|
+
"short_name": "DialogBody",
|
3197
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/body.rb",
|
3198
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/body/default/",
|
3175
3199
|
"parameters": [
|
3176
|
-
{
|
3177
|
-
"name": "title",
|
3178
|
-
"type": "String",
|
3179
|
-
"default": "N/A",
|
3180
|
-
"description": "Describes the content of the dialog."
|
3181
|
-
},
|
3182
|
-
{
|
3183
|
-
"name": "subtitle",
|
3184
|
-
"type": "String",
|
3185
|
-
"default": "`nil`",
|
3186
|
-
"description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
|
3187
|
-
},
|
3188
|
-
{
|
3189
|
-
"name": "show_divider",
|
3190
|
-
"type": "Boolean",
|
3191
|
-
"default": "`false`",
|
3192
|
-
"description": "Show a divider between the header and body."
|
3193
|
-
},
|
3194
|
-
{
|
3195
|
-
"name": "visually_hide_title",
|
3196
|
-
"type": "Boolean",
|
3197
|
-
"default": "`false`",
|
3198
|
-
"description": "Visually hide the `title` while maintaining a label for assistive technologies."
|
3199
|
-
},
|
3200
3200
|
{
|
3201
3201
|
"name": "system_arguments",
|
3202
3202
|
"type": "Hash",
|
@@ -4919,64 +4919,42 @@
|
|
4919
4919
|
],
|
4920
4920
|
"subcomponents": [
|
4921
4921
|
{
|
4922
|
-
"fully_qualified_name": "Primer::Alpha::NavList::
|
4922
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Item",
|
4923
4923
|
"description": "",
|
4924
4924
|
"accessibility_docs": null,
|
4925
4925
|
"is_form_component": false,
|
4926
4926
|
"is_published": true,
|
4927
|
-
"requires_js":
|
4928
|
-
"component": "NavList::
|
4927
|
+
"requires_js": true,
|
4928
|
+
"component": "NavList::Item",
|
4929
4929
|
"status": "deprecated",
|
4930
4930
|
"a11y_reviewed": false,
|
4931
|
-
"short_name": "
|
4932
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/
|
4933
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/
|
4931
|
+
"short_name": "NavListItem",
|
4932
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
|
4933
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
|
4934
4934
|
"parameters": [
|
4935
4935
|
{
|
4936
|
-
"name": "
|
4936
|
+
"name": "selected_item_id",
|
4937
4937
|
"type": "Symbol",
|
4938
|
-
"default": "
|
4939
|
-
"description": "
|
4938
|
+
"default": "`nil`",
|
4939
|
+
"description": "The ID of the currently selected list item. Used internally."
|
4940
4940
|
},
|
4941
4941
|
{
|
4942
|
-
"name": "
|
4943
|
-
"type": "
|
4944
|
-
"default": "
|
4945
|
-
"description": "
|
4946
|
-
}
|
4947
|
-
],
|
4948
|
-
"slots": [
|
4949
|
-
|
4950
|
-
],
|
4951
|
-
"methods": [
|
4952
|
-
|
4953
|
-
],
|
4954
|
-
"previews": [
|
4955
|
-
|
4956
|
-
],
|
4957
|
-
"subcomponents": [
|
4958
|
-
|
4959
|
-
]
|
4960
|
-
},
|
4961
|
-
{
|
4962
|
-
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
4963
|
-
"description": "",
|
4964
|
-
"accessibility_docs": null,
|
4965
|
-
"is_form_component": false,
|
4966
|
-
"is_published": true,
|
4967
|
-
"requires_js": true,
|
4968
|
-
"component": "NavList::Group",
|
4969
|
-
"status": "deprecated",
|
4970
|
-
"a11y_reviewed": true,
|
4971
|
-
"short_name": "NavListGroup",
|
4972
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
|
4973
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
|
4974
|
-
"parameters": [
|
4942
|
+
"name": "selected_by_ids",
|
4943
|
+
"type": "Array<Symbol>",
|
4944
|
+
"default": "`[]`",
|
4945
|
+
"description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
|
4946
|
+
},
|
4975
4947
|
{
|
4976
|
-
"name": "
|
4977
|
-
"type": "
|
4978
|
-
"default": "`
|
4979
|
-
"description": "
|
4948
|
+
"name": "expanded",
|
4949
|
+
"type": "Boolean",
|
4950
|
+
"default": "`false`",
|
4951
|
+
"description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
|
4952
|
+
},
|
4953
|
+
{
|
4954
|
+
"name": "sub_item",
|
4955
|
+
"type": "Boolean",
|
4956
|
+
"default": "`false`",
|
4957
|
+
"description": "Whether or not this item is nested under a parent item. Used internally."
|
4980
4958
|
},
|
4981
4959
|
{
|
4982
4960
|
"name": "system_arguments",
|
@@ -4987,56 +4965,65 @@
|
|
4987
4965
|
],
|
4988
4966
|
"slots": [
|
4989
4967
|
{
|
4990
|
-
"name": "
|
4991
|
-
"description":
|
4968
|
+
"name": "items",
|
4969
|
+
"description": null,
|
4992
4970
|
"parameters": [
|
4993
|
-
{
|
4994
|
-
"name": "src",
|
4995
|
-
"type": "String",
|
4996
|
-
"default": "N/A",
|
4997
|
-
"description": "The URL to query for additional pages of list items."
|
4998
|
-
},
|
4999
|
-
{
|
5000
|
-
"name": "pages",
|
5001
|
-
"type": "Integer",
|
5002
|
-
"default": "N/A",
|
5003
|
-
"description": "The total number of pages in the result set."
|
5004
|
-
},
|
5005
|
-
{
|
5006
|
-
"name": "component_klass",
|
5007
|
-
"type": "Class",
|
5008
|
-
"default": "N/A",
|
5009
|
-
"description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
|
5010
|
-
},
|
5011
4971
|
{
|
5012
4972
|
"name": "system_arguments",
|
5013
4973
|
"type": "Hash",
|
5014
4974
|
"default": "N/A",
|
5015
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::
|
4975
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
5016
4976
|
}
|
5017
4977
|
]
|
5018
4978
|
},
|
5019
4979
|
{
|
5020
|
-
"name": "
|
5021
|
-
"description": "
|
4980
|
+
"name": "description",
|
4981
|
+
"description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
|
4982
|
+
"parameters": [
|
4983
|
+
|
4984
|
+
]
|
4985
|
+
},
|
4986
|
+
{
|
4987
|
+
"name": "leading_visual",
|
4988
|
+
"description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
|
4989
|
+
"parameters": [
|
4990
|
+
|
4991
|
+
]
|
4992
|
+
},
|
4993
|
+
{
|
4994
|
+
"name": "trailing_visual",
|
4995
|
+
"description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
|
4996
|
+
"parameters": [
|
4997
|
+
|
4998
|
+
]
|
4999
|
+
},
|
5000
|
+
{
|
5001
|
+
"name": "trailing_action",
|
5002
|
+
"description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
|
5022
5003
|
"parameters": [
|
5023
5004
|
{
|
5024
5005
|
"name": "system_arguments",
|
5025
5006
|
"type": "Hash",
|
5026
5007
|
"default": "N/A",
|
5027
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::
|
5008
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
|
5028
5009
|
}
|
5029
5010
|
]
|
5030
5011
|
},
|
5031
5012
|
{
|
5032
|
-
"name": "
|
5033
|
-
"description": "
|
5013
|
+
"name": "tooltip",
|
5014
|
+
"description": "`Tooltip` that appears on mouse hover or keyboard focus over the trailing action button. Use tooltips sparingly and as\na last resort. **Important:** This tooltip defaults to `type: :description`. In a few scenarios, `type: :label` may be\nmore appropriate. Consult the {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}} documentation for more information.",
|
5034
5015
|
"parameters": [
|
5016
|
+
{
|
5017
|
+
"name": "type",
|
5018
|
+
"type": "Symbol",
|
5019
|
+
"default": "`:description`",
|
5020
|
+
"description": "One of `:description` or `:label`."
|
5021
|
+
},
|
5035
5022
|
{
|
5036
5023
|
"name": "system_arguments",
|
5037
5024
|
"type": "Hash",
|
5038
5025
|
"default": "N/A",
|
5039
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::
|
5026
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
|
5040
5027
|
}
|
5041
5028
|
]
|
5042
5029
|
}
|
@@ -5104,42 +5091,24 @@
|
|
5104
5091
|
]
|
5105
5092
|
},
|
5106
5093
|
{
|
5107
|
-
"fully_qualified_name": "Primer::Alpha::NavList::
|
5094
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Divider",
|
5108
5095
|
"description": "",
|
5109
5096
|
"accessibility_docs": null,
|
5110
5097
|
"is_form_component": false,
|
5111
5098
|
"is_published": true,
|
5112
|
-
"requires_js":
|
5113
|
-
"component": "NavList::
|
5099
|
+
"requires_js": false,
|
5100
|
+
"component": "NavList::Divider",
|
5114
5101
|
"status": "deprecated",
|
5115
5102
|
"a11y_reviewed": false,
|
5116
|
-
"short_name": "
|
5117
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/
|
5118
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/
|
5103
|
+
"short_name": "NavListDivider",
|
5104
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
|
5105
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
|
5119
5106
|
"parameters": [
|
5120
5107
|
{
|
5121
|
-
"name": "
|
5108
|
+
"name": "scheme",
|
5122
5109
|
"type": "Symbol",
|
5123
|
-
"default": "`
|
5124
|
-
"description": "
|
5125
|
-
},
|
5126
|
-
{
|
5127
|
-
"name": "selected_by_ids",
|
5128
|
-
"type": "Array<Symbol>",
|
5129
|
-
"default": "`[]`",
|
5130
|
-
"description": "The list of IDs that select this item. In other words, if the `selected_item_id` attribute on the parent `NavList` is set to one of these IDs, the item will appear selected."
|
5131
|
-
},
|
5132
|
-
{
|
5133
|
-
"name": "expanded",
|
5134
|
-
"type": "Boolean",
|
5135
|
-
"default": "`false`",
|
5136
|
-
"description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
|
5137
|
-
},
|
5138
|
-
{
|
5139
|
-
"name": "sub_item",
|
5140
|
-
"type": "Boolean",
|
5141
|
-
"default": "`false`",
|
5142
|
-
"description": "Whether or not this item is nested under a parent item. Used internally."
|
5110
|
+
"default": "`:subtle`",
|
5111
|
+
"description": "Display a background color if scheme is `filled`."
|
5143
5112
|
},
|
5144
5113
|
{
|
5145
5114
|
"name": "system_arguments",
|
@@ -5149,66 +5118,97 @@
|
|
5149
5118
|
}
|
5150
5119
|
],
|
5151
5120
|
"slots": [
|
5152
|
-
{
|
5153
|
-
"name": "items",
|
5154
|
-
"description": null,
|
5155
|
-
"parameters": [
|
5156
|
-
{
|
5157
|
-
"name": "system_arguments",
|
5158
|
-
"type": "Hash",
|
5159
|
-
"default": "N/A",
|
5160
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
5161
|
-
}
|
5162
|
-
]
|
5163
|
-
},
|
5164
|
-
{
|
5165
|
-
"name": "description",
|
5166
|
-
"description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
|
5167
|
-
"parameters": [
|
5168
5121
|
|
5169
|
-
|
5170
|
-
|
5171
|
-
{
|
5172
|
-
"name": "leading_visual",
|
5173
|
-
"description": "An icon, avatar, SVG, or custom content that will render to the left of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render an SVG, call the `with_leading_visual_svg` method.\n\nTo render custom content, call the `with_leading_visual_content` method and pass a block that returns a string.",
|
5174
|
-
"parameters": [
|
5122
|
+
],
|
5123
|
+
"methods": [
|
5175
5124
|
|
5176
|
-
|
5177
|
-
|
5178
|
-
{
|
5179
|
-
"name": "trailing_visual",
|
5180
|
-
"description": "An icon, label, counter, or text to render to the right of the label.\n\nTo render an icon, call the `with_leading_visual_icon` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.\n\nTo render a label, call the `with_leading_visual_label` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Label{{/link_to_component}}.\n\nTo render a counter, call the `with_leading_visual_counter` method, which accepts the arguments accepted by {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.\n\nTo render text, call the `with_leading_visual_text` method and pass a block that returns a string. Eg:\n```ruby\nwith_leading_visual_text { \"Text here\" }\n```",
|
5181
|
-
"parameters": [
|
5125
|
+
],
|
5126
|
+
"previews": [
|
5182
5127
|
|
5183
|
-
|
5128
|
+
],
|
5129
|
+
"subcomponents": [
|
5130
|
+
|
5131
|
+
]
|
5132
|
+
},
|
5133
|
+
{
|
5134
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
5135
|
+
"description": "",
|
5136
|
+
"accessibility_docs": null,
|
5137
|
+
"is_form_component": false,
|
5138
|
+
"is_published": true,
|
5139
|
+
"requires_js": true,
|
5140
|
+
"component": "NavList::Group",
|
5141
|
+
"status": "deprecated",
|
5142
|
+
"a11y_reviewed": true,
|
5143
|
+
"short_name": "NavListGroup",
|
5144
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
|
5145
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
|
5146
|
+
"parameters": [
|
5147
|
+
{
|
5148
|
+
"name": "selected_item_id",
|
5149
|
+
"type": "Symbol",
|
5150
|
+
"default": "`nil`",
|
5151
|
+
"description": "The ID of the currently selected item. Used internally."
|
5184
5152
|
},
|
5185
5153
|
{
|
5186
|
-
"name": "
|
5187
|
-
"
|
5154
|
+
"name": "system_arguments",
|
5155
|
+
"type": "Hash",
|
5156
|
+
"default": "N/A",
|
5157
|
+
"description": "{{link_to_system_arguments_docs}}"
|
5158
|
+
}
|
5159
|
+
],
|
5160
|
+
"slots": [
|
5161
|
+
{
|
5162
|
+
"name": "show_more_item",
|
5163
|
+
"description": "A special \"show more\" list item that appears at the bottom of the group. Clicking\nthe item will fetch the next page of results from the URL passed in the `src` argument\nand append the resulting chunk of HTML to the group.",
|
5188
5164
|
"parameters": [
|
5165
|
+
{
|
5166
|
+
"name": "src",
|
5167
|
+
"type": "String",
|
5168
|
+
"default": "N/A",
|
5169
|
+
"description": "The URL to query for additional pages of list items."
|
5170
|
+
},
|
5171
|
+
{
|
5172
|
+
"name": "pages",
|
5173
|
+
"type": "Integer",
|
5174
|
+
"default": "N/A",
|
5175
|
+
"description": "The total number of pages in the result set."
|
5176
|
+
},
|
5177
|
+
{
|
5178
|
+
"name": "component_klass",
|
5179
|
+
"type": "Class",
|
5180
|
+
"default": "N/A",
|
5181
|
+
"description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
|
5182
|
+
},
|
5189
5183
|
{
|
5190
5184
|
"name": "system_arguments",
|
5191
5185
|
"type": "Hash",
|
5192
5186
|
"default": "N/A",
|
5193
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::
|
5187
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
5194
5188
|
}
|
5195
5189
|
]
|
5196
5190
|
},
|
5197
5191
|
{
|
5198
|
-
"name": "
|
5199
|
-
"description": "
|
5192
|
+
"name": "items",
|
5193
|
+
"description": "Items.",
|
5200
5194
|
"parameters": [
|
5201
5195
|
{
|
5202
|
-
"name": "
|
5203
|
-
"type": "
|
5204
|
-
"default": "
|
5205
|
-
"description": "
|
5206
|
-
}
|
5196
|
+
"name": "system_arguments",
|
5197
|
+
"type": "Hash",
|
5198
|
+
"default": "N/A",
|
5199
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
5200
|
+
}
|
5201
|
+
]
|
5202
|
+
},
|
5203
|
+
{
|
5204
|
+
"name": "heading",
|
5205
|
+
"description": "Heading text rendered above the list of items.",
|
5206
|
+
"parameters": [
|
5207
5207
|
{
|
5208
5208
|
"name": "system_arguments",
|
5209
5209
|
"type": "Hash",
|
5210
5210
|
"default": "N/A",
|
5211
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::
|
5211
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
5212
5212
|
}
|
5213
5213
|
]
|
5214
5214
|
}
|
@@ -5670,52 +5670,6 @@
|
|
5670
5670
|
}
|
5671
5671
|
],
|
5672
5672
|
"subcomponents": [
|
5673
|
-
{
|
5674
|
-
"fully_qualified_name": "Primer::Alpha::Overlay::Footer",
|
5675
|
-
"description": "A `Overlay::Footer` is a compositional component, used to render the\nFooter of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
|
5676
|
-
"accessibility_docs": null,
|
5677
|
-
"is_form_component": false,
|
5678
|
-
"is_published": true,
|
5679
|
-
"requires_js": false,
|
5680
|
-
"component": "Overlay::Footer",
|
5681
|
-
"status": "alpha",
|
5682
|
-
"a11y_reviewed": false,
|
5683
|
-
"short_name": "OverlayFooter",
|
5684
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/footer.rb",
|
5685
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/footer/default/",
|
5686
|
-
"parameters": [
|
5687
|
-
{
|
5688
|
-
"name": "show_divider",
|
5689
|
-
"type": "Boolean",
|
5690
|
-
"default": "`false`",
|
5691
|
-
"description": "Show a divider between the footer and body."
|
5692
|
-
},
|
5693
|
-
{
|
5694
|
-
"name": "align_content",
|
5695
|
-
"type": "Symbol",
|
5696
|
-
"default": "`DEFAULT_ALIGN_CONTENT`",
|
5697
|
-
"description": "The alginment of contents. One of `:center`, `:end`, or `:start`."
|
5698
|
-
},
|
5699
|
-
{
|
5700
|
-
"name": "system_arguments",
|
5701
|
-
"type": "Hash",
|
5702
|
-
"default": "N/A",
|
5703
|
-
"description": "{{link_to_system_arguments_docs}}"
|
5704
|
-
}
|
5705
|
-
],
|
5706
|
-
"slots": [
|
5707
|
-
|
5708
|
-
],
|
5709
|
-
"methods": [
|
5710
|
-
|
5711
|
-
],
|
5712
|
-
"previews": [
|
5713
|
-
|
5714
|
-
],
|
5715
|
-
"subcomponents": [
|
5716
|
-
|
5717
|
-
]
|
5718
|
-
},
|
5719
5673
|
{
|
5720
5674
|
"fully_qualified_name": "Primer::Alpha::Overlay::Header",
|
5721
5675
|
"description": "A `Overlay::Header` is a compositional component, used to render the\nHeader of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
|
@@ -5786,6 +5740,52 @@
|
|
5786
5740
|
|
5787
5741
|
]
|
5788
5742
|
},
|
5743
|
+
{
|
5744
|
+
"fully_qualified_name": "Primer::Alpha::Overlay::Footer",
|
5745
|
+
"description": "A `Overlay::Footer` is a compositional component, used to render the\nFooter of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
|
5746
|
+
"accessibility_docs": null,
|
5747
|
+
"is_form_component": false,
|
5748
|
+
"is_published": true,
|
5749
|
+
"requires_js": false,
|
5750
|
+
"component": "Overlay::Footer",
|
5751
|
+
"status": "alpha",
|
5752
|
+
"a11y_reviewed": false,
|
5753
|
+
"short_name": "OverlayFooter",
|
5754
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/overlay/footer.rb",
|
5755
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/overlay/footer/default/",
|
5756
|
+
"parameters": [
|
5757
|
+
{
|
5758
|
+
"name": "show_divider",
|
5759
|
+
"type": "Boolean",
|
5760
|
+
"default": "`false`",
|
5761
|
+
"description": "Show a divider between the footer and body."
|
5762
|
+
},
|
5763
|
+
{
|
5764
|
+
"name": "align_content",
|
5765
|
+
"type": "Symbol",
|
5766
|
+
"default": "`DEFAULT_ALIGN_CONTENT`",
|
5767
|
+
"description": "The alginment of contents. One of `:center`, `:end`, or `:start`."
|
5768
|
+
},
|
5769
|
+
{
|
5770
|
+
"name": "system_arguments",
|
5771
|
+
"type": "Hash",
|
5772
|
+
"default": "N/A",
|
5773
|
+
"description": "{{link_to_system_arguments_docs}}"
|
5774
|
+
}
|
5775
|
+
],
|
5776
|
+
"slots": [
|
5777
|
+
|
5778
|
+
],
|
5779
|
+
"methods": [
|
5780
|
+
|
5781
|
+
],
|
5782
|
+
"previews": [
|
5783
|
+
|
5784
|
+
],
|
5785
|
+
"subcomponents": [
|
5786
|
+
|
5787
|
+
]
|
5788
|
+
},
|
5789
5789
|
{
|
5790
5790
|
"fully_qualified_name": "Primer::Alpha::Overlay::Body",
|
5791
5791
|
"description": "A `Overlay::Body` is a compositional component, used to render the\nBody of an overlay. See {{#link_to_component}}Primer::Alpha::Overlay{{/link_to_component}}.",
|
@@ -11914,7 +11914,7 @@
|
|
11914
11914
|
{
|
11915
11915
|
"name": "underline",
|
11916
11916
|
"type": "Boolean",
|
11917
|
-
"default": "`
|
11917
|
+
"default": "`false`",
|
11918
11918
|
"description": "Whether or not to underline the link."
|
11919
11919
|
},
|
11920
11920
|
{
|
@@ -12373,46 +12373,6 @@
|
|
12373
12373
|
}
|
12374
12374
|
],
|
12375
12375
|
"subcomponents": [
|
12376
|
-
{
|
12377
|
-
"fully_qualified_name": "Primer::Beta::NavList::Divider",
|
12378
|
-
"description": "Separator with optional text rendered above groups or between individual items.",
|
12379
|
-
"accessibility_docs": null,
|
12380
|
-
"is_form_component": false,
|
12381
|
-
"is_published": true,
|
12382
|
-
"requires_js": false,
|
12383
|
-
"component": "NavList::Divider",
|
12384
|
-
"status": "alpha",
|
12385
|
-
"a11y_reviewed": false,
|
12386
|
-
"short_name": "NavListDivider",
|
12387
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb",
|
12388
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/",
|
12389
|
-
"parameters": [
|
12390
|
-
{
|
12391
|
-
"name": "scheme",
|
12392
|
-
"type": "Symbol",
|
12393
|
-
"default": "`:subtle`",
|
12394
|
-
"description": "Display a background color if scheme is `filled`."
|
12395
|
-
},
|
12396
|
-
{
|
12397
|
-
"name": "system_arguments",
|
12398
|
-
"type": "Hash",
|
12399
|
-
"default": "N/A",
|
12400
|
-
"description": "{{link_to_system_arguments_docs}}"
|
12401
|
-
}
|
12402
|
-
],
|
12403
|
-
"slots": [
|
12404
|
-
|
12405
|
-
],
|
12406
|
-
"methods": [
|
12407
|
-
|
12408
|
-
],
|
12409
|
-
"previews": [
|
12410
|
-
|
12411
|
-
],
|
12412
|
-
"subcomponents": [
|
12413
|
-
|
12414
|
-
]
|
12415
|
-
},
|
12416
12376
|
{
|
12417
12377
|
"fully_qualified_name": "Primer::Beta::NavList::Heading",
|
12418
12378
|
"description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.",
|
@@ -12492,105 +12452,6 @@
|
|
12492
12452
|
|
12493
12453
|
]
|
12494
12454
|
},
|
12495
|
-
{
|
12496
|
-
"fully_qualified_name": "Primer::Beta::NavList::Group",
|
12497
|
-
"description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.",
|
12498
|
-
"accessibility_docs": null,
|
12499
|
-
"is_form_component": false,
|
12500
|
-
"is_published": true,
|
12501
|
-
"requires_js": true,
|
12502
|
-
"component": "NavList::Group",
|
12503
|
-
"status": "alpha",
|
12504
|
-
"a11y_reviewed": true,
|
12505
|
-
"short_name": "NavListGroup",
|
12506
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb",
|
12507
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/",
|
12508
|
-
"parameters": [
|
12509
|
-
{
|
12510
|
-
"name": "selected_item_id",
|
12511
|
-
"type": "Symbol",
|
12512
|
-
"default": "`nil`",
|
12513
|
-
"description": "The ID of the currently selected item. Used internally."
|
12514
|
-
},
|
12515
|
-
{
|
12516
|
-
"name": "system_arguments",
|
12517
|
-
"type": "Hash",
|
12518
|
-
"default": "N/A",
|
12519
|
-
"description": "{{link_to_system_arguments_docs}}"
|
12520
|
-
}
|
12521
|
-
],
|
12522
|
-
"slots": [
|
12523
|
-
{
|
12524
|
-
"name": "show_more_item",
|
12525
|
-
"description": "A special \"show more\" list item that appears at the bottom of the group. Clicking\nthe item will fetch the next page of results from the URL passed in the `src` argument\nand append the resulting chunk of HTML to the group.",
|
12526
|
-
"parameters": [
|
12527
|
-
{
|
12528
|
-
"name": "src",
|
12529
|
-
"type": "String",
|
12530
|
-
"default": "N/A",
|
12531
|
-
"description": "The URL to query for additional pages of list items."
|
12532
|
-
},
|
12533
|
-
{
|
12534
|
-
"name": "pages",
|
12535
|
-
"type": "Integer",
|
12536
|
-
"default": "N/A",
|
12537
|
-
"description": "The total number of pages in the result set."
|
12538
|
-
},
|
12539
|
-
{
|
12540
|
-
"name": "component_klass",
|
12541
|
-
"type": "Class",
|
12542
|
-
"default": "N/A",
|
12543
|
-
"description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
|
12544
|
-
},
|
12545
|
-
{
|
12546
|
-
"name": "system_arguments",
|
12547
|
-
"type": "Hash",
|
12548
|
-
"default": "N/A",
|
12549
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
12550
|
-
}
|
12551
|
-
]
|
12552
|
-
},
|
12553
|
-
{
|
12554
|
-
"name": "items",
|
12555
|
-
"description": "Items.",
|
12556
|
-
"parameters": [
|
12557
|
-
{
|
12558
|
-
"name": "system_arguments",
|
12559
|
-
"type": "Hash",
|
12560
|
-
"default": "N/A",
|
12561
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
12562
|
-
}
|
12563
|
-
]
|
12564
|
-
},
|
12565
|
-
{
|
12566
|
-
"name": "heading",
|
12567
|
-
"description": "Heading text rendered above the list of items.",
|
12568
|
-
"parameters": [
|
12569
|
-
{
|
12570
|
-
"name": "system_arguments",
|
12571
|
-
"type": "Hash",
|
12572
|
-
"default": "N/A",
|
12573
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
12574
|
-
}
|
12575
|
-
]
|
12576
|
-
}
|
12577
|
-
],
|
12578
|
-
"methods": [
|
12579
|
-
{
|
12580
|
-
"name": "expand!",
|
12581
|
-
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
12582
|
-
"parameters": [
|
12583
|
-
|
12584
|
-
]
|
12585
|
-
}
|
12586
|
-
],
|
12587
|
-
"previews": [
|
12588
|
-
|
12589
|
-
],
|
12590
|
-
"subcomponents": [
|
12591
|
-
|
12592
|
-
]
|
12593
|
-
},
|
12594
12455
|
{
|
12595
12456
|
"fully_qualified_name": "Primer::Beta::NavList::Item",
|
12596
12457
|
"description": "Items are rendered as styled links. They can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters. Items are selected by ID. IDs can be specified via the\n`selected_item_ids` argument, which accepts a list of valid IDs for the item. Items can also\nthemselves contain sub items. Sub items are rendered collapsed by default.",
|
@@ -12743,6 +12604,145 @@
|
|
12743
12604
|
],
|
12744
12605
|
"subcomponents": [
|
12745
12606
|
|
12607
|
+
]
|
12608
|
+
},
|
12609
|
+
{
|
12610
|
+
"fully_qualified_name": "Primer::Beta::NavList::Divider",
|
12611
|
+
"description": "Separator with optional text rendered above groups or between individual items.",
|
12612
|
+
"accessibility_docs": null,
|
12613
|
+
"is_form_component": false,
|
12614
|
+
"is_published": true,
|
12615
|
+
"requires_js": false,
|
12616
|
+
"component": "NavList::Divider",
|
12617
|
+
"status": "alpha",
|
12618
|
+
"a11y_reviewed": false,
|
12619
|
+
"short_name": "NavListDivider",
|
12620
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb",
|
12621
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/",
|
12622
|
+
"parameters": [
|
12623
|
+
{
|
12624
|
+
"name": "scheme",
|
12625
|
+
"type": "Symbol",
|
12626
|
+
"default": "`:subtle`",
|
12627
|
+
"description": "Display a background color if scheme is `filled`."
|
12628
|
+
},
|
12629
|
+
{
|
12630
|
+
"name": "system_arguments",
|
12631
|
+
"type": "Hash",
|
12632
|
+
"default": "N/A",
|
12633
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12634
|
+
}
|
12635
|
+
],
|
12636
|
+
"slots": [
|
12637
|
+
|
12638
|
+
],
|
12639
|
+
"methods": [
|
12640
|
+
|
12641
|
+
],
|
12642
|
+
"previews": [
|
12643
|
+
|
12644
|
+
],
|
12645
|
+
"subcomponents": [
|
12646
|
+
|
12647
|
+
]
|
12648
|
+
},
|
12649
|
+
{
|
12650
|
+
"fully_qualified_name": "Primer::Beta::NavList::Group",
|
12651
|
+
"description": "A logical grouping of navigation links with an optional heading.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.",
|
12652
|
+
"accessibility_docs": null,
|
12653
|
+
"is_form_component": false,
|
12654
|
+
"is_published": true,
|
12655
|
+
"requires_js": true,
|
12656
|
+
"component": "NavList::Group",
|
12657
|
+
"status": "alpha",
|
12658
|
+
"a11y_reviewed": true,
|
12659
|
+
"short_name": "NavListGroup",
|
12660
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb",
|
12661
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/",
|
12662
|
+
"parameters": [
|
12663
|
+
{
|
12664
|
+
"name": "selected_item_id",
|
12665
|
+
"type": "Symbol",
|
12666
|
+
"default": "`nil`",
|
12667
|
+
"description": "The ID of the currently selected item. Used internally."
|
12668
|
+
},
|
12669
|
+
{
|
12670
|
+
"name": "system_arguments",
|
12671
|
+
"type": "Hash",
|
12672
|
+
"default": "N/A",
|
12673
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12674
|
+
}
|
12675
|
+
],
|
12676
|
+
"slots": [
|
12677
|
+
{
|
12678
|
+
"name": "show_more_item",
|
12679
|
+
"description": "A special \"show more\" list item that appears at the bottom of the group. Clicking\nthe item will fetch the next page of results from the URL passed in the `src` argument\nand append the resulting chunk of HTML to the group.",
|
12680
|
+
"parameters": [
|
12681
|
+
{
|
12682
|
+
"name": "src",
|
12683
|
+
"type": "String",
|
12684
|
+
"default": "N/A",
|
12685
|
+
"description": "The URL to query for additional pages of list items."
|
12686
|
+
},
|
12687
|
+
{
|
12688
|
+
"name": "pages",
|
12689
|
+
"type": "Integer",
|
12690
|
+
"default": "N/A",
|
12691
|
+
"description": "The total number of pages in the result set."
|
12692
|
+
},
|
12693
|
+
{
|
12694
|
+
"name": "component_klass",
|
12695
|
+
"type": "Class",
|
12696
|
+
"default": "N/A",
|
12697
|
+
"description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
|
12698
|
+
},
|
12699
|
+
{
|
12700
|
+
"name": "system_arguments",
|
12701
|
+
"type": "Hash",
|
12702
|
+
"default": "N/A",
|
12703
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
12704
|
+
}
|
12705
|
+
]
|
12706
|
+
},
|
12707
|
+
{
|
12708
|
+
"name": "items",
|
12709
|
+
"description": "Items.",
|
12710
|
+
"parameters": [
|
12711
|
+
{
|
12712
|
+
"name": "system_arguments",
|
12713
|
+
"type": "Hash",
|
12714
|
+
"default": "N/A",
|
12715
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
12716
|
+
}
|
12717
|
+
]
|
12718
|
+
},
|
12719
|
+
{
|
12720
|
+
"name": "heading",
|
12721
|
+
"description": "Heading text rendered above the list of items.",
|
12722
|
+
"parameters": [
|
12723
|
+
{
|
12724
|
+
"name": "system_arguments",
|
12725
|
+
"type": "Hash",
|
12726
|
+
"default": "N/A",
|
12727
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
12728
|
+
}
|
12729
|
+
]
|
12730
|
+
}
|
12731
|
+
],
|
12732
|
+
"methods": [
|
12733
|
+
{
|
12734
|
+
"name": "expand!",
|
12735
|
+
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
12736
|
+
"parameters": [
|
12737
|
+
|
12738
|
+
]
|
12739
|
+
}
|
12740
|
+
],
|
12741
|
+
"previews": [
|
12742
|
+
|
12743
|
+
],
|
12744
|
+
"subcomponents": [
|
12745
|
+
|
12746
12746
|
]
|
12747
12747
|
}
|
12748
12748
|
]
|