@primer/view-components 0.6.0-rc.955257c0 → 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.
package/static/info_arch.json
CHANGED
@@ -125,17 +125,17 @@
|
|
125
125
|
],
|
126
126
|
"subcomponents": [
|
127
127
|
{
|
128
|
-
"fully_qualified_name": "Primer::Alpha::ActionBar::
|
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::
|
133
|
+
"component": "ActionBar::Divider",
|
134
134
|
"status": "alpha",
|
135
135
|
"a11y_reviewed": false,
|
136
|
-
"short_name": "
|
137
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/
|
138
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/
|
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::
|
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::
|
161
|
+
"component": "ActionBar::Item",
|
162
162
|
"status": "alpha",
|
163
163
|
"a11y_reviewed": false,
|
164
|
-
"short_name": "
|
165
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_bar/
|
166
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_bar/
|
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
|
],
|
@@ -270,11 +270,17 @@
|
|
270
270
|
"name": "with_item",
|
271
271
|
"description": "Adds an item to the list.",
|
272
272
|
"parameters": [
|
273
|
+
{
|
274
|
+
"name": "component_klass",
|
275
|
+
"type": "Class",
|
276
|
+
"default": "N/A",
|
277
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
278
|
+
},
|
273
279
|
{
|
274
280
|
"name": "system_arguments",
|
275
281
|
"type": "Hash",
|
276
282
|
"default": "N/A",
|
277
|
-
"description": "
|
283
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
278
284
|
}
|
279
285
|
]
|
280
286
|
},
|
@@ -318,17 +324,23 @@
|
|
318
324
|
"default": "`:block`",
|
319
325
|
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
320
326
|
},
|
327
|
+
{
|
328
|
+
"name": "component_klass",
|
329
|
+
"type": "Class",
|
330
|
+
"default": "`ActionList::Item`",
|
331
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
332
|
+
},
|
321
333
|
{
|
322
334
|
"name": "avatar_arguments",
|
323
335
|
"type": "Hash",
|
324
336
|
"default": "`{}`",
|
325
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}
|
337
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
326
338
|
},
|
327
339
|
{
|
328
340
|
"name": "system_arguments",
|
329
341
|
"type": "Hash",
|
330
342
|
"default": "N/A",
|
331
|
-
"description": "
|
343
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
332
344
|
}
|
333
345
|
]
|
334
346
|
},
|
@@ -353,6 +365,72 @@
|
|
353
365
|
|
354
366
|
]
|
355
367
|
},
|
368
|
+
{
|
369
|
+
"name": "build_item",
|
370
|
+
"description": "Builds a new item but does not add it to the list. Use this method\ninstead of the `#with_item` slot if you need to render an item outside\nthe context of a list, eg. if rendering additional items to append to\nan existing list, perhaps via a separate HTTP request.",
|
371
|
+
"parameters": [
|
372
|
+
{
|
373
|
+
"name": "component_klass",
|
374
|
+
"type": "Class",
|
375
|
+
"default": "`ActionList::Item`",
|
376
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
377
|
+
},
|
378
|
+
{
|
379
|
+
"name": "system_arguments",
|
380
|
+
"type": "Hash",
|
381
|
+
"default": "N/A",
|
382
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
383
|
+
}
|
384
|
+
]
|
385
|
+
},
|
386
|
+
{
|
387
|
+
"name": "build_avatar_item",
|
388
|
+
"description": "Builds a new avatar item but does not add it to the list. Avatar items\nare a convenient way to accessibly add an item with a leading avatar\nimage. Use this method instead of the `#with_avatar_item` slot if you\nneed to render an avatar item outside the context of a list, eg. if\nrendering additional items to append to an existing list, perhaps via\na separate HTTP request.",
|
389
|
+
"parameters": [
|
390
|
+
{
|
391
|
+
"name": "src",
|
392
|
+
"type": "String",
|
393
|
+
"default": "N/A",
|
394
|
+
"description": "The source url of the avatar image."
|
395
|
+
},
|
396
|
+
{
|
397
|
+
"name": "username",
|
398
|
+
"type": "String",
|
399
|
+
"default": "N/A",
|
400
|
+
"description": "The username associated with the avatar."
|
401
|
+
},
|
402
|
+
{
|
403
|
+
"name": "full_name",
|
404
|
+
"type": "String",
|
405
|
+
"default": "`nil`",
|
406
|
+
"description": "Optional. The user's full name."
|
407
|
+
},
|
408
|
+
{
|
409
|
+
"name": "full_name_scheme",
|
410
|
+
"type": "Symbol",
|
411
|
+
"default": "`:block`",
|
412
|
+
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
413
|
+
},
|
414
|
+
{
|
415
|
+
"name": "component_klass",
|
416
|
+
"type": "Class",
|
417
|
+
"default": "`ActionList::Item`",
|
418
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}"
|
419
|
+
},
|
420
|
+
{
|
421
|
+
"name": "avatar_arguments",
|
422
|
+
"type": "Hash",
|
423
|
+
"default": "`{}`",
|
424
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
425
|
+
},
|
426
|
+
{
|
427
|
+
"name": "system_arguments",
|
428
|
+
"type": "Hash",
|
429
|
+
"default": "N/A",
|
430
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
431
|
+
}
|
432
|
+
]
|
433
|
+
},
|
356
434
|
{
|
357
435
|
"name": "post_list_content_block",
|
358
436
|
"description": "Returns the value of attribute post_list_content_block.",
|
@@ -650,6 +728,143 @@
|
|
650
728
|
}
|
651
729
|
],
|
652
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
|
+
},
|
653
868
|
{
|
654
869
|
"fully_qualified_name": "Primer::Alpha::ActionList::Item",
|
655
870
|
"description": "An individual `ActionList` item. Items can optionally include leading and/or trailing visuals,\nsuch as icons, avatars, and counters.",
|
@@ -856,169 +1071,32 @@
|
|
856
1071
|
},
|
857
1072
|
{
|
858
1073
|
"name": "disabled",
|
859
|
-
"description": "Returns the value of attribute disabled.",
|
860
|
-
"parameters": [
|
861
|
-
|
862
|
-
]
|
863
|
-
},
|
864
|
-
{
|
865
|
-
"name": "parent",
|
866
|
-
"description": "Returns the value of attribute parent.",
|
867
|
-
"parameters": [
|
868
|
-
|
869
|
-
]
|
870
|
-
},
|
871
|
-
{
|
872
|
-
"name": "active?",
|
873
|
-
"description": "Returns the value of attribute active.\nWhether or not this item is active.",
|
874
|
-
"parameters": [
|
875
|
-
|
876
|
-
]
|
877
|
-
},
|
878
|
-
{
|
879
|
-
"name": "disabled?",
|
880
|
-
"description": "Returns the value of attribute disabled.\nWhether or not this item is disabled.",
|
881
|
-
"parameters": [
|
882
|
-
|
883
|
-
]
|
884
|
-
}
|
885
|
-
],
|
886
|
-
"previews": [
|
887
|
-
|
888
|
-
],
|
889
|
-
"subcomponents": [
|
890
|
-
|
891
|
-
]
|
892
|
-
},
|
893
|
-
{
|
894
|
-
"fully_qualified_name": "Primer::Alpha::ActionList::Heading",
|
895
|
-
"description": "Heading used to describe each sub list within an action list.",
|
896
|
-
"is_form_component": false,
|
897
|
-
"is_published": true,
|
898
|
-
"requires_js": false,
|
899
|
-
"component": "ActionList::Heading",
|
900
|
-
"status": "alpha",
|
901
|
-
"a11y_reviewed": false,
|
902
|
-
"short_name": "ActionListHeading",
|
903
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
|
904
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
|
905
|
-
"parameters": [
|
906
|
-
{
|
907
|
-
"name": "title",
|
908
|
-
"type": "String",
|
909
|
-
"default": "N/A",
|
910
|
-
"description": "Sub list title."
|
911
|
-
},
|
912
|
-
{
|
913
|
-
"name": "heading_level",
|
914
|
-
"type": "Integer",
|
915
|
-
"default": "`3`",
|
916
|
-
"description": "Heading level. Level 2 results in an `<h2>` tag, level 3 an `<h3>` tag, etc."
|
917
|
-
},
|
918
|
-
{
|
919
|
-
"name": "subtitle",
|
920
|
-
"type": "String",
|
921
|
-
"default": "`nil`",
|
922
|
-
"description": "Optional sub list description."
|
923
|
-
},
|
924
|
-
{
|
925
|
-
"name": "scheme",
|
926
|
-
"type": "Symbol",
|
927
|
-
"default": "`:subtle`",
|
928
|
-
"description": "Display a background color if scheme is `filled`."
|
929
|
-
},
|
930
|
-
{
|
931
|
-
"name": "system_arguments",
|
932
|
-
"type": "Hash",
|
933
|
-
"default": "N/A",
|
934
|
-
"description": "{{link_to_system_arguments_docs}}"
|
935
|
-
}
|
936
|
-
],
|
937
|
-
"slots": [
|
938
|
-
|
939
|
-
],
|
940
|
-
"methods": [
|
941
|
-
{
|
942
|
-
"name": "title_id",
|
943
|
-
"description": "Returns the value of attribute title_id.",
|
944
|
-
"parameters": [
|
945
|
-
|
946
|
-
]
|
947
|
-
},
|
948
|
-
{
|
949
|
-
"name": "subtitle_id",
|
950
|
-
"description": "Returns the value of attribute subtitle_id.",
|
951
|
-
"parameters": [
|
952
|
-
|
953
|
-
]
|
954
|
-
}
|
955
|
-
],
|
956
|
-
"previews": [
|
957
|
-
|
958
|
-
],
|
959
|
-
"subcomponents": [
|
960
|
-
|
961
|
-
]
|
962
|
-
},
|
963
|
-
{
|
964
|
-
"fully_qualified_name": "Primer::Alpha::ActionList::FormWrapper",
|
965
|
-
"description": "Utility component for wrapping ActionLists or individual ActionList::Items in forms.",
|
966
|
-
"is_form_component": false,
|
967
|
-
"is_published": true,
|
968
|
-
"requires_js": false,
|
969
|
-
"component": "ActionList::FormWrapper",
|
970
|
-
"status": "alpha",
|
971
|
-
"a11y_reviewed": false,
|
972
|
-
"short_name": "ActionListFormWrapper",
|
973
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/form_wrapper.rb",
|
974
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/form_wrapper/default/",
|
975
|
-
"parameters": [
|
976
|
-
|
977
|
-
],
|
978
|
-
"slots": [
|
979
|
-
|
980
|
-
],
|
981
|
-
"methods": [
|
982
|
-
|
983
|
-
],
|
984
|
-
"previews": [
|
985
|
-
|
986
|
-
],
|
987
|
-
"subcomponents": [
|
988
|
-
|
989
|
-
]
|
990
|
-
},
|
991
|
-
{
|
992
|
-
"fully_qualified_name": "Primer::Alpha::ActionList::Divider",
|
993
|
-
"description": "Separator with optional text rendered above groups or between individual items.",
|
994
|
-
"is_form_component": false,
|
995
|
-
"is_published": true,
|
996
|
-
"requires_js": false,
|
997
|
-
"component": "ActionList::Divider",
|
998
|
-
"status": "alpha",
|
999
|
-
"a11y_reviewed": false,
|
1000
|
-
"short_name": "ActionListDivider",
|
1001
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
|
1002
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
|
1003
|
-
"parameters": [
|
1074
|
+
"description": "Returns the value of attribute disabled.",
|
1075
|
+
"parameters": [
|
1076
|
+
|
1077
|
+
]
|
1078
|
+
},
|
1004
1079
|
{
|
1005
|
-
"name": "
|
1006
|
-
"
|
1007
|
-
"
|
1008
|
-
|
1080
|
+
"name": "parent",
|
1081
|
+
"description": "Returns the value of attribute parent.",
|
1082
|
+
"parameters": [
|
1083
|
+
|
1084
|
+
]
|
1009
1085
|
},
|
1010
1086
|
{
|
1011
|
-
"name": "
|
1012
|
-
"
|
1013
|
-
"
|
1014
|
-
"description": "{{link_to_system_arguments_docs}}"
|
1015
|
-
}
|
1016
|
-
],
|
1017
|
-
"slots": [
|
1087
|
+
"name": "active?",
|
1088
|
+
"description": "Returns the value of attribute active.\nWhether or not this item is active.",
|
1089
|
+
"parameters": [
|
1018
1090
|
|
1019
|
-
|
1020
|
-
|
1091
|
+
]
|
1092
|
+
},
|
1093
|
+
{
|
1094
|
+
"name": "disabled?",
|
1095
|
+
"description": "Returns the value of attribute disabled.\nWhether or not this item is disabled.",
|
1096
|
+
"parameters": [
|
1021
1097
|
|
1098
|
+
]
|
1099
|
+
}
|
1022
1100
|
],
|
1023
1101
|
"previews": [
|
1024
1102
|
|
@@ -1626,7 +1704,7 @@
|
|
1626
1704
|
"name": "system_arguments",
|
1627
1705
|
"type": "Hash",
|
1628
1706
|
"default": "N/A",
|
1629
|
-
"description": "
|
1707
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
1630
1708
|
}
|
1631
1709
|
]
|
1632
1710
|
},
|
@@ -1674,7 +1752,7 @@
|
|
1674
1752
|
"name": "system_arguments",
|
1675
1753
|
"type": "Hash",
|
1676
1754
|
"default": "N/A",
|
1677
|
-
"description": "
|
1755
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
1678
1756
|
}
|
1679
1757
|
]
|
1680
1758
|
}
|
@@ -2972,41 +3050,23 @@
|
|
2972
3050
|
],
|
2973
3051
|
"subcomponents": [
|
2974
3052
|
{
|
2975
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
2976
|
-
"description": "A `Dialog::
|
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}}.",
|
2977
3055
|
"is_form_component": false,
|
2978
3056
|
"is_published": true,
|
2979
3057
|
"requires_js": false,
|
2980
|
-
"component": "Dialog::
|
3058
|
+
"component": "Dialog::Footer",
|
2981
3059
|
"status": "alpha",
|
2982
3060
|
"a11y_reviewed": true,
|
2983
|
-
"short_name": "
|
2984
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
2985
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
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/",
|
2986
3064
|
"parameters": [
|
2987
|
-
{
|
2988
|
-
"name": "title",
|
2989
|
-
"type": "String",
|
2990
|
-
"default": "N/A",
|
2991
|
-
"description": "Describes the content of the dialog."
|
2992
|
-
},
|
2993
|
-
{
|
2994
|
-
"name": "subtitle",
|
2995
|
-
"type": "String",
|
2996
|
-
"default": "`nil`",
|
2997
|
-
"description": "Provides dditional context for the dialog, also setting the `aria-describedby` attribute."
|
2998
|
-
},
|
2999
3065
|
{
|
3000
3066
|
"name": "show_divider",
|
3001
3067
|
"type": "Boolean",
|
3002
3068
|
"default": "`false`",
|
3003
|
-
"description": "Show a divider between the
|
3004
|
-
},
|
3005
|
-
{
|
3006
|
-
"name": "visually_hide_title",
|
3007
|
-
"type": "Boolean",
|
3008
|
-
"default": "`false`",
|
3009
|
-
"description": "Visually hide the `title` while maintaining a label for assistive technologies."
|
3069
|
+
"description": "Show a divider between the footer and body."
|
3010
3070
|
},
|
3011
3071
|
{
|
3012
3072
|
"name": "system_arguments",
|
@@ -3029,24 +3089,18 @@
|
|
3029
3089
|
]
|
3030
3090
|
},
|
3031
3091
|
{
|
3032
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
3033
|
-
"description": "A `Dialog::
|
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}}.",
|
3034
3094
|
"is_form_component": false,
|
3035
3095
|
"is_published": true,
|
3036
3096
|
"requires_js": false,
|
3037
|
-
"component": "Dialog::
|
3097
|
+
"component": "Dialog::Body",
|
3038
3098
|
"status": "alpha",
|
3039
3099
|
"a11y_reviewed": true,
|
3040
|
-
"short_name": "
|
3041
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
3042
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
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/",
|
3043
3103
|
"parameters": [
|
3044
|
-
{
|
3045
|
-
"name": "show_divider",
|
3046
|
-
"type": "Boolean",
|
3047
|
-
"default": "`false`",
|
3048
|
-
"description": "Show a divider between the footer and body."
|
3049
|
-
},
|
3050
3104
|
{
|
3051
3105
|
"name": "system_arguments",
|
3052
3106
|
"type": "Hash",
|
@@ -3068,18 +3122,42 @@
|
|
3068
3122
|
]
|
3069
3123
|
},
|
3070
3124
|
{
|
3071
|
-
"fully_qualified_name": "Primer::Alpha::Dialog::
|
3072
|
-
"description": "A `Dialog::
|
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}}.",
|
3073
3127
|
"is_form_component": false,
|
3074
3128
|
"is_published": true,
|
3075
3129
|
"requires_js": false,
|
3076
|
-
"component": "Dialog::
|
3130
|
+
"component": "Dialog::Header",
|
3077
3131
|
"status": "alpha",
|
3078
3132
|
"a11y_reviewed": true,
|
3079
|
-
"short_name": "
|
3080
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/
|
3081
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/
|
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/",
|
3082
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
|
+
},
|
3083
3161
|
{
|
3084
3162
|
"name": "system_arguments",
|
3085
3163
|
"type": "Hash",
|
@@ -4787,14 +4865,14 @@
|
|
4787
4865
|
{
|
4788
4866
|
"name": "component_klass",
|
4789
4867
|
"type": "Class",
|
4790
|
-
"default": "
|
4791
|
-
"description": "The
|
4868
|
+
"default": "`Primer::Alpha::NavList::Item`",
|
4869
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
4792
4870
|
},
|
4793
4871
|
{
|
4794
4872
|
"name": "system_arguments",
|
4795
4873
|
"type": "Hash",
|
4796
4874
|
"default": "N/A",
|
4797
|
-
"description": "
|
4875
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
4798
4876
|
}
|
4799
4877
|
]
|
4800
4878
|
},
|
@@ -4829,20 +4907,20 @@
|
|
4829
4907
|
{
|
4830
4908
|
"name": "component_klass",
|
4831
4909
|
"type": "Class",
|
4832
|
-
"default": "
|
4833
|
-
"description": "The
|
4910
|
+
"default": "`Primer::Alpha::NavList::Item`",
|
4911
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
4834
4912
|
},
|
4835
4913
|
{
|
4836
4914
|
"name": "avatar_arguments",
|
4837
4915
|
"type": "Hash",
|
4838
4916
|
"default": "`{}`",
|
4839
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}
|
4917
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
4840
4918
|
},
|
4841
4919
|
{
|
4842
4920
|
"name": "system_arguments",
|
4843
4921
|
"type": "Hash",
|
4844
4922
|
"default": "N/A",
|
4845
|
-
"description": "
|
4923
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
4846
4924
|
}
|
4847
4925
|
]
|
4848
4926
|
},
|
@@ -4870,6 +4948,72 @@
|
|
4870
4948
|
}
|
4871
4949
|
]
|
4872
4950
|
},
|
4951
|
+
{
|
4952
|
+
"name": "build_item",
|
4953
|
+
"description": "Builds a new item but does not add it to the list. Use this method\ninstead of the `#with_item` slot if you need to render an item outside\nthe context of a list, eg. if rendering additional items to append to\nan existing list, perhaps via a separate HTTP request.",
|
4954
|
+
"parameters": [
|
4955
|
+
{
|
4956
|
+
"name": "component_klass",
|
4957
|
+
"type": "Class",
|
4958
|
+
"default": "`Primer::Alpha::NavList::Item`",
|
4959
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
4960
|
+
},
|
4961
|
+
{
|
4962
|
+
"name": "system_arguments",
|
4963
|
+
"type": "Hash",
|
4964
|
+
"default": "N/A",
|
4965
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
4966
|
+
}
|
4967
|
+
]
|
4968
|
+
},
|
4969
|
+
{
|
4970
|
+
"name": "build_avatar_item",
|
4971
|
+
"description": "Builds a new avatar item but does not add it to the list. Avatar items\nare a convenient way to accessibly add an item with a leading avatar\nimage. Use this method instead of the `#with_avatar_item` slot if you\nneed to render an avatar item outside the context of a list, eg. if\nrendering additional items to append to an existing list, perhaps via\na separate HTTP request.",
|
4972
|
+
"parameters": [
|
4973
|
+
{
|
4974
|
+
"name": "src",
|
4975
|
+
"type": "String",
|
4976
|
+
"default": "N/A",
|
4977
|
+
"description": "The source url of the avatar image."
|
4978
|
+
},
|
4979
|
+
{
|
4980
|
+
"name": "username",
|
4981
|
+
"type": "String",
|
4982
|
+
"default": "N/A",
|
4983
|
+
"description": "The username associated with the avatar."
|
4984
|
+
},
|
4985
|
+
{
|
4986
|
+
"name": "full_name",
|
4987
|
+
"type": "String",
|
4988
|
+
"default": "`nil`",
|
4989
|
+
"description": "Optional. The user's full name."
|
4990
|
+
},
|
4991
|
+
{
|
4992
|
+
"name": "full_name_scheme",
|
4993
|
+
"type": "Symbol",
|
4994
|
+
"default": "`:block`",
|
4995
|
+
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
4996
|
+
},
|
4997
|
+
{
|
4998
|
+
"name": "component_klass",
|
4999
|
+
"type": "Class",
|
5000
|
+
"default": "`Primer::Alpha::NavList::Item`",
|
5001
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
5002
|
+
},
|
5003
|
+
{
|
5004
|
+
"name": "avatar_arguments",
|
5005
|
+
"type": "Hash",
|
5006
|
+
"default": "`{}`",
|
5007
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
5008
|
+
},
|
5009
|
+
{
|
5010
|
+
"name": "system_arguments",
|
5011
|
+
"type": "Hash",
|
5012
|
+
"default": "N/A",
|
5013
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
5014
|
+
}
|
5015
|
+
]
|
5016
|
+
},
|
4873
5017
|
{
|
4874
5018
|
"name": "render_outer_list?",
|
4875
5019
|
"description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
|
@@ -4946,6 +5090,45 @@
|
|
4946
5090
|
}
|
4947
5091
|
],
|
4948
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
|
+
},
|
4949
5132
|
{
|
4950
5133
|
"fully_qualified_name": "Primer::Alpha::NavList::Heading",
|
4951
5134
|
"description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
|
@@ -5177,45 +5360,6 @@
|
|
5177
5360
|
|
5178
5361
|
]
|
5179
5362
|
},
|
5180
|
-
{
|
5181
|
-
"fully_qualified_name": "Primer::Alpha::NavList::Divider",
|
5182
|
-
"description": "Separator with optional text rendered above groups or between individual items.",
|
5183
|
-
"is_form_component": false,
|
5184
|
-
"is_published": true,
|
5185
|
-
"requires_js": false,
|
5186
|
-
"component": "NavList::Divider",
|
5187
|
-
"status": "alpha",
|
5188
|
-
"a11y_reviewed": false,
|
5189
|
-
"short_name": "NavListDivider",
|
5190
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
|
5191
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
|
5192
|
-
"parameters": [
|
5193
|
-
{
|
5194
|
-
"name": "scheme",
|
5195
|
-
"type": "Symbol",
|
5196
|
-
"default": "`:subtle`",
|
5197
|
-
"description": "Display a background color if scheme is `filled`."
|
5198
|
-
},
|
5199
|
-
{
|
5200
|
-
"name": "system_arguments",
|
5201
|
-
"type": "Hash",
|
5202
|
-
"default": "N/A",
|
5203
|
-
"description": "{{link_to_system_arguments_docs}}"
|
5204
|
-
}
|
5205
|
-
],
|
5206
|
-
"slots": [
|
5207
|
-
|
5208
|
-
],
|
5209
|
-
"methods": [
|
5210
|
-
|
5211
|
-
],
|
5212
|
-
"previews": [
|
5213
|
-
|
5214
|
-
],
|
5215
|
-
"subcomponents": [
|
5216
|
-
|
5217
|
-
]
|
5218
|
-
},
|
5219
5363
|
{
|
5220
5364
|
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
5221
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.",
|