openproject-primer_view_components 0.10.0 → 0.12.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +87 -0
- data/app/assets/javascripts/app/components/primer/primer.d.ts +1 -1
- data/app/assets/javascripts/primer_view_components.js +1 -1
- data/app/assets/javascripts/primer_view_components.js.map +1 -1
- data/app/assets/styles/primer_view_components.css +1 -1
- data/app/assets/styles/primer_view_components.css.map +1 -1
- data/app/components/primer/alpha/action_menu/action_menu_element.js +2 -1
- data/app/components/primer/alpha/action_menu/action_menu_element.ts +2 -1
- data/app/components/primer/alpha/check_box_group.rb +2 -0
- data/app/components/primer/alpha/dialog/header.rb +12 -0
- data/app/components/primer/alpha/dialog.rb +1 -1
- data/app/components/primer/alpha/nav_list/divider.rb +2 -5
- data/app/components/primer/alpha/nav_list/group.rb +2 -98
- data/app/components/primer/alpha/nav_list/heading.rb +2 -27
- data/app/components/primer/alpha/nav_list/item.rb +2 -147
- data/app/components/primer/alpha/nav_list.rb +2 -205
- data/app/components/primer/alpha/overlay.css +1 -1
- data/app/components/primer/alpha/overlay.css.map +1 -1
- data/app/components/primer/alpha/overlay.pcss +1 -7
- data/app/components/primer/alpha/overlay.rb +6 -4
- data/app/components/primer/alpha/radio_button_group.rb +2 -0
- data/app/components/primer/alpha/text_field.css +1 -1
- data/app/components/primer/alpha/text_field.css.json +4 -1
- data/app/components/primer/alpha/text_field.css.map +1 -1
- data/app/components/primer/alpha/text_field.pcss +18 -3
- data/app/components/primer/alpha/tooltip.rb +3 -1
- data/app/components/primer/beta/button.css +1 -1
- data/app/components/primer/beta/button.css.json +2 -0
- data/app/components/primer/beta/button.css.map +1 -1
- data/app/components/primer/beta/button.pcss +11 -3
- data/app/components/primer/beta/icon_button.html.erb +1 -1
- data/app/components/primer/beta/icon_button.rb +8 -1
- data/app/components/primer/beta/link.css +1 -1
- data/app/components/primer/beta/link.css.json +1 -0
- data/app/components/primer/beta/link.css.map +1 -1
- data/app/components/primer/beta/link.pcss +5 -0
- data/app/components/primer/beta/link.rb +2 -2
- data/app/components/primer/beta/nav_list/divider.rb +14 -0
- data/app/components/primer/beta/nav_list/group.rb +107 -0
- data/app/components/primer/beta/nav_list/heading.rb +36 -0
- data/app/components/primer/beta/nav_list/item.rb +156 -0
- data/app/components/primer/beta/nav_list.rb +212 -0
- data/app/components/primer/focus_group.js +2 -1
- data/app/components/primer/focus_group.ts +2 -1
- data/app/components/primer/open_project/border_grid/cell.html.erb +3 -0
- data/app/components/primer/open_project/border_grid/cell.rb +25 -0
- data/app/components/primer/open_project/border_grid.css +1 -0
- data/app/components/primer/open_project/border_grid.css.json +11 -0
- data/app/components/primer/open_project/border_grid.css.map +1 -0
- data/app/components/primer/open_project/border_grid.html.erb +7 -0
- data/app/components/primer/open_project/border_grid.pcss +35 -0
- data/app/components/primer/open_project/border_grid.rb +36 -0
- data/app/components/primer/open_project/drag_handle.css +1 -0
- data/app/components/primer/open_project/drag_handle.css.json +6 -0
- data/app/components/primer/open_project/drag_handle.css.map +1 -0
- data/app/components/primer/open_project/drag_handle.html.erb +6 -0
- data/app/components/primer/open_project/drag_handle.pcss +6 -0
- data/app/components/primer/open_project/drag_handle.rb +28 -0
- data/app/components/primer/open_project/flex_layout.html.erb +23 -0
- data/app/components/primer/open_project/flex_layout.rb +52 -0
- data/app/components/primer/open_project/grid_layout/area.rb +38 -0
- data/app/components/primer/open_project/grid_layout.html.erb +11 -0
- data/app/components/primer/open_project/grid_layout.rb +34 -0
- data/app/components/primer/open_project/page_header.css +1 -1
- data/app/components/primer/open_project/page_header.css.map +1 -1
- data/app/components/primer/open_project/page_header.pcss +4 -0
- data/app/components/primer/primer.d.ts +1 -1
- data/app/components/primer/primer.js +1 -1
- data/app/components/primer/primer.pcss +2 -0
- data/app/components/primer/primer.ts +1 -1
- data/app/helpers/primer/form_helper.rb +10 -0
- data/lib/primer/deprecations.yml +20 -0
- data/lib/primer/forms/check_box_group.html.erb +3 -0
- data/lib/primer/forms/dsl/check_box_group_input.rb +1 -5
- data/lib/primer/forms/dsl/check_box_input.rb +5 -0
- data/lib/primer/forms/dsl/radio_button_input.rb +5 -0
- data/lib/primer/forms/form_control.html.erb +1 -4
- data/lib/primer/forms/radio_button_group.html.erb +3 -0
- data/lib/primer/forms/utils.rb +2 -0
- data/lib/primer/forms/validation_message.html.erb +4 -0
- data/lib/primer/forms/validation_message.rb +14 -0
- data/lib/primer/forms.rb +16 -0
- data/lib/primer/view_components/version.rb +2 -2
- data/lib/primer/yard/component_manifest.rb +4 -0
- data/previews/primer/alpha/check_box_group_preview.rb +13 -0
- data/previews/primer/alpha/dialog_preview/with_header.html.erb +5 -0
- data/previews/primer/alpha/dialog_preview.rb +17 -0
- data/previews/primer/alpha/overlay_preview.rb +1 -1
- data/previews/primer/alpha/radio_button_group_preview.rb +13 -0
- data/previews/primer/alpha/radio_button_preview.rb +1 -1
- data/previews/primer/alpha/text_field_preview/input_group_leading_action_menu.html.erb +21 -0
- data/previews/primer/alpha/text_field_preview/input_group_leading_button.html.erb +18 -0
- data/previews/primer/alpha/text_field_preview/input_group_trailing_button.html.erb +18 -0
- data/previews/primer/alpha/text_field_preview.rb +21 -0
- data/previews/primer/beta/button_preview.rb +1 -1
- data/previews/primer/{alpha → beta}/nav_list_preview/trailing_action.html.erb +1 -1
- data/previews/primer/{alpha → beta}/nav_list_preview.rb +5 -5
- data/previews/primer/open_project/border_grid_preview.rb +42 -0
- data/previews/primer/open_project/drag_handle_preview.rb +23 -0
- data/previews/primer/open_project/flex_layout_preview.rb +73 -0
- data/previews/primer/open_project/grid_layout_preview.rb +37 -0
- data/static/arguments.json +314 -6
- data/static/audited_at.json +11 -0
- data/static/classes.json +18 -0
- data/static/constants.json +48 -0
- data/static/info_arch.json +1867 -955
- data/static/previews.json +273 -7
- data/static/statuses.json +16 -5
- metadata +46 -11
- /data/app/assets/javascripts/app/components/primer/{alpha → beta}/nav_list.d.ts +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list/group.html.erb +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list/item.html.erb +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.d.ts +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.html.erb +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.js +0 -0
- /data/app/components/primer/{alpha → beta}/nav_list.ts +0 -0
data/static/info_arch.json
CHANGED
@@ -2686,6 +2686,18 @@
|
|
2686
2686
|
"default": "N/A",
|
2687
2687
|
"description": "A string describing the field and what sorts of input it expects. Displayed below the group."
|
2688
2688
|
},
|
2689
|
+
{
|
2690
|
+
"name": "invalid",
|
2691
|
+
"type": "Boolean",
|
2692
|
+
"default": "N/A",
|
2693
|
+
"description": "If set to `true`, the input will be marked as invalid. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
|
2694
|
+
},
|
2695
|
+
{
|
2696
|
+
"name": "validation_message",
|
2697
|
+
"type": "String",
|
2698
|
+
"default": "N/A",
|
2699
|
+
"description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
|
2700
|
+
},
|
2689
2701
|
{
|
2690
2702
|
"name": "label_arguments",
|
2691
2703
|
"type": "Hash",
|
@@ -2743,6 +2755,19 @@
|
|
2743
2755
|
]
|
2744
2756
|
}
|
2745
2757
|
},
|
2758
|
+
{
|
2759
|
+
"preview_path": "primer/alpha/check_box_group/invalid",
|
2760
|
+
"name": "invalid",
|
2761
|
+
"snapshot": "false",
|
2762
|
+
"skip_rules": {
|
2763
|
+
"wont_fix": [
|
2764
|
+
"region"
|
2765
|
+
],
|
2766
|
+
"will_fix": [
|
2767
|
+
"color-contrast"
|
2768
|
+
]
|
2769
|
+
}
|
2770
|
+
},
|
2746
2771
|
{
|
2747
2772
|
"preview_path": "primer/alpha/check_box_group/with_caption",
|
2748
2773
|
"name": "with_caption",
|
@@ -2896,7 +2921,7 @@
|
|
2896
2921
|
"name": "system_arguments",
|
2897
2922
|
"type": "Hash",
|
2898
2923
|
"default": "N/A",
|
2899
|
-
"description": "{{
|
2924
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Dialog::Header{{/link_to_component}}."
|
2900
2925
|
}
|
2901
2926
|
]
|
2902
2927
|
},
|
@@ -2980,6 +3005,19 @@
|
|
2980
3005
|
]
|
2981
3006
|
}
|
2982
3007
|
},
|
3008
|
+
{
|
3009
|
+
"preview_path": "primer/alpha/dialog/with_header",
|
3010
|
+
"name": "with_header",
|
3011
|
+
"snapshot": "false",
|
3012
|
+
"skip_rules": {
|
3013
|
+
"wont_fix": [
|
3014
|
+
"region"
|
3015
|
+
],
|
3016
|
+
"will_fix": [
|
3017
|
+
"color-contrast"
|
3018
|
+
]
|
3019
|
+
}
|
3020
|
+
},
|
2983
3021
|
{
|
2984
3022
|
"preview_path": "primer/alpha/dialog/with_footer",
|
2985
3023
|
"name": "with_footer",
|
@@ -3074,6 +3112,12 @@
|
|
3074
3112
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog/header.rb",
|
3075
3113
|
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/header/default/",
|
3076
3114
|
"parameters": [
|
3115
|
+
{
|
3116
|
+
"name": "id",
|
3117
|
+
"type": "String",
|
3118
|
+
"default": "N/A",
|
3119
|
+
"description": "The HTML element's ID value."
|
3120
|
+
},
|
3077
3121
|
{
|
3078
3122
|
"name": "title",
|
3079
3123
|
"type": "String",
|
@@ -3098,6 +3142,12 @@
|
|
3098
3142
|
"default": "`false`",
|
3099
3143
|
"description": "Visually hide the `title` while maintaining a label for assistive technologies."
|
3100
3144
|
},
|
3145
|
+
{
|
3146
|
+
"name": "variant",
|
3147
|
+
"type": "Symbol",
|
3148
|
+
"default": "`:medium`",
|
3149
|
+
"description": "One of `:large` or `:medium`."
|
3150
|
+
},
|
3101
3151
|
{
|
3102
3152
|
"name": "system_arguments",
|
3103
3153
|
"type": "Hash",
|
@@ -4845,13 +4895,13 @@
|
|
4845
4895
|
},
|
4846
4896
|
{
|
4847
4897
|
"fully_qualified_name": "Primer::Alpha::NavList",
|
4848
|
-
"description": "
|
4898
|
+
"description": "",
|
4849
4899
|
"accessibility_docs": null,
|
4850
4900
|
"is_form_component": false,
|
4851
4901
|
"is_published": true,
|
4852
4902
|
"requires_js": true,
|
4853
4903
|
"component": "NavList",
|
4854
|
-
"status": "
|
4904
|
+
"status": "deprecated",
|
4855
4905
|
"a11y_reviewed": true,
|
4856
4906
|
"short_name": "NavList",
|
4857
4907
|
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
|
@@ -4873,7 +4923,7 @@
|
|
4873
4923
|
"slots": [
|
4874
4924
|
{
|
4875
4925
|
"name": "heading",
|
4876
|
-
"description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::
|
4926
|
+
"description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Heading{{/link_to_component}}.",
|
4877
4927
|
"parameters": [
|
4878
4928
|
|
4879
4929
|
]
|
@@ -4887,269 +4937,203 @@
|
|
4887
4937
|
}
|
4888
4938
|
],
|
4889
4939
|
"methods": [
|
4940
|
+
|
4941
|
+
],
|
4942
|
+
"previews": [
|
4943
|
+
|
4944
|
+
],
|
4945
|
+
"subcomponents": [
|
4890
4946
|
{
|
4891
|
-
"
|
4892
|
-
"description": "
|
4947
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Item",
|
4948
|
+
"description": "",
|
4949
|
+
"accessibility_docs": null,
|
4950
|
+
"is_form_component": false,
|
4951
|
+
"is_published": true,
|
4952
|
+
"requires_js": true,
|
4953
|
+
"component": "NavList::Item",
|
4954
|
+
"status": "deprecated",
|
4955
|
+
"a11y_reviewed": false,
|
4956
|
+
"short_name": "NavListItem",
|
4957
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
|
4958
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
|
4893
4959
|
"parameters": [
|
4894
4960
|
{
|
4895
|
-
"name": "
|
4896
|
-
"type": "
|
4897
|
-
"default": "`
|
4898
|
-
"description": "The
|
4961
|
+
"name": "selected_item_id",
|
4962
|
+
"type": "Symbol",
|
4963
|
+
"default": "`nil`",
|
4964
|
+
"description": "The ID of the currently selected list item. Used internally."
|
4965
|
+
},
|
4966
|
+
{
|
4967
|
+
"name": "selected_by_ids",
|
4968
|
+
"type": "Array<Symbol>",
|
4969
|
+
"default": "`[]`",
|
4970
|
+
"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."
|
4971
|
+
},
|
4972
|
+
{
|
4973
|
+
"name": "expanded",
|
4974
|
+
"type": "Boolean",
|
4975
|
+
"default": "`false`",
|
4976
|
+
"description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
|
4977
|
+
},
|
4978
|
+
{
|
4979
|
+
"name": "sub_item",
|
4980
|
+
"type": "Boolean",
|
4981
|
+
"default": "`false`",
|
4982
|
+
"description": "Whether or not this item is nested under a parent item. Used internally."
|
4899
4983
|
},
|
4900
4984
|
{
|
4901
4985
|
"name": "system_arguments",
|
4902
4986
|
"type": "Hash",
|
4903
4987
|
"default": "N/A",
|
4904
|
-
"description": "
|
4988
|
+
"description": "{{link_to_system_arguments_docs}}"
|
4905
4989
|
}
|
4906
|
-
]
|
4907
|
-
|
4908
|
-
{
|
4909
|
-
"name": "with_avatar_item",
|
4910
|
-
"description": "Adds an avatar item to the list. Avatar items are a convenient way to accessibly add an item with a leading avatar image.",
|
4911
|
-
"parameters": [
|
4912
|
-
{
|
4913
|
-
"name": "src",
|
4914
|
-
"type": "String",
|
4915
|
-
"default": "N/A",
|
4916
|
-
"description": "The source url of the avatar image."
|
4917
|
-
},
|
4990
|
+
],
|
4991
|
+
"slots": [
|
4918
4992
|
{
|
4919
|
-
"name": "
|
4920
|
-
"
|
4921
|
-
"
|
4922
|
-
|
4993
|
+
"name": "items",
|
4994
|
+
"description": null,
|
4995
|
+
"parameters": [
|
4996
|
+
{
|
4997
|
+
"name": "system_arguments",
|
4998
|
+
"type": "Hash",
|
4999
|
+
"default": "N/A",
|
5000
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Item{{/link_to_component}}."
|
5001
|
+
}
|
5002
|
+
]
|
4923
5003
|
},
|
4924
5004
|
{
|
4925
|
-
"name": "
|
4926
|
-
"
|
4927
|
-
"
|
4928
|
-
|
5005
|
+
"name": "description",
|
5006
|
+
"description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
|
5007
|
+
"parameters": [
|
5008
|
+
|
5009
|
+
]
|
4929
5010
|
},
|
4930
5011
|
{
|
4931
|
-
"name": "
|
4932
|
-
"
|
4933
|
-
"
|
4934
|
-
|
5012
|
+
"name": "leading_visual",
|
5013
|
+
"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.",
|
5014
|
+
"parameters": [
|
5015
|
+
|
5016
|
+
]
|
4935
5017
|
},
|
4936
5018
|
{
|
4937
|
-
"name": "
|
4938
|
-
"
|
4939
|
-
"
|
4940
|
-
|
5019
|
+
"name": "trailing_visual",
|
5020
|
+
"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```",
|
5021
|
+
"parameters": [
|
5022
|
+
|
5023
|
+
]
|
4941
5024
|
},
|
4942
5025
|
{
|
4943
|
-
"name": "
|
4944
|
-
"
|
4945
|
-
"
|
4946
|
-
|
5026
|
+
"name": "trailing_action",
|
5027
|
+
"description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
|
5028
|
+
"parameters": [
|
5029
|
+
{
|
5030
|
+
"name": "system_arguments",
|
5031
|
+
"type": "Hash",
|
5032
|
+
"default": "N/A",
|
5033
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
|
5034
|
+
}
|
5035
|
+
]
|
4947
5036
|
},
|
4948
5037
|
{
|
4949
|
-
"name": "
|
4950
|
-
"
|
4951
|
-
"
|
4952
|
-
|
5038
|
+
"name": "tooltip",
|
5039
|
+
"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.",
|
5040
|
+
"parameters": [
|
5041
|
+
{
|
5042
|
+
"name": "type",
|
5043
|
+
"type": "Symbol",
|
5044
|
+
"default": "`:description`",
|
5045
|
+
"description": "One of `:description` or `:label`."
|
5046
|
+
},
|
5047
|
+
{
|
5048
|
+
"name": "system_arguments",
|
5049
|
+
"type": "Hash",
|
5050
|
+
"default": "N/A",
|
5051
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
|
5052
|
+
}
|
5053
|
+
]
|
4953
5054
|
}
|
5055
|
+
],
|
5056
|
+
"methods": [
|
5057
|
+
|
5058
|
+
],
|
5059
|
+
"previews": [
|
5060
|
+
|
5061
|
+
],
|
5062
|
+
"subcomponents": [
|
5063
|
+
|
4954
5064
|
]
|
4955
5065
|
},
|
4956
5066
|
{
|
4957
|
-
"
|
4958
|
-
"description": "
|
5067
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Heading",
|
5068
|
+
"description": "",
|
5069
|
+
"accessibility_docs": null,
|
5070
|
+
"is_form_component": false,
|
5071
|
+
"is_published": true,
|
5072
|
+
"requires_js": false,
|
5073
|
+
"component": "NavList::Heading",
|
5074
|
+
"status": "deprecated",
|
5075
|
+
"a11y_reviewed": false,
|
5076
|
+
"short_name": "NavListHeading",
|
5077
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb",
|
5078
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/",
|
4959
5079
|
"parameters": [
|
4960
5080
|
{
|
4961
|
-
"name": "
|
4962
|
-
"type": "
|
5081
|
+
"name": "title",
|
5082
|
+
"type": "String",
|
4963
5083
|
"default": "N/A",
|
4964
|
-
"description": "The
|
4965
|
-
}
|
4966
|
-
|
4967
|
-
|
4968
|
-
|
4969
|
-
|
4970
|
-
|
4971
|
-
|
5084
|
+
"description": "The text content of the heading."
|
5085
|
+
},
|
5086
|
+
{
|
5087
|
+
"name": "id",
|
5088
|
+
"type": "String",
|
5089
|
+
"default": "`self.class.generate_id`",
|
5090
|
+
"description": "The value of the ID HTML attribute. Auto-generated by default."
|
5091
|
+
},
|
5092
|
+
{
|
5093
|
+
"name": "heading_level",
|
5094
|
+
"type": "Integer",
|
5095
|
+
"default": "`2`",
|
5096
|
+
"description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
|
5097
|
+
},
|
4972
5098
|
{
|
4973
5099
|
"name": "system_arguments",
|
4974
5100
|
"type": "Hash",
|
4975
5101
|
"default": "N/A",
|
4976
|
-
"description": "
|
5102
|
+
"description": "{{link_to_system_arguments_docs}}"
|
4977
5103
|
}
|
5104
|
+
],
|
5105
|
+
"slots": [
|
5106
|
+
|
5107
|
+
],
|
5108
|
+
"methods": [
|
5109
|
+
|
5110
|
+
],
|
5111
|
+
"previews": [
|
5112
|
+
|
5113
|
+
],
|
5114
|
+
"subcomponents": [
|
5115
|
+
|
4978
5116
|
]
|
4979
5117
|
},
|
4980
5118
|
{
|
4981
|
-
"
|
4982
|
-
"description": "
|
5119
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Divider",
|
5120
|
+
"description": "",
|
5121
|
+
"accessibility_docs": null,
|
5122
|
+
"is_form_component": false,
|
5123
|
+
"is_published": true,
|
5124
|
+
"requires_js": false,
|
5125
|
+
"component": "NavList::Divider",
|
5126
|
+
"status": "deprecated",
|
5127
|
+
"a11y_reviewed": false,
|
5128
|
+
"short_name": "NavListDivider",
|
5129
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
|
5130
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
|
4983
5131
|
"parameters": [
|
4984
5132
|
{
|
4985
|
-
"name": "
|
4986
|
-
"type": "
|
4987
|
-
"default": "`
|
4988
|
-
"description": "
|
4989
|
-
},
|
4990
|
-
{
|
4991
|
-
"name": "system_arguments",
|
4992
|
-
"type": "Hash",
|
4993
|
-
"default": "N/A",
|
4994
|
-
"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."
|
4995
|
-
}
|
4996
|
-
]
|
4997
|
-
},
|
4998
|
-
{
|
4999
|
-
"name": "build_avatar_item",
|
5000
|
-
"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.",
|
5001
|
-
"parameters": [
|
5002
|
-
{
|
5003
|
-
"name": "src",
|
5004
|
-
"type": "String",
|
5005
|
-
"default": "N/A",
|
5006
|
-
"description": "The source url of the avatar image."
|
5007
|
-
},
|
5008
|
-
{
|
5009
|
-
"name": "username",
|
5010
|
-
"type": "String",
|
5011
|
-
"default": "N/A",
|
5012
|
-
"description": "The username associated with the avatar."
|
5013
|
-
},
|
5014
|
-
{
|
5015
|
-
"name": "full_name",
|
5016
|
-
"type": "String",
|
5017
|
-
"default": "`nil`",
|
5018
|
-
"description": "Optional. The user's full name."
|
5019
|
-
},
|
5020
|
-
{
|
5021
|
-
"name": "full_name_scheme",
|
5022
|
-
"type": "Symbol",
|
5023
|
-
"default": "`:block`",
|
5024
|
-
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
5025
|
-
},
|
5026
|
-
{
|
5027
|
-
"name": "component_klass",
|
5028
|
-
"type": "Class",
|
5029
|
-
"default": "`Primer::Alpha::NavList::Item`",
|
5030
|
-
"description": "The class to use instead of the default {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}"
|
5031
|
-
},
|
5032
|
-
{
|
5033
|
-
"name": "avatar_arguments",
|
5034
|
-
"type": "Hash",
|
5035
|
-
"default": "`{}`",
|
5036
|
-
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
5037
|
-
},
|
5038
|
-
{
|
5039
|
-
"name": "system_arguments",
|
5040
|
-
"type": "Hash",
|
5041
|
-
"default": "N/A",
|
5042
|
-
"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."
|
5043
|
-
}
|
5044
|
-
]
|
5045
|
-
},
|
5046
|
-
{
|
5047
|
-
"name": "render_outer_list?",
|
5048
|
-
"description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
|
5049
|
-
"parameters": [
|
5050
|
-
|
5051
|
-
]
|
5052
|
-
}
|
5053
|
-
],
|
5054
|
-
"previews": [
|
5055
|
-
{
|
5056
|
-
"preview_path": "primer/alpha/nav_list/playground",
|
5057
|
-
"name": "playground",
|
5058
|
-
"snapshot": "false",
|
5059
|
-
"skip_rules": {
|
5060
|
-
"wont_fix": [
|
5061
|
-
"region"
|
5062
|
-
],
|
5063
|
-
"will_fix": [
|
5064
|
-
"color-contrast"
|
5065
|
-
]
|
5066
|
-
}
|
5067
|
-
},
|
5068
|
-
{
|
5069
|
-
"preview_path": "primer/alpha/nav_list/default",
|
5070
|
-
"name": "default",
|
5071
|
-
"snapshot": "true",
|
5072
|
-
"skip_rules": {
|
5073
|
-
"wont_fix": [
|
5074
|
-
"region"
|
5075
|
-
],
|
5076
|
-
"will_fix": [
|
5077
|
-
"color-contrast"
|
5078
|
-
]
|
5079
|
-
}
|
5080
|
-
},
|
5081
|
-
{
|
5082
|
-
"preview_path": "primer/alpha/nav_list/top_level_items",
|
5083
|
-
"name": "top_level_items",
|
5084
|
-
"snapshot": "false",
|
5085
|
-
"skip_rules": {
|
5086
|
-
"wont_fix": [
|
5087
|
-
"region"
|
5088
|
-
],
|
5089
|
-
"will_fix": [
|
5090
|
-
"color-contrast"
|
5091
|
-
]
|
5092
|
-
}
|
5093
|
-
},
|
5094
|
-
{
|
5095
|
-
"preview_path": "primer/alpha/nav_list/show_more_item",
|
5096
|
-
"name": "show_more_item",
|
5097
|
-
"snapshot": "true",
|
5098
|
-
"skip_rules": {
|
5099
|
-
"wont_fix": [
|
5100
|
-
"region"
|
5101
|
-
],
|
5102
|
-
"will_fix": [
|
5103
|
-
"color-contrast"
|
5104
|
-
]
|
5105
|
-
}
|
5106
|
-
},
|
5107
|
-
{
|
5108
|
-
"preview_path": "primer/alpha/nav_list/trailing_action",
|
5109
|
-
"name": "trailing_action",
|
5110
|
-
"snapshot": "true",
|
5111
|
-
"skip_rules": {
|
5112
|
-
"wont_fix": [
|
5113
|
-
"region"
|
5114
|
-
],
|
5115
|
-
"will_fix": [
|
5116
|
-
"color-contrast"
|
5117
|
-
]
|
5118
|
-
}
|
5119
|
-
}
|
5120
|
-
],
|
5121
|
-
"subcomponents": [
|
5122
|
-
{
|
5123
|
-
"fully_qualified_name": "Primer::Alpha::NavList::Heading",
|
5124
|
-
"description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Alpha::NavList{{/link_to_component}} for usage examples.",
|
5125
|
-
"accessibility_docs": null,
|
5126
|
-
"is_form_component": false,
|
5127
|
-
"is_published": true,
|
5128
|
-
"requires_js": false,
|
5129
|
-
"component": "NavList::Heading",
|
5130
|
-
"status": "alpha",
|
5131
|
-
"a11y_reviewed": false,
|
5132
|
-
"short_name": "NavListHeading",
|
5133
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/heading.rb",
|
5134
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/heading/default/",
|
5135
|
-
"parameters": [
|
5136
|
-
{
|
5137
|
-
"name": "title",
|
5138
|
-
"type": "String",
|
5139
|
-
"default": "N/A",
|
5140
|
-
"description": "The text content of the heading."
|
5141
|
-
},
|
5142
|
-
{
|
5143
|
-
"name": "id",
|
5144
|
-
"type": "String",
|
5145
|
-
"default": "`self.class.generate_id`",
|
5146
|
-
"description": "The value of the ID HTML attribute. Auto-generated by default."
|
5147
|
-
},
|
5148
|
-
{
|
5149
|
-
"name": "heading_level",
|
5150
|
-
"type": "Integer",
|
5151
|
-
"default": "`2`",
|
5152
|
-
"description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
|
5133
|
+
"name": "scheme",
|
5134
|
+
"type": "Symbol",
|
5135
|
+
"default": "`:subtle`",
|
5136
|
+
"description": "Display a background color if scheme is `filled`."
|
5153
5137
|
},
|
5154
5138
|
{
|
5155
5139
|
"name": "system_arguments",
|
@@ -5162,34 +5146,7 @@
|
|
5162
5146
|
|
5163
5147
|
],
|
5164
5148
|
"methods": [
|
5165
|
-
{
|
5166
|
-
"name": "title",
|
5167
|
-
"description": "Returns the value of attribute title.",
|
5168
|
-
"parameters": [
|
5169
|
-
|
5170
|
-
]
|
5171
|
-
},
|
5172
|
-
{
|
5173
|
-
"name": "id",
|
5174
|
-
"description": "Returns the value of attribute id.",
|
5175
|
-
"parameters": [
|
5176
|
-
|
5177
|
-
]
|
5178
|
-
},
|
5179
|
-
{
|
5180
|
-
"name": "heading_level",
|
5181
|
-
"description": "Returns the value of attribute heading_level.",
|
5182
|
-
"parameters": [
|
5183
|
-
|
5184
|
-
]
|
5185
|
-
},
|
5186
|
-
{
|
5187
|
-
"name": "system_arguments",
|
5188
|
-
"description": "Returns the value of attribute system_arguments.",
|
5189
|
-
"parameters": [
|
5190
5149
|
|
5191
|
-
]
|
5192
|
-
}
|
5193
5150
|
],
|
5194
5151
|
"previews": [
|
5195
5152
|
|
@@ -5199,42 +5156,24 @@
|
|
5199
5156
|
]
|
5200
5157
|
},
|
5201
5158
|
{
|
5202
|
-
"fully_qualified_name": "Primer::Alpha::NavList::
|
5203
|
-
"description": "
|
5159
|
+
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
5160
|
+
"description": "",
|
5204
5161
|
"accessibility_docs": null,
|
5205
5162
|
"is_form_component": false,
|
5206
5163
|
"is_published": true,
|
5207
5164
|
"requires_js": true,
|
5208
|
-
"component": "NavList::
|
5209
|
-
"status": "
|
5210
|
-
"a11y_reviewed":
|
5211
|
-
"short_name": "
|
5212
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/
|
5213
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/
|
5165
|
+
"component": "NavList::Group",
|
5166
|
+
"status": "deprecated",
|
5167
|
+
"a11y_reviewed": true,
|
5168
|
+
"short_name": "NavListGroup",
|
5169
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
|
5170
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
|
5214
5171
|
"parameters": [
|
5215
5172
|
{
|
5216
5173
|
"name": "selected_item_id",
|
5217
5174
|
"type": "Symbol",
|
5218
5175
|
"default": "`nil`",
|
5219
|
-
"description": "The ID of the currently selected
|
5220
|
-
},
|
5221
|
-
{
|
5222
|
-
"name": "selected_by_ids",
|
5223
|
-
"type": "Array<Symbol>",
|
5224
|
-
"default": "`[]`",
|
5225
|
-
"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."
|
5226
|
-
},
|
5227
|
-
{
|
5228
|
-
"name": "expanded",
|
5229
|
-
"type": "Boolean",
|
5230
|
-
"default": "`false`",
|
5231
|
-
"description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
|
5232
|
-
},
|
5233
|
-
{
|
5234
|
-
"name": "sub_item",
|
5235
|
-
"type": "Boolean",
|
5236
|
-
"default": "`false`",
|
5237
|
-
"description": "Whether or not this item is nested under a parent item. Used internally."
|
5176
|
+
"description": "The ID of the currently selected item. Used internally."
|
5238
5177
|
},
|
5239
5178
|
{
|
5240
5179
|
"name": "system_arguments",
|
@@ -5245,226 +5184,50 @@
|
|
5245
5184
|
],
|
5246
5185
|
"slots": [
|
5247
5186
|
{
|
5248
|
-
"name": "
|
5249
|
-
"description":
|
5187
|
+
"name": "show_more_item",
|
5188
|
+
"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.",
|
5250
5189
|
"parameters": [
|
5190
|
+
{
|
5191
|
+
"name": "src",
|
5192
|
+
"type": "String",
|
5193
|
+
"default": "N/A",
|
5194
|
+
"description": "The URL to query for additional pages of list items."
|
5195
|
+
},
|
5196
|
+
{
|
5197
|
+
"name": "pages",
|
5198
|
+
"type": "Integer",
|
5199
|
+
"default": "N/A",
|
5200
|
+
"description": "The total number of pages in the result set."
|
5201
|
+
},
|
5202
|
+
{
|
5203
|
+
"name": "component_klass",
|
5204
|
+
"type": "Class",
|
5205
|
+
"default": "N/A",
|
5206
|
+
"description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
|
5207
|
+
},
|
5251
5208
|
{
|
5252
5209
|
"name": "system_arguments",
|
5253
5210
|
"type": "Hash",
|
5254
5211
|
"default": "N/A",
|
5255
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::
|
5212
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
5256
5213
|
}
|
5257
5214
|
]
|
5258
5215
|
},
|
5259
5216
|
{
|
5260
|
-
"name": "
|
5261
|
-
"description": "
|
5217
|
+
"name": "items",
|
5218
|
+
"description": "Items.",
|
5262
5219
|
"parameters": [
|
5263
|
-
|
5220
|
+
{
|
5221
|
+
"name": "system_arguments",
|
5222
|
+
"type": "Hash",
|
5223
|
+
"default": "N/A",
|
5224
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
5225
|
+
}
|
5264
5226
|
]
|
5265
5227
|
},
|
5266
5228
|
{
|
5267
|
-
"name": "
|
5268
|
-
"description": "
|
5269
|
-
"parameters": [
|
5270
|
-
|
5271
|
-
]
|
5272
|
-
},
|
5273
|
-
{
|
5274
|
-
"name": "trailing_visual",
|
5275
|
-
"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```",
|
5276
|
-
"parameters": [
|
5277
|
-
|
5278
|
-
]
|
5279
|
-
},
|
5280
|
-
{
|
5281
|
-
"name": "trailing_action",
|
5282
|
-
"description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
|
5283
|
-
"parameters": [
|
5284
|
-
{
|
5285
|
-
"name": "system_arguments",
|
5286
|
-
"type": "Hash",
|
5287
|
-
"default": "N/A",
|
5288
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
|
5289
|
-
}
|
5290
|
-
]
|
5291
|
-
},
|
5292
|
-
{
|
5293
|
-
"name": "tooltip",
|
5294
|
-
"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.",
|
5295
|
-
"parameters": [
|
5296
|
-
{
|
5297
|
-
"name": "type",
|
5298
|
-
"type": "Symbol",
|
5299
|
-
"default": "`:description`",
|
5300
|
-
"description": "One of `:description` or `:label`."
|
5301
|
-
},
|
5302
|
-
{
|
5303
|
-
"name": "system_arguments",
|
5304
|
-
"type": "Hash",
|
5305
|
-
"default": "N/A",
|
5306
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
|
5307
|
-
}
|
5308
|
-
]
|
5309
|
-
}
|
5310
|
-
],
|
5311
|
-
"methods": [
|
5312
|
-
{
|
5313
|
-
"name": "selected_by_ids",
|
5314
|
-
"description": "Returns the value of attribute selected_by_ids.",
|
5315
|
-
"parameters": [
|
5316
|
-
|
5317
|
-
]
|
5318
|
-
},
|
5319
|
-
{
|
5320
|
-
"name": "sub_item",
|
5321
|
-
"description": "Returns the value of attribute sub_item.",
|
5322
|
-
"parameters": [
|
5323
|
-
|
5324
|
-
]
|
5325
|
-
},
|
5326
|
-
{
|
5327
|
-
"name": "sub_item?",
|
5328
|
-
"description": "Returns the value of attribute sub_item.\nWhether or not this item is nested under a parent item.",
|
5329
|
-
"parameters": [
|
5330
|
-
|
5331
|
-
]
|
5332
|
-
},
|
5333
|
-
{
|
5334
|
-
"name": "expand!",
|
5335
|
-
"description": "Cause this item to show its list of sub items when rendered.",
|
5336
|
-
"parameters": [
|
5337
|
-
|
5338
|
-
]
|
5339
|
-
},
|
5340
|
-
{
|
5341
|
-
"name": "item_active?",
|
5342
|
-
"description": "Normally it would be easier to simply ask each item for its active status, eg.\nitems.any?(&:active?), but unfortunately the view context is not set on each\nitem until _after_ the parent's before_render, etc methods have been called.\nThis means helper methods like current_page? will blow up with an error, since\n`helpers` is simply an alias for the view context (i.e. an instance of\nActionView::Base). Since we know the view context for the parent object must\nbe set before `before_render` is invoked, we can call helper methods here in\nthe parent and bypass the problem entirely. Maybe not the most OO approach,\nbut it works.",
|
5343
|
-
"parameters": [
|
5344
|
-
|
5345
|
-
]
|
5346
|
-
}
|
5347
|
-
],
|
5348
|
-
"previews": [
|
5349
|
-
|
5350
|
-
],
|
5351
|
-
"subcomponents": [
|
5352
|
-
|
5353
|
-
]
|
5354
|
-
},
|
5355
|
-
{
|
5356
|
-
"fully_qualified_name": "Primer::Alpha::NavList::Divider",
|
5357
|
-
"description": "Separator with optional text rendered above groups or between individual items.",
|
5358
|
-
"accessibility_docs": null,
|
5359
|
-
"is_form_component": false,
|
5360
|
-
"is_published": true,
|
5361
|
-
"requires_js": false,
|
5362
|
-
"component": "NavList::Divider",
|
5363
|
-
"status": "alpha",
|
5364
|
-
"a11y_reviewed": false,
|
5365
|
-
"short_name": "NavListDivider",
|
5366
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/divider.rb",
|
5367
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/divider/default/",
|
5368
|
-
"parameters": [
|
5369
|
-
{
|
5370
|
-
"name": "scheme",
|
5371
|
-
"type": "Symbol",
|
5372
|
-
"default": "`:subtle`",
|
5373
|
-
"description": "Display a background color if scheme is `filled`."
|
5374
|
-
},
|
5375
|
-
{
|
5376
|
-
"name": "system_arguments",
|
5377
|
-
"type": "Hash",
|
5378
|
-
"default": "N/A",
|
5379
|
-
"description": "{{link_to_system_arguments_docs}}"
|
5380
|
-
}
|
5381
|
-
],
|
5382
|
-
"slots": [
|
5383
|
-
|
5384
|
-
],
|
5385
|
-
"methods": [
|
5386
|
-
|
5387
|
-
],
|
5388
|
-
"previews": [
|
5389
|
-
|
5390
|
-
],
|
5391
|
-
"subcomponents": [
|
5392
|
-
|
5393
|
-
]
|
5394
|
-
},
|
5395
|
-
{
|
5396
|
-
"fully_qualified_name": "Primer::Alpha::NavList::Group",
|
5397
|
-
"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.",
|
5398
|
-
"accessibility_docs": null,
|
5399
|
-
"is_form_component": false,
|
5400
|
-
"is_published": true,
|
5401
|
-
"requires_js": true,
|
5402
|
-
"component": "NavList::Group",
|
5403
|
-
"status": "alpha",
|
5404
|
-
"a11y_reviewed": true,
|
5405
|
-
"short_name": "NavListGroup",
|
5406
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/group.rb",
|
5407
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/group/default/",
|
5408
|
-
"parameters": [
|
5409
|
-
{
|
5410
|
-
"name": "selected_item_id",
|
5411
|
-
"type": "Symbol",
|
5412
|
-
"default": "`nil`",
|
5413
|
-
"description": "The ID of the currently selected item. Used internally."
|
5414
|
-
},
|
5415
|
-
{
|
5416
|
-
"name": "system_arguments",
|
5417
|
-
"type": "Hash",
|
5418
|
-
"default": "N/A",
|
5419
|
-
"description": "{{link_to_system_arguments_docs}}"
|
5420
|
-
}
|
5421
|
-
],
|
5422
|
-
"slots": [
|
5423
|
-
{
|
5424
|
-
"name": "show_more_item",
|
5425
|
-
"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.",
|
5426
|
-
"parameters": [
|
5427
|
-
{
|
5428
|
-
"name": "src",
|
5429
|
-
"type": "String",
|
5430
|
-
"default": "N/A",
|
5431
|
-
"description": "The URL to query for additional pages of list items."
|
5432
|
-
},
|
5433
|
-
{
|
5434
|
-
"name": "pages",
|
5435
|
-
"type": "Integer",
|
5436
|
-
"default": "N/A",
|
5437
|
-
"description": "The total number of pages in the result set."
|
5438
|
-
},
|
5439
|
-
{
|
5440
|
-
"name": "component_klass",
|
5441
|
-
"type": "Class",
|
5442
|
-
"default": "N/A",
|
5443
|
-
"description": "A component class to use instead of the default `Primer::Alpha::NavList::Item` class."
|
5444
|
-
},
|
5445
|
-
{
|
5446
|
-
"name": "system_arguments",
|
5447
|
-
"type": "Hash",
|
5448
|
-
"default": "N/A",
|
5449
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
|
5450
|
-
}
|
5451
|
-
]
|
5452
|
-
},
|
5453
|
-
{
|
5454
|
-
"name": "items",
|
5455
|
-
"description": "Items.",
|
5456
|
-
"parameters": [
|
5457
|
-
{
|
5458
|
-
"name": "system_arguments",
|
5459
|
-
"type": "Hash",
|
5460
|
-
"default": "N/A",
|
5461
|
-
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::NavList::Item{{/link_to_component}}."
|
5462
|
-
}
|
5463
|
-
]
|
5464
|
-
},
|
5465
|
-
{
|
5466
|
-
"name": "heading",
|
5467
|
-
"description": "Heading text rendered above the list of items.",
|
5229
|
+
"name": "heading",
|
5230
|
+
"description": "Heading text rendered above the list of items.",
|
5468
5231
|
"parameters": [
|
5469
5232
|
{
|
5470
5233
|
"name": "system_arguments",
|
@@ -5476,13 +5239,7 @@
|
|
5476
5239
|
}
|
5477
5240
|
],
|
5478
5241
|
"methods": [
|
5479
|
-
{
|
5480
|
-
"name": "expand!",
|
5481
|
-
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
5482
|
-
"parameters": [
|
5483
5242
|
|
5484
|
-
]
|
5485
|
-
}
|
5486
5243
|
],
|
5487
5244
|
"previews": [
|
5488
5245
|
|
@@ -6341,6 +6098,18 @@
|
|
6341
6098
|
"default": "N/A",
|
6342
6099
|
"description": "A string describing the field and what sorts of input it expects. Displayed below the group."
|
6343
6100
|
},
|
6101
|
+
{
|
6102
|
+
"name": "invalid",
|
6103
|
+
"type": "Boolean",
|
6104
|
+
"default": "N/A",
|
6105
|
+
"description": "If set to `true`, the input will be marked as invalid. Implied if `validation_message` is truthy. This option is set to `true` automatically if the model object associated with the form reports that the input is invalid via Rails validations. It is provided for cases where the form does not have an associated model. If the input is invalid as determined by Rails validations, setting `invalid` to `false` will have no effect."
|
6106
|
+
},
|
6107
|
+
{
|
6108
|
+
"name": "validation_message",
|
6109
|
+
"type": "String",
|
6110
|
+
"default": "N/A",
|
6111
|
+
"description": "A string displayed between the caption and the input indicating the input's contents are invalid. This option is, by default, set to the first Rails validation message for the input (assuming the form is associated with a model object). Use `validation_message` to override the default or to provide a validation message in case there is no associated model object."
|
6112
|
+
},
|
6344
6113
|
{
|
6345
6114
|
"name": "label_arguments",
|
6346
6115
|
"type": "Hash",
|
@@ -6398,6 +6167,19 @@
|
|
6398
6167
|
]
|
6399
6168
|
}
|
6400
6169
|
},
|
6170
|
+
{
|
6171
|
+
"preview_path": "primer/alpha/radio_button_group/invalid",
|
6172
|
+
"name": "invalid",
|
6173
|
+
"snapshot": "true",
|
6174
|
+
"skip_rules": {
|
6175
|
+
"wont_fix": [
|
6176
|
+
"region"
|
6177
|
+
],
|
6178
|
+
"will_fix": [
|
6179
|
+
"color-contrast"
|
6180
|
+
]
|
6181
|
+
}
|
6182
|
+
},
|
6401
6183
|
{
|
6402
6184
|
"preview_path": "primer/alpha/radio_button_group/with_caption",
|
6403
6185
|
"name": "with_caption",
|
@@ -8117,6 +7899,45 @@
|
|
8117
7899
|
"color-contrast"
|
8118
7900
|
]
|
8119
7901
|
}
|
7902
|
+
},
|
7903
|
+
{
|
7904
|
+
"preview_path": "primer/alpha/text_field/input_group_leading_button",
|
7905
|
+
"name": "input_group_leading_button",
|
7906
|
+
"snapshot": "true",
|
7907
|
+
"skip_rules": {
|
7908
|
+
"wont_fix": [
|
7909
|
+
"region"
|
7910
|
+
],
|
7911
|
+
"will_fix": [
|
7912
|
+
"color-contrast"
|
7913
|
+
]
|
7914
|
+
}
|
7915
|
+
},
|
7916
|
+
{
|
7917
|
+
"preview_path": "primer/alpha/text_field/input_group_trailing_button",
|
7918
|
+
"name": "input_group_trailing_button",
|
7919
|
+
"snapshot": "true",
|
7920
|
+
"skip_rules": {
|
7921
|
+
"wont_fix": [
|
7922
|
+
"region"
|
7923
|
+
],
|
7924
|
+
"will_fix": [
|
7925
|
+
"color-contrast"
|
7926
|
+
]
|
7927
|
+
}
|
7928
|
+
},
|
7929
|
+
{
|
7930
|
+
"preview_path": "primer/alpha/text_field/input_group_leading_action_menu",
|
7931
|
+
"name": "input_group_leading_action_menu",
|
7932
|
+
"snapshot": "true",
|
7933
|
+
"skip_rules": {
|
7934
|
+
"wont_fix": [
|
7935
|
+
"region"
|
7936
|
+
],
|
7937
|
+
"will_fix": [
|
7938
|
+
"color-contrast"
|
7939
|
+
]
|
7940
|
+
}
|
8120
7941
|
}
|
8121
7942
|
],
|
8122
7943
|
"subcomponents": [
|
@@ -8395,9 +8216,15 @@
|
|
8395
8216
|
|
8396
8217
|
],
|
8397
8218
|
"methods": [
|
8398
|
-
|
8399
|
-
|
8400
|
-
|
8219
|
+
{
|
8220
|
+
"name": "id",
|
8221
|
+
"description": "Returns the value of attribute id.",
|
8222
|
+
"parameters": [
|
8223
|
+
|
8224
|
+
]
|
8225
|
+
}
|
8226
|
+
],
|
8227
|
+
"previews": [
|
8401
8228
|
{
|
8402
8229
|
"preview_path": "primer/alpha/tooltip/playground",
|
8403
8230
|
"name": "playground",
|
@@ -12151,7 +11978,7 @@
|
|
12151
11978
|
{
|
12152
11979
|
"name": "underline",
|
12153
11980
|
"type": "Boolean",
|
12154
|
-
"default": "`
|
11981
|
+
"default": "`false`",
|
12155
11982
|
"description": "Whether or not to underline the link."
|
12156
11983
|
},
|
12157
11984
|
{
|
@@ -12326,12 +12153,662 @@
|
|
12326
12153
|
],
|
12327
12154
|
"methods": [
|
12328
12155
|
|
12329
|
-
],
|
12330
|
-
"previews": [
|
12156
|
+
],
|
12157
|
+
"previews": [
|
12158
|
+
|
12159
|
+
],
|
12160
|
+
"subcomponents": [
|
12161
|
+
|
12162
|
+
]
|
12163
|
+
},
|
12164
|
+
{
|
12165
|
+
"fully_qualified_name": "Primer::Beta::NavList",
|
12166
|
+
"description": "`NavList` provides a simple way to render side navigation, i.e. navigation\nthat appears to the left or right side of some main content. Each group in a\nnav list is a list of links.\n\nNav list groups can contain sub items. Rather than navigating to a URL, groups\nwith sub items expand and collapse on click. To indicate this functionality, the\ngroup will automatically render with a trailing chevron icon that changes direction\nwhen the group expands and collapses.\n\nNav list items appear visually active when selected. Each nav item must have one\nor more ID values that determine which item will appear selected. Use the\n`selected_item_id` argument to select the appropriate item.",
|
12167
|
+
"accessibility_docs": null,
|
12168
|
+
"is_form_component": false,
|
12169
|
+
"is_published": true,
|
12170
|
+
"requires_js": true,
|
12171
|
+
"component": "NavList",
|
12172
|
+
"status": "beta",
|
12173
|
+
"a11y_reviewed": true,
|
12174
|
+
"short_name": "NavList",
|
12175
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list.rb",
|
12176
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/default/",
|
12177
|
+
"parameters": [
|
12178
|
+
{
|
12179
|
+
"name": "selected_item_id",
|
12180
|
+
"type": "Symbol",
|
12181
|
+
"default": "`nil`",
|
12182
|
+
"description": "The ID of the currently selected item. The default is `nil`, meaning no item is selected."
|
12183
|
+
},
|
12184
|
+
{
|
12185
|
+
"name": "system_arguments",
|
12186
|
+
"type": "Hash",
|
12187
|
+
"default": "N/A",
|
12188
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12189
|
+
}
|
12190
|
+
],
|
12191
|
+
"slots": [
|
12192
|
+
{
|
12193
|
+
"name": "heading",
|
12194
|
+
"description": "The heading for the list at large. Accepts the arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Heading{{/link_to_component}}.",
|
12195
|
+
"parameters": [
|
12196
|
+
|
12197
|
+
]
|
12198
|
+
},
|
12199
|
+
{
|
12200
|
+
"name": "items",
|
12201
|
+
"description": "Items. Items can be individual items, dividers, or groups. See the documentation for `#with_item`, `#with_divider`, and `#with_group` respectively for more information.",
|
12202
|
+
"parameters": [
|
12203
|
+
|
12204
|
+
]
|
12205
|
+
}
|
12206
|
+
],
|
12207
|
+
"methods": [
|
12208
|
+
{
|
12209
|
+
"name": "with_item",
|
12210
|
+
"description": "Adds an item to the list.",
|
12211
|
+
"parameters": [
|
12212
|
+
{
|
12213
|
+
"name": "component_klass",
|
12214
|
+
"type": "Class",
|
12215
|
+
"default": "`Primer::Beta::NavList::Item`",
|
12216
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
|
12217
|
+
},
|
12218
|
+
{
|
12219
|
+
"name": "system_arguments",
|
12220
|
+
"type": "Hash",
|
12221
|
+
"default": "N/A",
|
12222
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
12223
|
+
}
|
12224
|
+
]
|
12225
|
+
},
|
12226
|
+
{
|
12227
|
+
"name": "with_avatar_item",
|
12228
|
+
"description": "Adds an avatar item to the list. Avatar items are a convenient way to accessibly add an item with a leading avatar image.",
|
12229
|
+
"parameters": [
|
12230
|
+
{
|
12231
|
+
"name": "src",
|
12232
|
+
"type": "String",
|
12233
|
+
"default": "N/A",
|
12234
|
+
"description": "The source url of the avatar image."
|
12235
|
+
},
|
12236
|
+
{
|
12237
|
+
"name": "username",
|
12238
|
+
"type": "String",
|
12239
|
+
"default": "N/A",
|
12240
|
+
"description": "The username associated with the avatar."
|
12241
|
+
},
|
12242
|
+
{
|
12243
|
+
"name": "full_name",
|
12244
|
+
"type": "String",
|
12245
|
+
"default": "`nil`",
|
12246
|
+
"description": "Optional. The user's full name."
|
12247
|
+
},
|
12248
|
+
{
|
12249
|
+
"name": "full_name_scheme",
|
12250
|
+
"type": "Symbol",
|
12251
|
+
"default": "`:block`",
|
12252
|
+
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
12253
|
+
},
|
12254
|
+
{
|
12255
|
+
"name": "component_klass",
|
12256
|
+
"type": "Class",
|
12257
|
+
"default": "`Primer::Beta::NavList::Item`",
|
12258
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
|
12259
|
+
},
|
12260
|
+
{
|
12261
|
+
"name": "avatar_arguments",
|
12262
|
+
"type": "Hash",
|
12263
|
+
"default": "`{}`",
|
12264
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
12265
|
+
},
|
12266
|
+
{
|
12267
|
+
"name": "system_arguments",
|
12268
|
+
"type": "Hash",
|
12269
|
+
"default": "N/A",
|
12270
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
12271
|
+
}
|
12272
|
+
]
|
12273
|
+
},
|
12274
|
+
{
|
12275
|
+
"name": "with_group",
|
12276
|
+
"description": "Adds a group to the list. A group is a list of links and a (required) heading.",
|
12277
|
+
"parameters": [
|
12278
|
+
{
|
12279
|
+
"name": "system_arguments",
|
12280
|
+
"type": "Hash",
|
12281
|
+
"default": "N/A",
|
12282
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Group{{/link_to_component}}."
|
12283
|
+
}
|
12284
|
+
]
|
12285
|
+
},
|
12286
|
+
{
|
12287
|
+
"name": "with_divider",
|
12288
|
+
"description": "Adds a divider to the list. Dividers visually separate items and groups.",
|
12289
|
+
"parameters": [
|
12290
|
+
{
|
12291
|
+
"name": "system_arguments",
|
12292
|
+
"type": "Hash",
|
12293
|
+
"default": "N/A",
|
12294
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Divider{{/link_to_component}}."
|
12295
|
+
}
|
12296
|
+
]
|
12297
|
+
},
|
12298
|
+
{
|
12299
|
+
"name": "build_item",
|
12300
|
+
"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.",
|
12301
|
+
"parameters": [
|
12302
|
+
{
|
12303
|
+
"name": "component_klass",
|
12304
|
+
"type": "Class",
|
12305
|
+
"default": "`Primer::Beta::NavList::Item`",
|
12306
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
|
12307
|
+
},
|
12308
|
+
{
|
12309
|
+
"name": "system_arguments",
|
12310
|
+
"type": "Hash",
|
12311
|
+
"default": "N/A",
|
12312
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
12313
|
+
}
|
12314
|
+
]
|
12315
|
+
},
|
12316
|
+
{
|
12317
|
+
"name": "build_avatar_item",
|
12318
|
+
"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.",
|
12319
|
+
"parameters": [
|
12320
|
+
{
|
12321
|
+
"name": "src",
|
12322
|
+
"type": "String",
|
12323
|
+
"default": "N/A",
|
12324
|
+
"description": "The source url of the avatar image."
|
12325
|
+
},
|
12326
|
+
{
|
12327
|
+
"name": "username",
|
12328
|
+
"type": "String",
|
12329
|
+
"default": "N/A",
|
12330
|
+
"description": "The username associated with the avatar."
|
12331
|
+
},
|
12332
|
+
{
|
12333
|
+
"name": "full_name",
|
12334
|
+
"type": "String",
|
12335
|
+
"default": "`nil`",
|
12336
|
+
"description": "Optional. The user's full name."
|
12337
|
+
},
|
12338
|
+
{
|
12339
|
+
"name": "full_name_scheme",
|
12340
|
+
"type": "Symbol",
|
12341
|
+
"default": "`:block`",
|
12342
|
+
"description": "Optional. How to display the user's full name. One of `:block` or `:inline`."
|
12343
|
+
},
|
12344
|
+
{
|
12345
|
+
"name": "component_klass",
|
12346
|
+
"type": "Class",
|
12347
|
+
"default": "`Primer::Beta::NavList::Item`",
|
12348
|
+
"description": "The class to use instead of the default {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}"
|
12349
|
+
},
|
12350
|
+
{
|
12351
|
+
"name": "avatar_arguments",
|
12352
|
+
"type": "Hash",
|
12353
|
+
"default": "`{}`",
|
12354
|
+
"description": "Optional. The arguments accepted by {{#link_to_component}}Primer::Beta::Avatar{{/link_to_component}}"
|
12355
|
+
},
|
12356
|
+
{
|
12357
|
+
"name": "system_arguments",
|
12358
|
+
"type": "Hash",
|
12359
|
+
"default": "N/A",
|
12360
|
+
"description": "These arguments are forwarded to {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}, or whatever class is passed as the `component_klass` argument."
|
12361
|
+
}
|
12362
|
+
]
|
12363
|
+
},
|
12364
|
+
{
|
12365
|
+
"name": "render_outer_list?",
|
12366
|
+
"description": "Lists that contain top-level items (i.e. items outside of a group) should be wrapped in a <ul>",
|
12367
|
+
"parameters": [
|
12368
|
+
|
12369
|
+
]
|
12370
|
+
}
|
12371
|
+
],
|
12372
|
+
"previews": [
|
12373
|
+
{
|
12374
|
+
"preview_path": "primer/beta/nav_list/playground",
|
12375
|
+
"name": "playground",
|
12376
|
+
"snapshot": "false",
|
12377
|
+
"skip_rules": {
|
12378
|
+
"wont_fix": [
|
12379
|
+
"region"
|
12380
|
+
],
|
12381
|
+
"will_fix": [
|
12382
|
+
"color-contrast"
|
12383
|
+
]
|
12384
|
+
}
|
12385
|
+
},
|
12386
|
+
{
|
12387
|
+
"preview_path": "primer/beta/nav_list/default",
|
12388
|
+
"name": "default",
|
12389
|
+
"snapshot": "true",
|
12390
|
+
"skip_rules": {
|
12391
|
+
"wont_fix": [
|
12392
|
+
"region"
|
12393
|
+
],
|
12394
|
+
"will_fix": [
|
12395
|
+
"color-contrast"
|
12396
|
+
]
|
12397
|
+
}
|
12398
|
+
},
|
12399
|
+
{
|
12400
|
+
"preview_path": "primer/beta/nav_list/top_level_items",
|
12401
|
+
"name": "top_level_items",
|
12402
|
+
"snapshot": "false",
|
12403
|
+
"skip_rules": {
|
12404
|
+
"wont_fix": [
|
12405
|
+
"region"
|
12406
|
+
],
|
12407
|
+
"will_fix": [
|
12408
|
+
"color-contrast"
|
12409
|
+
]
|
12410
|
+
}
|
12411
|
+
},
|
12412
|
+
{
|
12413
|
+
"preview_path": "primer/beta/nav_list/show_more_item",
|
12414
|
+
"name": "show_more_item",
|
12415
|
+
"snapshot": "true",
|
12416
|
+
"skip_rules": {
|
12417
|
+
"wont_fix": [
|
12418
|
+
"region"
|
12419
|
+
],
|
12420
|
+
"will_fix": [
|
12421
|
+
"color-contrast"
|
12422
|
+
]
|
12423
|
+
}
|
12424
|
+
},
|
12425
|
+
{
|
12426
|
+
"preview_path": "primer/beta/nav_list/trailing_action",
|
12427
|
+
"name": "trailing_action",
|
12428
|
+
"snapshot": "true",
|
12429
|
+
"skip_rules": {
|
12430
|
+
"wont_fix": [
|
12431
|
+
"region"
|
12432
|
+
],
|
12433
|
+
"will_fix": [
|
12434
|
+
"color-contrast"
|
12435
|
+
]
|
12436
|
+
}
|
12437
|
+
}
|
12438
|
+
],
|
12439
|
+
"subcomponents": [
|
12440
|
+
{
|
12441
|
+
"fully_qualified_name": "Primer::Beta::NavList::Heading",
|
12442
|
+
"description": "The heading placed above a `NavList`'s items.\n\nSee {{#link_to_component}}Primer::Beta::NavList{{/link_to_component}} for usage examples.",
|
12443
|
+
"accessibility_docs": null,
|
12444
|
+
"is_form_component": false,
|
12445
|
+
"is_published": true,
|
12446
|
+
"requires_js": false,
|
12447
|
+
"component": "NavList::Heading",
|
12448
|
+
"status": "alpha",
|
12449
|
+
"a11y_reviewed": false,
|
12450
|
+
"short_name": "NavListHeading",
|
12451
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/heading.rb",
|
12452
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/heading/default/",
|
12453
|
+
"parameters": [
|
12454
|
+
{
|
12455
|
+
"name": "title",
|
12456
|
+
"type": "String",
|
12457
|
+
"default": "N/A",
|
12458
|
+
"description": "The text content of the heading."
|
12459
|
+
},
|
12460
|
+
{
|
12461
|
+
"name": "id",
|
12462
|
+
"type": "String",
|
12463
|
+
"default": "`self.class.generate_id`",
|
12464
|
+
"description": "The value of the ID HTML attribute. Auto-generated by default."
|
12465
|
+
},
|
12466
|
+
{
|
12467
|
+
"name": "heading_level",
|
12468
|
+
"type": "Integer",
|
12469
|
+
"default": "`2`",
|
12470
|
+
"description": "The heading level, i.e. 2 for an `<h2>`, 3 for an `<h3>`, etc."
|
12471
|
+
},
|
12472
|
+
{
|
12473
|
+
"name": "system_arguments",
|
12474
|
+
"type": "Hash",
|
12475
|
+
"default": "N/A",
|
12476
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12477
|
+
}
|
12478
|
+
],
|
12479
|
+
"slots": [
|
12480
|
+
|
12481
|
+
],
|
12482
|
+
"methods": [
|
12483
|
+
{
|
12484
|
+
"name": "title",
|
12485
|
+
"description": "Returns the value of attribute title.",
|
12486
|
+
"parameters": [
|
12487
|
+
|
12488
|
+
]
|
12489
|
+
},
|
12490
|
+
{
|
12491
|
+
"name": "id",
|
12492
|
+
"description": "Returns the value of attribute id.",
|
12493
|
+
"parameters": [
|
12494
|
+
|
12495
|
+
]
|
12496
|
+
},
|
12497
|
+
{
|
12498
|
+
"name": "heading_level",
|
12499
|
+
"description": "Returns the value of attribute heading_level.",
|
12500
|
+
"parameters": [
|
12501
|
+
|
12502
|
+
]
|
12503
|
+
},
|
12504
|
+
{
|
12505
|
+
"name": "system_arguments",
|
12506
|
+
"description": "Returns the value of attribute system_arguments.",
|
12507
|
+
"parameters": [
|
12508
|
+
|
12509
|
+
]
|
12510
|
+
}
|
12511
|
+
],
|
12512
|
+
"previews": [
|
12513
|
+
|
12514
|
+
],
|
12515
|
+
"subcomponents": [
|
12516
|
+
|
12517
|
+
]
|
12518
|
+
},
|
12519
|
+
{
|
12520
|
+
"fully_qualified_name": "Primer::Beta::NavList::Item",
|
12521
|
+
"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.",
|
12522
|
+
"accessibility_docs": null,
|
12523
|
+
"is_form_component": false,
|
12524
|
+
"is_published": true,
|
12525
|
+
"requires_js": true,
|
12526
|
+
"component": "NavList::Item",
|
12527
|
+
"status": "alpha",
|
12528
|
+
"a11y_reviewed": false,
|
12529
|
+
"short_name": "NavListItem",
|
12530
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/item.rb",
|
12531
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/item/default/",
|
12532
|
+
"parameters": [
|
12533
|
+
{
|
12534
|
+
"name": "selected_item_id",
|
12535
|
+
"type": "Symbol",
|
12536
|
+
"default": "`nil`",
|
12537
|
+
"description": "The ID of the currently selected list item. Used internally."
|
12538
|
+
},
|
12539
|
+
{
|
12540
|
+
"name": "selected_by_ids",
|
12541
|
+
"type": "Array<Symbol>",
|
12542
|
+
"default": "`[]`",
|
12543
|
+
"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."
|
12544
|
+
},
|
12545
|
+
{
|
12546
|
+
"name": "expanded",
|
12547
|
+
"type": "Boolean",
|
12548
|
+
"default": "`false`",
|
12549
|
+
"description": "Whether this item shows (expands) or hides (collapses) its list of sub items."
|
12550
|
+
},
|
12551
|
+
{
|
12552
|
+
"name": "sub_item",
|
12553
|
+
"type": "Boolean",
|
12554
|
+
"default": "`false`",
|
12555
|
+
"description": "Whether or not this item is nested under a parent item. Used internally."
|
12556
|
+
},
|
12557
|
+
{
|
12558
|
+
"name": "system_arguments",
|
12559
|
+
"type": "Hash",
|
12560
|
+
"default": "N/A",
|
12561
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12562
|
+
}
|
12563
|
+
],
|
12564
|
+
"slots": [
|
12565
|
+
{
|
12566
|
+
"name": "items",
|
12567
|
+
"description": null,
|
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::Item{{/link_to_component}}."
|
12574
|
+
}
|
12575
|
+
]
|
12576
|
+
},
|
12577
|
+
{
|
12578
|
+
"name": "description",
|
12579
|
+
"description": "Description content that complements the item's label. See `ActionList`'s `description_scheme` argument\nfor layout options.",
|
12580
|
+
"parameters": [
|
12581
|
+
|
12582
|
+
]
|
12583
|
+
},
|
12584
|
+
{
|
12585
|
+
"name": "leading_visual",
|
12586
|
+
"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.",
|
12587
|
+
"parameters": [
|
12588
|
+
|
12589
|
+
]
|
12590
|
+
},
|
12591
|
+
{
|
12592
|
+
"name": "trailing_visual",
|
12593
|
+
"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```",
|
12594
|
+
"parameters": [
|
12595
|
+
|
12596
|
+
]
|
12597
|
+
},
|
12598
|
+
{
|
12599
|
+
"name": "trailing_action",
|
12600
|
+
"description": "A button rendered after the trailing icon that can be used to show a menu, activate\na dialog, etc.",
|
12601
|
+
"parameters": [
|
12602
|
+
{
|
12603
|
+
"name": "system_arguments",
|
12604
|
+
"type": "Hash",
|
12605
|
+
"default": "N/A",
|
12606
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::IconButton{{/link_to_component}}."
|
12607
|
+
}
|
12608
|
+
]
|
12609
|
+
},
|
12610
|
+
{
|
12611
|
+
"name": "tooltip",
|
12612
|
+
"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.",
|
12613
|
+
"parameters": [
|
12614
|
+
{
|
12615
|
+
"name": "type",
|
12616
|
+
"type": "Symbol",
|
12617
|
+
"default": "`:description`",
|
12618
|
+
"description": "One of `:description` or `:label`."
|
12619
|
+
},
|
12620
|
+
{
|
12621
|
+
"name": "system_arguments",
|
12622
|
+
"type": "Hash",
|
12623
|
+
"default": "N/A",
|
12624
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
|
12625
|
+
}
|
12626
|
+
]
|
12627
|
+
}
|
12628
|
+
],
|
12629
|
+
"methods": [
|
12630
|
+
{
|
12631
|
+
"name": "selected_by_ids",
|
12632
|
+
"description": "Returns the value of attribute selected_by_ids.",
|
12633
|
+
"parameters": [
|
12634
|
+
|
12635
|
+
]
|
12636
|
+
},
|
12637
|
+
{
|
12638
|
+
"name": "sub_item",
|
12639
|
+
"description": "Returns the value of attribute sub_item.",
|
12640
|
+
"parameters": [
|
12641
|
+
|
12642
|
+
]
|
12643
|
+
},
|
12644
|
+
{
|
12645
|
+
"name": "sub_item?",
|
12646
|
+
"description": "Returns the value of attribute sub_item.\nWhether or not this item is nested under a parent item.",
|
12647
|
+
"parameters": [
|
12648
|
+
|
12649
|
+
]
|
12650
|
+
},
|
12651
|
+
{
|
12652
|
+
"name": "expand!",
|
12653
|
+
"description": "Cause this item to show its list of sub items when rendered.",
|
12654
|
+
"parameters": [
|
12655
|
+
|
12656
|
+
]
|
12657
|
+
},
|
12658
|
+
{
|
12659
|
+
"name": "item_active?",
|
12660
|
+
"description": "Normally it would be easier to simply ask each item for its active status, eg.\nitems.any?(&:active?), but unfortunately the view context is not set on each\nitem until _after_ the parent's before_render, etc methods have been called.\nThis means helper methods like current_page? will blow up with an error, since\n`helpers` is simply an alias for the view context (i.e. an instance of\nActionView::Base). Since we know the view context for the parent object must\nbe set before `before_render` is invoked, we can call helper methods here in\nthe parent and bypass the problem entirely. Maybe not the most OO approach,\nbut it works.",
|
12661
|
+
"parameters": [
|
12662
|
+
|
12663
|
+
]
|
12664
|
+
}
|
12665
|
+
],
|
12666
|
+
"previews": [
|
12667
|
+
|
12668
|
+
],
|
12669
|
+
"subcomponents": [
|
12670
|
+
|
12671
|
+
]
|
12672
|
+
},
|
12673
|
+
{
|
12674
|
+
"fully_qualified_name": "Primer::Beta::NavList::Divider",
|
12675
|
+
"description": "Separator with optional text rendered above groups or between individual items.",
|
12676
|
+
"accessibility_docs": null,
|
12677
|
+
"is_form_component": false,
|
12678
|
+
"is_published": true,
|
12679
|
+
"requires_js": false,
|
12680
|
+
"component": "NavList::Divider",
|
12681
|
+
"status": "alpha",
|
12682
|
+
"a11y_reviewed": false,
|
12683
|
+
"short_name": "NavListDivider",
|
12684
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/divider.rb",
|
12685
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/divider/default/",
|
12686
|
+
"parameters": [
|
12687
|
+
{
|
12688
|
+
"name": "scheme",
|
12689
|
+
"type": "Symbol",
|
12690
|
+
"default": "`:subtle`",
|
12691
|
+
"description": "Display a background color if scheme is `filled`."
|
12692
|
+
},
|
12693
|
+
{
|
12694
|
+
"name": "system_arguments",
|
12695
|
+
"type": "Hash",
|
12696
|
+
"default": "N/A",
|
12697
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12698
|
+
}
|
12699
|
+
],
|
12700
|
+
"slots": [
|
12701
|
+
|
12702
|
+
],
|
12703
|
+
"methods": [
|
12704
|
+
|
12705
|
+
],
|
12706
|
+
"previews": [
|
12707
|
+
|
12708
|
+
],
|
12709
|
+
"subcomponents": [
|
12710
|
+
|
12711
|
+
]
|
12712
|
+
},
|
12713
|
+
{
|
12714
|
+
"fully_qualified_name": "Primer::Beta::NavList::Group",
|
12715
|
+
"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.",
|
12716
|
+
"accessibility_docs": null,
|
12717
|
+
"is_form_component": false,
|
12718
|
+
"is_published": true,
|
12719
|
+
"requires_js": true,
|
12720
|
+
"component": "NavList::Group",
|
12721
|
+
"status": "alpha",
|
12722
|
+
"a11y_reviewed": true,
|
12723
|
+
"short_name": "NavListGroup",
|
12724
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/nav_list/group.rb",
|
12725
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/nav_list/group/default/",
|
12726
|
+
"parameters": [
|
12727
|
+
{
|
12728
|
+
"name": "selected_item_id",
|
12729
|
+
"type": "Symbol",
|
12730
|
+
"default": "`nil`",
|
12731
|
+
"description": "The ID of the currently selected item. Used internally."
|
12732
|
+
},
|
12733
|
+
{
|
12734
|
+
"name": "system_arguments",
|
12735
|
+
"type": "Hash",
|
12736
|
+
"default": "N/A",
|
12737
|
+
"description": "{{link_to_system_arguments_docs}}"
|
12738
|
+
}
|
12739
|
+
],
|
12740
|
+
"slots": [
|
12741
|
+
{
|
12742
|
+
"name": "show_more_item",
|
12743
|
+
"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.",
|
12744
|
+
"parameters": [
|
12745
|
+
{
|
12746
|
+
"name": "src",
|
12747
|
+
"type": "String",
|
12748
|
+
"default": "N/A",
|
12749
|
+
"description": "The URL to query for additional pages of list items."
|
12750
|
+
},
|
12751
|
+
{
|
12752
|
+
"name": "pages",
|
12753
|
+
"type": "Integer",
|
12754
|
+
"default": "N/A",
|
12755
|
+
"description": "The total number of pages in the result set."
|
12756
|
+
},
|
12757
|
+
{
|
12758
|
+
"name": "component_klass",
|
12759
|
+
"type": "Class",
|
12760
|
+
"default": "N/A",
|
12761
|
+
"description": "A component class to use instead of the default `Primer::Beta::NavList::Item` class."
|
12762
|
+
},
|
12763
|
+
{
|
12764
|
+
"name": "system_arguments",
|
12765
|
+
"type": "Hash",
|
12766
|
+
"default": "N/A",
|
12767
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
12768
|
+
}
|
12769
|
+
]
|
12770
|
+
},
|
12771
|
+
{
|
12772
|
+
"name": "items",
|
12773
|
+
"description": "Items.",
|
12774
|
+
"parameters": [
|
12775
|
+
{
|
12776
|
+
"name": "system_arguments",
|
12777
|
+
"type": "Hash",
|
12778
|
+
"default": "N/A",
|
12779
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Beta::NavList::Item{{/link_to_component}}."
|
12780
|
+
}
|
12781
|
+
]
|
12782
|
+
},
|
12783
|
+
{
|
12784
|
+
"name": "heading",
|
12785
|
+
"description": "Heading text rendered above the list of items.",
|
12786
|
+
"parameters": [
|
12787
|
+
{
|
12788
|
+
"name": "system_arguments",
|
12789
|
+
"type": "Hash",
|
12790
|
+
"default": "N/A",
|
12791
|
+
"description": "The arguments accepted by {{#link_to_component}}Primer::Alpha::ActionList::Heading{{/link_to_component}}."
|
12792
|
+
}
|
12793
|
+
]
|
12794
|
+
}
|
12795
|
+
],
|
12796
|
+
"methods": [
|
12797
|
+
{
|
12798
|
+
"name": "expand!",
|
12799
|
+
"description": "Cause this group to show its list of sub items when rendered.\n:nocov:",
|
12800
|
+
"parameters": [
|
12801
|
+
|
12802
|
+
]
|
12803
|
+
}
|
12804
|
+
],
|
12805
|
+
"previews": [
|
12331
12806
|
|
12332
|
-
|
12333
|
-
|
12807
|
+
],
|
12808
|
+
"subcomponents": [
|
12334
12809
|
|
12810
|
+
]
|
12811
|
+
}
|
12335
12812
|
]
|
12336
12813
|
},
|
12337
12814
|
{
|
@@ -13594,8 +14071,256 @@
|
|
13594
14071
|
}
|
13595
14072
|
},
|
13596
14073
|
{
|
13597
|
-
"preview_path": "primer/beta/truncate/default",
|
13598
|
-
"name": "default",
|
14074
|
+
"preview_path": "primer/beta/truncate/default",
|
14075
|
+
"name": "default",
|
14076
|
+
"snapshot": "false",
|
14077
|
+
"skip_rules": {
|
14078
|
+
"wont_fix": [
|
14079
|
+
"region"
|
14080
|
+
],
|
14081
|
+
"will_fix": [
|
14082
|
+
"color-contrast"
|
14083
|
+
]
|
14084
|
+
}
|
14085
|
+
},
|
14086
|
+
{
|
14087
|
+
"preview_path": "primer/beta/truncate/multiple_items",
|
14088
|
+
"name": "multiple_items",
|
14089
|
+
"snapshot": "false",
|
14090
|
+
"skip_rules": {
|
14091
|
+
"wont_fix": [
|
14092
|
+
"region"
|
14093
|
+
],
|
14094
|
+
"will_fix": [
|
14095
|
+
"color-contrast"
|
14096
|
+
]
|
14097
|
+
}
|
14098
|
+
},
|
14099
|
+
{
|
14100
|
+
"preview_path": "primer/beta/truncate/advanced_multiple_items",
|
14101
|
+
"name": "advanced_multiple_items",
|
14102
|
+
"snapshot": "false",
|
14103
|
+
"skip_rules": {
|
14104
|
+
"wont_fix": [
|
14105
|
+
"region"
|
14106
|
+
],
|
14107
|
+
"will_fix": [
|
14108
|
+
"color-contrast"
|
14109
|
+
]
|
14110
|
+
}
|
14111
|
+
},
|
14112
|
+
{
|
14113
|
+
"preview_path": "primer/beta/truncate/max_widths",
|
14114
|
+
"name": "max_widths",
|
14115
|
+
"snapshot": "true",
|
14116
|
+
"skip_rules": {
|
14117
|
+
"wont_fix": [
|
14118
|
+
"region"
|
14119
|
+
],
|
14120
|
+
"will_fix": [
|
14121
|
+
"color-contrast"
|
14122
|
+
]
|
14123
|
+
}
|
14124
|
+
}
|
14125
|
+
],
|
14126
|
+
"subcomponents": [
|
14127
|
+
{
|
14128
|
+
"fully_qualified_name": "Primer::Beta::Truncate::TruncateText",
|
14129
|
+
"description": "This component is part of `Primer::Beta::Truncate` and should not be\nused as a standalone component.",
|
14130
|
+
"accessibility_docs": null,
|
14131
|
+
"is_form_component": false,
|
14132
|
+
"is_published": true,
|
14133
|
+
"requires_js": false,
|
14134
|
+
"component": "Truncate::TruncateText",
|
14135
|
+
"status": "alpha",
|
14136
|
+
"a11y_reviewed": false,
|
14137
|
+
"short_name": "TruncateTruncateText",
|
14138
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate/truncate_text.rb",
|
14139
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/truncate_text/default/",
|
14140
|
+
"parameters": [
|
14141
|
+
|
14142
|
+
],
|
14143
|
+
"slots": [
|
14144
|
+
|
14145
|
+
],
|
14146
|
+
"methods": [
|
14147
|
+
|
14148
|
+
],
|
14149
|
+
"previews": [
|
14150
|
+
|
14151
|
+
],
|
14152
|
+
"subcomponents": [
|
14153
|
+
|
14154
|
+
]
|
14155
|
+
}
|
14156
|
+
]
|
14157
|
+
},
|
14158
|
+
{
|
14159
|
+
"fully_qualified_name": "Primer::BlankslateComponent",
|
14160
|
+
"description": "Use `Blankslate` when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.",
|
14161
|
+
"accessibility_docs": "`Blankslate` renders an `<h3>` element for the title by default. Update the heading level based on what is appropriate for your page hierarchy by setting `title_tag`.\n<%= link_to_heading_practices %>",
|
14162
|
+
"is_form_component": false,
|
14163
|
+
"is_published": true,
|
14164
|
+
"requires_js": false,
|
14165
|
+
"component": "Blankslate",
|
14166
|
+
"status": "deprecated",
|
14167
|
+
"a11y_reviewed": false,
|
14168
|
+
"short_name": "Blankslate",
|
14169
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/blankslate_component.rb",
|
14170
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/blankslate/default/",
|
14171
|
+
"parameters": [
|
14172
|
+
{
|
14173
|
+
"name": "title",
|
14174
|
+
"type": "String",
|
14175
|
+
"default": "`\"\"`",
|
14176
|
+
"description": "Text that appears in a larger bold font."
|
14177
|
+
},
|
14178
|
+
{
|
14179
|
+
"name": "title_tag",
|
14180
|
+
"type": "Symbol",
|
14181
|
+
"default": "`:h3`",
|
14182
|
+
"description": "HTML tag to use for title."
|
14183
|
+
},
|
14184
|
+
{
|
14185
|
+
"name": "icon",
|
14186
|
+
"type": "Symbol",
|
14187
|
+
"default": "`\"\"`",
|
14188
|
+
"description": "Octicon icon to use at top of component."
|
14189
|
+
},
|
14190
|
+
{
|
14191
|
+
"name": "icon_size",
|
14192
|
+
"type": "Symbol",
|
14193
|
+
"default": "`:medium`",
|
14194
|
+
"description": "One of `:xsmall` (`12`), `:small` (`16`), or `:medium` (`24`)."
|
14195
|
+
},
|
14196
|
+
{
|
14197
|
+
"name": "image_src",
|
14198
|
+
"type": "String",
|
14199
|
+
"default": "`\"\"`",
|
14200
|
+
"description": "Image to display."
|
14201
|
+
},
|
14202
|
+
{
|
14203
|
+
"name": "image_alt",
|
14204
|
+
"type": "String",
|
14205
|
+
"default": "`\" \"`",
|
14206
|
+
"description": "Alt text for image."
|
14207
|
+
},
|
14208
|
+
{
|
14209
|
+
"name": "description",
|
14210
|
+
"type": "String",
|
14211
|
+
"default": "`\"\"`",
|
14212
|
+
"description": "Text that appears below the title. Typically a whole sentence."
|
14213
|
+
},
|
14214
|
+
{
|
14215
|
+
"name": "button_text",
|
14216
|
+
"type": "String",
|
14217
|
+
"default": "`\"\"`",
|
14218
|
+
"description": "The text of the button."
|
14219
|
+
},
|
14220
|
+
{
|
14221
|
+
"name": "button_url",
|
14222
|
+
"type": "String",
|
14223
|
+
"default": "`\"\"`",
|
14224
|
+
"description": "The URL where the user will be taken after clicking the button."
|
14225
|
+
},
|
14226
|
+
{
|
14227
|
+
"name": "button_classes",
|
14228
|
+
"type": "String",
|
14229
|
+
"default": "`\"btn-primary my-3\"`",
|
14230
|
+
"description": "Classes to apply to action button"
|
14231
|
+
},
|
14232
|
+
{
|
14233
|
+
"name": "link_text",
|
14234
|
+
"type": "String",
|
14235
|
+
"default": "`\"\"`",
|
14236
|
+
"description": "The text of the link."
|
14237
|
+
},
|
14238
|
+
{
|
14239
|
+
"name": "link_url",
|
14240
|
+
"type": "String",
|
14241
|
+
"default": "`\"\"`",
|
14242
|
+
"description": "The URL where the user will be taken after clicking the link."
|
14243
|
+
},
|
14244
|
+
{
|
14245
|
+
"name": "narrow",
|
14246
|
+
"type": "Boolean",
|
14247
|
+
"default": "`false`",
|
14248
|
+
"description": "Adds a maximum width."
|
14249
|
+
},
|
14250
|
+
{
|
14251
|
+
"name": "large",
|
14252
|
+
"type": "Boolean",
|
14253
|
+
"default": "`false`",
|
14254
|
+
"description": "Increases the font size."
|
14255
|
+
},
|
14256
|
+
{
|
14257
|
+
"name": "spacious",
|
14258
|
+
"type": "Boolean",
|
14259
|
+
"default": "`false`",
|
14260
|
+
"description": "Adds extra padding."
|
14261
|
+
},
|
14262
|
+
{
|
14263
|
+
"name": "system_arguments",
|
14264
|
+
"type": "Hash",
|
14265
|
+
"default": "N/A",
|
14266
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14267
|
+
}
|
14268
|
+
],
|
14269
|
+
"slots": [
|
14270
|
+
{
|
14271
|
+
"name": "spinner",
|
14272
|
+
"description": "Optional Spinner.",
|
14273
|
+
"parameters": [
|
14274
|
+
{
|
14275
|
+
"name": "kwargs",
|
14276
|
+
"type": "Hash",
|
14277
|
+
"default": "N/A",
|
14278
|
+
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Spinner{{/link_to_component}}."
|
14279
|
+
}
|
14280
|
+
]
|
14281
|
+
}
|
14282
|
+
],
|
14283
|
+
"methods": [
|
14284
|
+
|
14285
|
+
],
|
14286
|
+
"previews": [
|
14287
|
+
|
14288
|
+
],
|
14289
|
+
"subcomponents": [
|
14290
|
+
|
14291
|
+
]
|
14292
|
+
},
|
14293
|
+
{
|
14294
|
+
"fully_qualified_name": "Primer::Box",
|
14295
|
+
"description": "`Box` is a basic wrapper component for most layout related needs.",
|
14296
|
+
"accessibility_docs": null,
|
14297
|
+
"is_form_component": false,
|
14298
|
+
"is_published": true,
|
14299
|
+
"requires_js": false,
|
14300
|
+
"component": "Box",
|
14301
|
+
"status": "stable",
|
14302
|
+
"a11y_reviewed": false,
|
14303
|
+
"short_name": "Box",
|
14304
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb",
|
14305
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box/default/",
|
14306
|
+
"parameters": [
|
14307
|
+
{
|
14308
|
+
"name": "system_arguments",
|
14309
|
+
"type": "Hash",
|
14310
|
+
"default": "N/A",
|
14311
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14312
|
+
}
|
14313
|
+
],
|
14314
|
+
"slots": [
|
14315
|
+
|
14316
|
+
],
|
14317
|
+
"methods": [
|
14318
|
+
|
14319
|
+
],
|
14320
|
+
"previews": [
|
14321
|
+
{
|
14322
|
+
"preview_path": "primer/box/playground",
|
14323
|
+
"name": "playground",
|
13599
14324
|
"snapshot": "false",
|
13600
14325
|
"skip_rules": {
|
13601
14326
|
"wont_fix": [
|
@@ -13607,8 +14332,8 @@
|
|
13607
14332
|
}
|
13608
14333
|
},
|
13609
14334
|
{
|
13610
|
-
"preview_path": "primer/
|
13611
|
-
"name": "
|
14335
|
+
"preview_path": "primer/box/default",
|
14336
|
+
"name": "default",
|
13612
14337
|
"snapshot": "false",
|
13613
14338
|
"skip_rules": {
|
13614
14339
|
"wont_fix": [
|
@@ -13620,9 +14345,9 @@
|
|
13620
14345
|
}
|
13621
14346
|
},
|
13622
14347
|
{
|
13623
|
-
"preview_path": "primer/
|
13624
|
-
"name": "
|
13625
|
-
"snapshot": "
|
14348
|
+
"preview_path": "primer/box/border",
|
14349
|
+
"name": "border",
|
14350
|
+
"snapshot": "true",
|
13626
14351
|
"skip_rules": {
|
13627
14352
|
"wont_fix": [
|
13628
14353
|
"region"
|
@@ -13633,8 +14358,8 @@
|
|
13633
14358
|
}
|
13634
14359
|
},
|
13635
14360
|
{
|
13636
|
-
"preview_path": "primer/
|
13637
|
-
"name": "
|
14361
|
+
"preview_path": "primer/box/border_bottom",
|
14362
|
+
"name": "border_bottom",
|
13638
14363
|
"snapshot": "true",
|
13639
14364
|
"skip_rules": {
|
13640
14365
|
"wont_fix": [
|
@@ -13647,140 +14372,275 @@
|
|
13647
14372
|
}
|
13648
14373
|
],
|
13649
14374
|
"subcomponents": [
|
14375
|
+
|
14376
|
+
]
|
14377
|
+
},
|
14378
|
+
{
|
14379
|
+
"fully_qualified_name": "Primer::ButtonComponent",
|
14380
|
+
"description": "Use `Button` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.",
|
14381
|
+
"accessibility_docs": null,
|
14382
|
+
"is_form_component": false,
|
14383
|
+
"is_published": true,
|
14384
|
+
"requires_js": true,
|
14385
|
+
"component": "Button",
|
14386
|
+
"status": "deprecated",
|
14387
|
+
"a11y_reviewed": false,
|
14388
|
+
"short_name": "Button",
|
14389
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
|
14390
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button/default/",
|
14391
|
+
"parameters": [
|
13650
14392
|
{
|
13651
|
-
"
|
13652
|
-
"
|
13653
|
-
"
|
13654
|
-
"
|
13655
|
-
|
13656
|
-
|
13657
|
-
"
|
13658
|
-
"
|
13659
|
-
"
|
13660
|
-
"
|
13661
|
-
|
13662
|
-
|
14393
|
+
"name": "scheme",
|
14394
|
+
"type": "Symbol",
|
14395
|
+
"default": "`:default`",
|
14396
|
+
"description": "One of `:danger`, `:default`, `:invisible`, `:link`, `:outline`, or `:primary`."
|
14397
|
+
},
|
14398
|
+
{
|
14399
|
+
"name": "variant",
|
14400
|
+
"type": "Symbol",
|
14401
|
+
"default": "`nil`",
|
14402
|
+
"description": "DEPRECATED. One of `:medium` or `:small`."
|
14403
|
+
},
|
14404
|
+
{
|
14405
|
+
"name": "size",
|
14406
|
+
"type": "Symbol",
|
14407
|
+
"default": "`:medium`",
|
14408
|
+
"description": "One of `:medium` or `:small`."
|
14409
|
+
},
|
14410
|
+
{
|
14411
|
+
"name": "tag",
|
14412
|
+
"type": "Symbol",
|
14413
|
+
"default": "`:button`",
|
14414
|
+
"description": "One of `:a`, `:button`, or `:summary`."
|
14415
|
+
},
|
14416
|
+
{
|
14417
|
+
"name": "type",
|
14418
|
+
"type": "Symbol",
|
14419
|
+
"default": "`:button`",
|
14420
|
+
"description": "One of `:button`, `:reset`, or `:submit`."
|
14421
|
+
},
|
14422
|
+
{
|
14423
|
+
"name": "group_item",
|
14424
|
+
"type": "Boolean",
|
14425
|
+
"default": "`false`",
|
14426
|
+
"description": "Whether button is part of a ButtonGroup."
|
14427
|
+
},
|
14428
|
+
{
|
14429
|
+
"name": "block",
|
14430
|
+
"type": "Boolean",
|
14431
|
+
"default": "`false`",
|
14432
|
+
"description": "Whether button is full-width with `display: block`."
|
14433
|
+
},
|
14434
|
+
{
|
14435
|
+
"name": "dropdown",
|
14436
|
+
"type": "Boolean",
|
14437
|
+
"default": "`false`",
|
14438
|
+
"description": "Whether or not to render a dropdown caret."
|
14439
|
+
},
|
14440
|
+
{
|
14441
|
+
"name": "system_arguments",
|
14442
|
+
"type": "Hash",
|
14443
|
+
"default": "N/A",
|
14444
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14445
|
+
}
|
14446
|
+
],
|
14447
|
+
"slots": [
|
14448
|
+
{
|
14449
|
+
"name": "leading_visual",
|
14450
|
+
"description": "Leading visuals appear to the left of the button text.\n\nUse:\n\n- `leading_visual_icon` for a {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}.",
|
14451
|
+
"parameters": [
|
14452
|
+
{
|
14453
|
+
"name": "system_arguments",
|
14454
|
+
"type": "Hash",
|
14455
|
+
"default": "N/A",
|
14456
|
+
"description": "Same arguments as {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}."
|
14457
|
+
}
|
14458
|
+
]
|
14459
|
+
},
|
14460
|
+
{
|
14461
|
+
"name": "trailing_visual",
|
14462
|
+
"description": "Trailing visuals appear to the right of the button text.\n\nUse:\n\n- `trailing_visual_counter` for a {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}.",
|
14463
|
+
"parameters": [
|
14464
|
+
{
|
14465
|
+
"name": "system_arguments",
|
14466
|
+
"type": "Hash",
|
14467
|
+
"default": "N/A",
|
14468
|
+
"description": "Same arguments as {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}."
|
14469
|
+
}
|
14470
|
+
]
|
14471
|
+
},
|
14472
|
+
{
|
14473
|
+
"name": "tooltip",
|
14474
|
+
"description": "`Tooltip` that appears on mouse hover or keyboard focus over the button. Use tooltips sparingly and as a last resort.\n**Important:** This tooltip defaults to `type: :description`. In a few scenarios, `type: :label` may be more appropriate.\nConsult the {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}} documentation for more information.",
|
14475
|
+
"parameters": [
|
14476
|
+
{
|
14477
|
+
"name": "type",
|
14478
|
+
"type": "Symbol",
|
14479
|
+
"default": "`:description`",
|
14480
|
+
"description": "One of `:description` or `:label`."
|
14481
|
+
},
|
14482
|
+
{
|
14483
|
+
"name": "system_arguments",
|
14484
|
+
"type": "Hash",
|
14485
|
+
"default": "N/A",
|
14486
|
+
"description": "Same arguments as {{#link_to_component}}Primer::Alpha::Tooltip{{/link_to_component}}."
|
14487
|
+
}
|
14488
|
+
]
|
14489
|
+
}
|
14490
|
+
],
|
14491
|
+
"methods": [
|
14492
|
+
{
|
14493
|
+
"name": "icon",
|
14494
|
+
"description": "remove alias when all buttons are migrated to new slot names",
|
13663
14495
|
"parameters": [
|
13664
14496
|
|
13665
|
-
]
|
13666
|
-
|
13667
|
-
|
13668
|
-
|
13669
|
-
"
|
14497
|
+
]
|
14498
|
+
},
|
14499
|
+
{
|
14500
|
+
"name": "counter",
|
14501
|
+
"description": "remove alias when all buttons are migrated to new slot names",
|
14502
|
+
"parameters": [
|
13670
14503
|
|
13671
|
-
]
|
13672
|
-
|
14504
|
+
]
|
14505
|
+
}
|
14506
|
+
],
|
14507
|
+
"previews": [
|
13673
14508
|
|
13674
|
-
|
13675
|
-
|
14509
|
+
],
|
14510
|
+
"subcomponents": [
|
13676
14511
|
|
13677
|
-
|
14512
|
+
]
|
14513
|
+
},
|
14514
|
+
{
|
14515
|
+
"fully_qualified_name": "Primer::ConditionalWrapper",
|
14516
|
+
"description": "Conditionally renders a `Primer::BaseComponent` around the given content. If the given condition\nis true, a `Primer::BaseComponent` will render around the content. If the condition is false, only\nthe content is rendered.",
|
14517
|
+
"accessibility_docs": null,
|
14518
|
+
"is_form_component": false,
|
14519
|
+
"is_published": true,
|
14520
|
+
"requires_js": false,
|
14521
|
+
"component": "ConditionalWrapper",
|
14522
|
+
"status": "alpha",
|
14523
|
+
"a11y_reviewed": false,
|
14524
|
+
"short_name": "ConditionalWrapper",
|
14525
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/conditional_wrapper.rb",
|
14526
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/conditional_wrapper/default/",
|
14527
|
+
"parameters": [
|
14528
|
+
{
|
14529
|
+
"name": "condition",
|
14530
|
+
"type": "Boolean",
|
14531
|
+
"default": "N/A",
|
14532
|
+
"description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
|
14533
|
+
},
|
14534
|
+
{
|
14535
|
+
"name": "base_component_arguments",
|
14536
|
+
"type": "Hash",
|
14537
|
+
"default": "N/A",
|
14538
|
+
"description": "The arguments to pass to `Primer::BaseComponent`."
|
13678
14539
|
}
|
14540
|
+
],
|
14541
|
+
"slots": [
|
14542
|
+
|
14543
|
+
],
|
14544
|
+
"methods": [
|
14545
|
+
|
14546
|
+
],
|
14547
|
+
"previews": [
|
14548
|
+
|
14549
|
+
],
|
14550
|
+
"subcomponents": [
|
14551
|
+
|
13679
14552
|
]
|
13680
14553
|
},
|
13681
14554
|
{
|
13682
|
-
"fully_qualified_name": "Primer::
|
13683
|
-
"description": "Use `
|
13684
|
-
"accessibility_docs":
|
14555
|
+
"fully_qualified_name": "Primer::Content",
|
14556
|
+
"description": "Use `Content` as a helper to render content passed to a slot without adding any tags.",
|
14557
|
+
"accessibility_docs": null,
|
13685
14558
|
"is_form_component": false,
|
13686
14559
|
"is_published": true,
|
13687
14560
|
"requires_js": false,
|
13688
|
-
"component": "
|
14561
|
+
"component": "Content",
|
14562
|
+
"status": "stable",
|
14563
|
+
"a11y_reviewed": false,
|
14564
|
+
"short_name": "Content",
|
14565
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/content.rb",
|
14566
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/content/default/",
|
14567
|
+
"parameters": [
|
14568
|
+
|
14569
|
+
],
|
14570
|
+
"slots": [
|
14571
|
+
|
14572
|
+
],
|
14573
|
+
"methods": [
|
14574
|
+
|
14575
|
+
],
|
14576
|
+
"previews": [
|
14577
|
+
|
14578
|
+
],
|
14579
|
+
"subcomponents": [
|
14580
|
+
|
14581
|
+
]
|
14582
|
+
},
|
14583
|
+
{
|
14584
|
+
"fully_qualified_name": "Primer::IconButton",
|
14585
|
+
"description": "Use `IconButton` to render Icon-only buttons without the default button styles.\n\n`IconButton` will always render with a tooltip unless the tag is `:summary`.",
|
14586
|
+
"accessibility_docs": "`IconButton` requires an `aria-label`, which will provide assistive technologies with an accessible label.\nThe `aria-label` should describe the action to be invoked rather than the icon itself. For instance,\nif your `IconButton` renders a magnifying glass icon and invokes a search action, the `aria-label` should be\n`\"Search\"` instead of `\"Magnifying glass\"`.\nEither `aria-label` or `aria-description` will be used for the `Tooltip` text, depending on which one is present.\n[Learn more about best functional image practices (WAI Images)](https://www.w3.org/WAI/tutorials/images/functional)",
|
14587
|
+
"is_form_component": false,
|
14588
|
+
"is_published": true,
|
14589
|
+
"requires_js": true,
|
14590
|
+
"component": "IconButton",
|
13689
14591
|
"status": "deprecated",
|
13690
14592
|
"a11y_reviewed": false,
|
13691
|
-
"short_name": "
|
13692
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
13693
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
14593
|
+
"short_name": "IconButton",
|
14594
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb",
|
14595
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button/default/",
|
13694
14596
|
"parameters": [
|
13695
14597
|
{
|
13696
|
-
"name": "
|
13697
|
-
"type": "String",
|
13698
|
-
"default": "`\"\"`",
|
13699
|
-
"description": "Text that appears in a larger bold font."
|
13700
|
-
},
|
13701
|
-
{
|
13702
|
-
"name": "title_tag",
|
14598
|
+
"name": "scheme",
|
13703
14599
|
"type": "Symbol",
|
13704
|
-
"default": "`:
|
13705
|
-
"description": "
|
14600
|
+
"default": "`:default`",
|
14601
|
+
"description": "One of `:danger` or `:default`."
|
13706
14602
|
},
|
13707
14603
|
{
|
13708
14604
|
"name": "icon",
|
13709
|
-
"type": "Symbol",
|
13710
|
-
"default": "`\"\"`",
|
13711
|
-
"description": "Octicon icon to use at top of component."
|
13712
|
-
},
|
13713
|
-
{
|
13714
|
-
"name": "icon_size",
|
13715
|
-
"type": "Symbol",
|
13716
|
-
"default": "`:medium`",
|
13717
|
-
"description": "One of `:xsmall` (`12`), `:small` (`16`), or `:medium` (`24`)."
|
13718
|
-
},
|
13719
|
-
{
|
13720
|
-
"name": "image_src",
|
13721
|
-
"type": "String",
|
13722
|
-
"default": "`\"\"`",
|
13723
|
-
"description": "Image to display."
|
13724
|
-
},
|
13725
|
-
{
|
13726
|
-
"name": "image_alt",
|
13727
14605
|
"type": "String",
|
13728
|
-
"default": "
|
13729
|
-
"description": "
|
13730
|
-
},
|
13731
|
-
{
|
13732
|
-
"name": "description",
|
13733
|
-
"type": "String",
|
13734
|
-
"default": "`\"\"`",
|
13735
|
-
"description": "Text that appears below the title. Typically a whole sentence."
|
13736
|
-
},
|
13737
|
-
{
|
13738
|
-
"name": "button_text",
|
13739
|
-
"type": "String",
|
13740
|
-
"default": "`\"\"`",
|
13741
|
-
"description": "The text of the button."
|
14606
|
+
"default": "N/A",
|
14607
|
+
"description": "Name of {{link_to_octicons}} to use."
|
13742
14608
|
},
|
13743
14609
|
{
|
13744
|
-
"name": "
|
13745
|
-
"type": "
|
13746
|
-
"default": "
|
13747
|
-
"description": "
|
14610
|
+
"name": "tag",
|
14611
|
+
"type": "Symbol",
|
14612
|
+
"default": "N/A",
|
14613
|
+
"description": "One of `:a`, `:button`, or `:summary`."
|
13748
14614
|
},
|
13749
14615
|
{
|
13750
|
-
"name": "
|
13751
|
-
"type": "
|
13752
|
-
"default": "
|
13753
|
-
"description": "
|
14616
|
+
"name": "type",
|
14617
|
+
"type": "Symbol",
|
14618
|
+
"default": "N/A",
|
14619
|
+
"description": "One of `:button`, `:reset`, or `:submit`."
|
13754
14620
|
},
|
13755
14621
|
{
|
13756
|
-
"name": "
|
14622
|
+
"name": "aria-label",
|
13757
14623
|
"type": "String",
|
13758
|
-
"default": "
|
13759
|
-
"description": "
|
14624
|
+
"default": "N/A",
|
14625
|
+
"description": "String that can be read by assistive technology. A label should be short and concise. See the accessibility section for more information."
|
13760
14626
|
},
|
13761
14627
|
{
|
13762
|
-
"name": "
|
14628
|
+
"name": "aria-description",
|
13763
14629
|
"type": "String",
|
13764
|
-
"default": "
|
13765
|
-
"description": "
|
13766
|
-
},
|
13767
|
-
{
|
13768
|
-
"name": "narrow",
|
13769
|
-
"type": "Boolean",
|
13770
|
-
"default": "`false`",
|
13771
|
-
"description": "Adds a maximum width."
|
14630
|
+
"default": "N/A",
|
14631
|
+
"description": "String that can be read by assistive technology. A description can be longer as it is intended to provide more context and information. See the accessibility section for more information."
|
13772
14632
|
},
|
13773
14633
|
{
|
13774
|
-
"name": "
|
13775
|
-
"type": "
|
13776
|
-
"default": "`
|
13777
|
-
"description": "
|
14634
|
+
"name": "tooltip_direction",
|
14635
|
+
"type": "Symbol",
|
14636
|
+
"default": "`:s`",
|
14637
|
+
"description": "One of `:e`, `:n`, `:ne`, `:nw`, `:s`, `:se`, `:sw`, or `:w`."
|
13778
14638
|
},
|
13779
14639
|
{
|
13780
|
-
"name": "
|
14640
|
+
"name": "box",
|
13781
14641
|
"type": "Boolean",
|
13782
14642
|
"default": "`false`",
|
13783
|
-
"description": "
|
14643
|
+
"description": "Whether the button is in a {{#link_to_component}}Primer::Beta::BorderBox{{/link_to_component}}. If `true`, the button will have the `Box-btn-octicon` class."
|
13784
14644
|
},
|
13785
14645
|
{
|
13786
14646
|
"name": "system_arguments",
|
@@ -13790,18 +14650,7 @@
|
|
13790
14650
|
}
|
13791
14651
|
],
|
13792
14652
|
"slots": [
|
13793
|
-
|
13794
|
-
"name": "spinner",
|
13795
|
-
"description": "Optional Spinner.",
|
13796
|
-
"parameters": [
|
13797
|
-
{
|
13798
|
-
"name": "kwargs",
|
13799
|
-
"type": "Hash",
|
13800
|
-
"default": "N/A",
|
13801
|
-
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Spinner{{/link_to_component}}."
|
13802
|
-
}
|
13803
|
-
]
|
13804
|
-
}
|
14653
|
+
|
13805
14654
|
],
|
13806
14655
|
"methods": [
|
13807
14656
|
|
@@ -13814,19 +14663,37 @@
|
|
13814
14663
|
]
|
13815
14664
|
},
|
13816
14665
|
{
|
13817
|
-
"fully_qualified_name": "Primer::
|
13818
|
-
"description": "`
|
14666
|
+
"fully_qualified_name": "Primer::LayoutComponent",
|
14667
|
+
"description": "Use `Layout` to build a main/sidebar layout.",
|
13819
14668
|
"accessibility_docs": null,
|
13820
14669
|
"is_form_component": false,
|
13821
14670
|
"is_published": true,
|
13822
14671
|
"requires_js": false,
|
13823
|
-
"component": "
|
13824
|
-
"status": "
|
14672
|
+
"component": "Layout",
|
14673
|
+
"status": "deprecated",
|
13825
14674
|
"a11y_reviewed": false,
|
13826
|
-
"short_name": "
|
13827
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
13828
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
14675
|
+
"short_name": "Layout",
|
14676
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb",
|
14677
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout/default/",
|
13829
14678
|
"parameters": [
|
14679
|
+
{
|
14680
|
+
"name": "responsive",
|
14681
|
+
"type": "Boolean",
|
14682
|
+
"default": "`false`",
|
14683
|
+
"description": "Whether to collapse layout to a single column at smaller widths."
|
14684
|
+
},
|
14685
|
+
{
|
14686
|
+
"name": "side",
|
14687
|
+
"type": "Symbol",
|
14688
|
+
"default": "`:right`",
|
14689
|
+
"description": "Which side to display the sidebar on. One of `:left` or `:right`."
|
14690
|
+
},
|
14691
|
+
{
|
14692
|
+
"name": "sidebar_col",
|
14693
|
+
"type": "Integer",
|
14694
|
+
"default": "`3`",
|
14695
|
+
"description": "Sidebar column width."
|
14696
|
+
},
|
13830
14697
|
{
|
13831
14698
|
"name": "system_arguments",
|
13832
14699
|
"type": "Hash",
|
@@ -13835,130 +14702,90 @@
|
|
13835
14702
|
}
|
13836
14703
|
],
|
13837
14704
|
"slots": [
|
13838
|
-
|
14705
|
+
{
|
14706
|
+
"name": "main",
|
14707
|
+
"description": "The main content",
|
14708
|
+
"parameters": [
|
14709
|
+
{
|
14710
|
+
"name": "system_arguments",
|
14711
|
+
"type": "Hash",
|
14712
|
+
"default": "N/A",
|
14713
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14714
|
+
}
|
14715
|
+
]
|
14716
|
+
},
|
14717
|
+
{
|
14718
|
+
"name": "sidebar",
|
14719
|
+
"description": "The sidebar content",
|
14720
|
+
"parameters": [
|
14721
|
+
{
|
14722
|
+
"name": "system_arguments",
|
14723
|
+
"type": "Hash",
|
14724
|
+
"default": "N/A",
|
14725
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14726
|
+
}
|
14727
|
+
]
|
14728
|
+
}
|
13839
14729
|
],
|
13840
14730
|
"methods": [
|
13841
14731
|
|
13842
14732
|
],
|
13843
14733
|
"previews": [
|
13844
|
-
|
13845
|
-
"preview_path": "primer/box/playground",
|
13846
|
-
"name": "playground",
|
13847
|
-
"snapshot": "false",
|
13848
|
-
"skip_rules": {
|
13849
|
-
"wont_fix": [
|
13850
|
-
"region"
|
13851
|
-
],
|
13852
|
-
"will_fix": [
|
13853
|
-
"color-contrast"
|
13854
|
-
]
|
13855
|
-
}
|
13856
|
-
},
|
13857
|
-
{
|
13858
|
-
"preview_path": "primer/box/default",
|
13859
|
-
"name": "default",
|
13860
|
-
"snapshot": "false",
|
13861
|
-
"skip_rules": {
|
13862
|
-
"wont_fix": [
|
13863
|
-
"region"
|
13864
|
-
],
|
13865
|
-
"will_fix": [
|
13866
|
-
"color-contrast"
|
13867
|
-
]
|
13868
|
-
}
|
13869
|
-
},
|
13870
|
-
{
|
13871
|
-
"preview_path": "primer/box/border",
|
13872
|
-
"name": "border",
|
13873
|
-
"snapshot": "true",
|
13874
|
-
"skip_rules": {
|
13875
|
-
"wont_fix": [
|
13876
|
-
"region"
|
13877
|
-
],
|
13878
|
-
"will_fix": [
|
13879
|
-
"color-contrast"
|
13880
|
-
]
|
13881
|
-
}
|
13882
|
-
},
|
13883
|
-
{
|
13884
|
-
"preview_path": "primer/box/border_bottom",
|
13885
|
-
"name": "border_bottom",
|
13886
|
-
"snapshot": "true",
|
13887
|
-
"skip_rules": {
|
13888
|
-
"wont_fix": [
|
13889
|
-
"region"
|
13890
|
-
],
|
13891
|
-
"will_fix": [
|
13892
|
-
"color-contrast"
|
13893
|
-
]
|
13894
|
-
}
|
13895
|
-
}
|
14734
|
+
|
13896
14735
|
],
|
13897
14736
|
"subcomponents": [
|
13898
14737
|
|
13899
14738
|
]
|
13900
14739
|
},
|
13901
14740
|
{
|
13902
|
-
"fully_qualified_name": "Primer::
|
13903
|
-
"description": "
|
14741
|
+
"fully_qualified_name": "Primer::Navigation::TabComponent",
|
14742
|
+
"description": "nodoc",
|
13904
14743
|
"accessibility_docs": null,
|
13905
14744
|
"is_form_component": false,
|
13906
14745
|
"is_published": true,
|
13907
|
-
"requires_js":
|
13908
|
-
"component": "
|
14746
|
+
"requires_js": false,
|
14747
|
+
"component": "Navigation::Tab",
|
13909
14748
|
"status": "deprecated",
|
13910
14749
|
"a11y_reviewed": false,
|
13911
|
-
"short_name": "
|
13912
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
13913
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
13914
|
-
"parameters": [
|
13915
|
-
{
|
13916
|
-
"name": "scheme",
|
13917
|
-
"type": "Symbol",
|
13918
|
-
"default": "`:default`",
|
13919
|
-
"description": "One of `:danger`, `:default`, `:invisible`, `:link`, `:outline`, or `:primary`."
|
13920
|
-
},
|
13921
|
-
{
|
13922
|
-
"name": "variant",
|
13923
|
-
"type": "Symbol",
|
13924
|
-
"default": "`nil`",
|
13925
|
-
"description": "DEPRECATED. One of `:medium` or `:small`."
|
13926
|
-
},
|
13927
|
-
{
|
13928
|
-
"name": "size",
|
13929
|
-
"type": "Symbol",
|
13930
|
-
"default": "`:medium`",
|
13931
|
-
"description": "One of `:medium` or `:small`."
|
13932
|
-
},
|
13933
|
-
{
|
13934
|
-
"name": "tag",
|
13935
|
-
"type": "Symbol",
|
13936
|
-
"default": "`:button`",
|
13937
|
-
"description": "One of `:a`, `:button`, or `:summary`."
|
13938
|
-
},
|
14750
|
+
"short_name": "NavigationTab",
|
14751
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb",
|
14752
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab/default/",
|
14753
|
+
"parameters": [
|
13939
14754
|
{
|
13940
|
-
"name": "
|
13941
|
-
"type": "
|
13942
|
-
"default": "
|
13943
|
-
"description": "
|
14755
|
+
"name": "list",
|
14756
|
+
"type": "Boolean",
|
14757
|
+
"default": "`false`",
|
14758
|
+
"description": "Whether the Tab is an item in a `<ul>` list."
|
13944
14759
|
},
|
13945
14760
|
{
|
13946
|
-
"name": "
|
14761
|
+
"name": "selected",
|
13947
14762
|
"type": "Boolean",
|
13948
14763
|
"default": "`false`",
|
13949
|
-
"description": "Whether
|
14764
|
+
"description": "Whether the Tab is selected or not."
|
13950
14765
|
},
|
13951
14766
|
{
|
13952
|
-
"name": "
|
14767
|
+
"name": "with_panel",
|
13953
14768
|
"type": "Boolean",
|
13954
14769
|
"default": "`false`",
|
13955
|
-
"description": "Whether
|
14770
|
+
"description": "Whether the Tab has an associated panel."
|
13956
14771
|
},
|
13957
14772
|
{
|
13958
|
-
"name": "
|
14773
|
+
"name": "panel_id",
|
14774
|
+
"type": "String",
|
14775
|
+
"default": "`\"\"`",
|
14776
|
+
"description": "Only applies if `with_panel` is `true`. Unique id of panel."
|
14777
|
+
},
|
14778
|
+
{
|
14779
|
+
"name": "icon_classes",
|
13959
14780
|
"type": "Boolean",
|
13960
|
-
"default": "`
|
13961
|
-
"description": "
|
14781
|
+
"default": "`\"\"`",
|
14782
|
+
"description": "Classes that must always be applied to icons."
|
14783
|
+
},
|
14784
|
+
{
|
14785
|
+
"name": "wrapper_arguments",
|
14786
|
+
"type": "Hash",
|
14787
|
+
"default": "`{}`",
|
14788
|
+
"description": "{{link_to_system_arguments_docs}} to be used in the `<li>` wrapper when the tab is an item in a list."
|
13962
14789
|
},
|
13963
14790
|
{
|
13964
14791
|
"name": "system_arguments",
|
@@ -13969,63 +14796,56 @@
|
|
13969
14796
|
],
|
13970
14797
|
"slots": [
|
13971
14798
|
{
|
13972
|
-
"name": "
|
13973
|
-
"description": "
|
14799
|
+
"name": "panel",
|
14800
|
+
"description": "Panel controlled by the Tab. This will not render anything in the tab itself.\nIt will provide a accessor for the Tab's parent to call and render the panel\ncontent in the appropriate place.\nRefer to `UnderlineNav` and `TabNav` implementations for examples.",
|
13974
14801
|
"parameters": [
|
13975
14802
|
{
|
13976
14803
|
"name": "system_arguments",
|
13977
14804
|
"type": "Hash",
|
13978
14805
|
"default": "N/A",
|
13979
|
-
"description": "
|
14806
|
+
"description": "{{link_to_system_arguments_docs}}"
|
13980
14807
|
}
|
13981
14808
|
]
|
13982
14809
|
},
|
13983
14810
|
{
|
13984
|
-
"name": "
|
13985
|
-
"description": "
|
14811
|
+
"name": "icon",
|
14812
|
+
"description": "Icon to be rendered in the Tab left.",
|
13986
14813
|
"parameters": [
|
13987
14814
|
{
|
13988
|
-
"name": "
|
14815
|
+
"name": "kwargs",
|
13989
14816
|
"type": "Hash",
|
13990
14817
|
"default": "N/A",
|
13991
|
-
"description": "
|
14818
|
+
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}."
|
13992
14819
|
}
|
13993
14820
|
]
|
13994
14821
|
},
|
13995
14822
|
{
|
13996
|
-
"name": "
|
13997
|
-
"description": "
|
14823
|
+
"name": "text",
|
14824
|
+
"description": "The Tab's text.",
|
13998
14825
|
"parameters": [
|
13999
14826
|
{
|
14000
|
-
"name": "
|
14001
|
-
"type": "Symbol",
|
14002
|
-
"default": "`:description`",
|
14003
|
-
"description": "One of `:description` or `:label`."
|
14004
|
-
},
|
14005
|
-
{
|
14006
|
-
"name": "system_arguments",
|
14827
|
+
"name": "kwargs",
|
14007
14828
|
"type": "Hash",
|
14008
14829
|
"default": "N/A",
|
14009
|
-
"description": "
|
14830
|
+
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Text{{/link_to_component}}."
|
14010
14831
|
}
|
14011
14832
|
]
|
14012
|
-
}
|
14013
|
-
],
|
14014
|
-
"methods": [
|
14015
|
-
{
|
14016
|
-
"name": "icon",
|
14017
|
-
"description": "remove alias when all buttons are migrated to new slot names",
|
14018
|
-
"parameters": [
|
14019
|
-
|
14020
|
-
]
|
14021
14833
|
},
|
14022
14834
|
{
|
14023
14835
|
"name": "counter",
|
14024
|
-
"description": "
|
14836
|
+
"description": "Counter to be rendered in the Tab right.",
|
14025
14837
|
"parameters": [
|
14026
|
-
|
14838
|
+
{
|
14839
|
+
"name": "kwargs",
|
14840
|
+
"type": "Hash",
|
14841
|
+
"default": "N/A",
|
14842
|
+
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}."
|
14843
|
+
}
|
14027
14844
|
]
|
14028
14845
|
}
|
14846
|
+
],
|
14847
|
+
"methods": [
|
14848
|
+
|
14029
14849
|
],
|
14030
14850
|
"previews": [
|
14031
14851
|
|
@@ -14035,60 +14855,114 @@
|
|
14035
14855
|
]
|
14036
14856
|
},
|
14037
14857
|
{
|
14038
|
-
"fully_qualified_name": "Primer::
|
14039
|
-
"description": "
|
14858
|
+
"fully_qualified_name": "Primer::OpenProject::BorderGrid",
|
14859
|
+
"description": "A set of blocks that are shown below each other with separator lines in between",
|
14040
14860
|
"accessibility_docs": null,
|
14041
14861
|
"is_form_component": false,
|
14042
14862
|
"is_published": true,
|
14043
14863
|
"requires_js": false,
|
14044
|
-
"component": "
|
14045
|
-
"status": "
|
14864
|
+
"component": "OpenProject::BorderGrid",
|
14865
|
+
"status": "open_project",
|
14046
14866
|
"a11y_reviewed": false,
|
14047
|
-
"short_name": "
|
14048
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
14049
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
14867
|
+
"short_name": "OpenProjectBorderGrid",
|
14868
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/border_grid.rb",
|
14869
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/border_grid/default/",
|
14050
14870
|
"parameters": [
|
14051
14871
|
{
|
14052
|
-
"name": "
|
14872
|
+
"name": "spacious",
|
14053
14873
|
"type": "Boolean",
|
14054
|
-
"default": "
|
14055
|
-
"description": "Whether
|
14874
|
+
"default": "`false`",
|
14875
|
+
"description": "Whether to add margin to the bottom of the component."
|
14056
14876
|
},
|
14057
14877
|
{
|
14058
|
-
"name": "
|
14878
|
+
"name": "system_arguments",
|
14059
14879
|
"type": "Hash",
|
14060
14880
|
"default": "N/A",
|
14061
|
-
"description": "
|
14881
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14062
14882
|
}
|
14063
14883
|
],
|
14064
14884
|
"slots": [
|
14065
|
-
|
14885
|
+
{
|
14886
|
+
"name": "rows",
|
14887
|
+
"description": "Use to render a block inside the grid",
|
14888
|
+
"parameters": [
|
14889
|
+
{
|
14890
|
+
"name": "system_arguments",
|
14891
|
+
"type": "Hash",
|
14892
|
+
"default": "N/A",
|
14893
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14894
|
+
}
|
14895
|
+
]
|
14896
|
+
}
|
14066
14897
|
],
|
14067
14898
|
"methods": [
|
14068
14899
|
|
14069
14900
|
],
|
14070
14901
|
"previews": [
|
14071
|
-
|
14902
|
+
{
|
14903
|
+
"preview_path": "primer/open_project/border_grid/playground",
|
14904
|
+
"name": "playground",
|
14905
|
+
"snapshot": "false",
|
14906
|
+
"skip_rules": {
|
14907
|
+
"wont_fix": [
|
14908
|
+
"region"
|
14909
|
+
],
|
14910
|
+
"will_fix": [
|
14911
|
+
"color-contrast"
|
14912
|
+
]
|
14913
|
+
}
|
14914
|
+
},
|
14915
|
+
{
|
14916
|
+
"preview_path": "primer/open_project/border_grid/default",
|
14917
|
+
"name": "default",
|
14918
|
+
"snapshot": "true",
|
14919
|
+
"skip_rules": {
|
14920
|
+
"wont_fix": [
|
14921
|
+
"region"
|
14922
|
+
],
|
14923
|
+
"will_fix": [
|
14924
|
+
"color-contrast"
|
14925
|
+
]
|
14926
|
+
}
|
14927
|
+
},
|
14928
|
+
{
|
14929
|
+
"preview_path": "primer/open_project/border_grid/spacious",
|
14930
|
+
"name": "spacious",
|
14931
|
+
"snapshot": "false",
|
14932
|
+
"skip_rules": {
|
14933
|
+
"wont_fix": [
|
14934
|
+
"region"
|
14935
|
+
],
|
14936
|
+
"will_fix": [
|
14937
|
+
"color-contrast"
|
14938
|
+
]
|
14939
|
+
}
|
14940
|
+
}
|
14072
14941
|
],
|
14073
14942
|
"subcomponents": [
|
14074
14943
|
|
14075
14944
|
]
|
14076
14945
|
},
|
14077
14946
|
{
|
14078
|
-
"fully_qualified_name": "Primer::
|
14079
|
-
"description": "
|
14947
|
+
"fully_qualified_name": "Primer::OpenProject::BorderGrid::Cell",
|
14948
|
+
"description": "A single cell inside the BorderGrid\nA cell can contain for example an action list or a status badge",
|
14080
14949
|
"accessibility_docs": null,
|
14081
14950
|
"is_form_component": false,
|
14082
14951
|
"is_published": true,
|
14083
14952
|
"requires_js": false,
|
14084
|
-
"component": "
|
14085
|
-
"status": "
|
14953
|
+
"component": "OpenProject::BorderGrid::Cell",
|
14954
|
+
"status": "open_project",
|
14086
14955
|
"a11y_reviewed": false,
|
14087
|
-
"short_name": "
|
14088
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
14089
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
14956
|
+
"short_name": "OpenProjectBorderGridCell",
|
14957
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/border_grid/cell.rb",
|
14958
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/border_grid/cell/default/",
|
14090
14959
|
"parameters": [
|
14091
|
-
|
14960
|
+
{
|
14961
|
+
"name": "system_arguments",
|
14962
|
+
"type": "Hash",
|
14963
|
+
"default": "N/A",
|
14964
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14965
|
+
}
|
14092
14966
|
],
|
14093
14967
|
"slots": [
|
14094
14968
|
|
@@ -14104,67 +14978,78 @@
|
|
14104
14978
|
]
|
14105
14979
|
},
|
14106
14980
|
{
|
14107
|
-
"fully_qualified_name": "Primer::
|
14108
|
-
"description": "
|
14109
|
-
"accessibility_docs": "
|
14981
|
+
"fully_qualified_name": "Primer::OpenProject::DragHandle",
|
14982
|
+
"description": "Add a general description of component here\nAdd additional usage considerations or best practices that may aid the user to use the component correctly.",
|
14983
|
+
"accessibility_docs": "Add any accessibility considerations",
|
14110
14984
|
"is_form_component": false,
|
14111
14985
|
"is_published": true,
|
14112
|
-
"requires_js":
|
14113
|
-
"component": "
|
14114
|
-
"status": "
|
14986
|
+
"requires_js": false,
|
14987
|
+
"component": "OpenProject::DragHandle",
|
14988
|
+
"status": "open_project",
|
14115
14989
|
"a11y_reviewed": false,
|
14116
|
-
"short_name": "
|
14117
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
14118
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
14990
|
+
"short_name": "OpenProjectDragHandle",
|
14991
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/drag_handle.rb",
|
14992
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/drag_handle/default/",
|
14119
14993
|
"parameters": [
|
14120
14994
|
{
|
14121
|
-
"name": "
|
14122
|
-
"type": "
|
14123
|
-
"default": "`:default`",
|
14124
|
-
"description": "One of `:danger` or `:default`."
|
14125
|
-
},
|
14126
|
-
{
|
14127
|
-
"name": "icon",
|
14128
|
-
"type": "String",
|
14129
|
-
"default": "N/A",
|
14130
|
-
"description": "Name of {{link_to_octicons}} to use."
|
14131
|
-
},
|
14132
|
-
{
|
14133
|
-
"name": "tag",
|
14134
|
-
"type": "Symbol",
|
14135
|
-
"default": "N/A",
|
14136
|
-
"description": "One of `:a`, `:button`, or `:summary`."
|
14137
|
-
},
|
14138
|
-
{
|
14139
|
-
"name": "type",
|
14140
|
-
"type": "Symbol",
|
14141
|
-
"default": "N/A",
|
14142
|
-
"description": "One of `:button`, `:reset`, or `:submit`."
|
14143
|
-
},
|
14144
|
-
{
|
14145
|
-
"name": "aria-label",
|
14146
|
-
"type": "String",
|
14147
|
-
"default": "N/A",
|
14148
|
-
"description": "String that can be read by assistive technology. A label should be short and concise. See the accessibility section for more information."
|
14149
|
-
},
|
14150
|
-
{
|
14151
|
-
"name": "aria-description",
|
14152
|
-
"type": "String",
|
14995
|
+
"name": "system_arguments",
|
14996
|
+
"type": "Hash",
|
14153
14997
|
"default": "N/A",
|
14154
|
-
"description": "
|
14155
|
-
}
|
14998
|
+
"description": "{{link_to_system_arguments_docs}}"
|
14999
|
+
}
|
15000
|
+
],
|
15001
|
+
"slots": [
|
15002
|
+
|
15003
|
+
],
|
15004
|
+
"methods": [
|
15005
|
+
|
15006
|
+
],
|
15007
|
+
"previews": [
|
14156
15008
|
{
|
14157
|
-
"
|
14158
|
-
"
|
14159
|
-
"
|
14160
|
-
"
|
15009
|
+
"preview_path": "primer/open_project/drag_handle/default",
|
15010
|
+
"name": "default",
|
15011
|
+
"snapshot": "true",
|
15012
|
+
"skip_rules": {
|
15013
|
+
"wont_fix": [
|
15014
|
+
"region"
|
15015
|
+
],
|
15016
|
+
"will_fix": [
|
15017
|
+
"color-contrast"
|
15018
|
+
]
|
15019
|
+
}
|
14161
15020
|
},
|
14162
15021
|
{
|
14163
|
-
"
|
14164
|
-
"
|
14165
|
-
"
|
14166
|
-
"
|
14167
|
-
|
15022
|
+
"preview_path": "primer/open_project/drag_handle/playground",
|
15023
|
+
"name": "playground",
|
15024
|
+
"snapshot": "false",
|
15025
|
+
"skip_rules": {
|
15026
|
+
"wont_fix": [
|
15027
|
+
"region"
|
15028
|
+
],
|
15029
|
+
"will_fix": [
|
15030
|
+
"color-contrast"
|
15031
|
+
]
|
15032
|
+
}
|
15033
|
+
}
|
15034
|
+
],
|
15035
|
+
"subcomponents": [
|
15036
|
+
|
15037
|
+
]
|
15038
|
+
},
|
15039
|
+
{
|
15040
|
+
"fully_qualified_name": "Primer::OpenProject::FlexLayout",
|
15041
|
+
"description": "A layouting component used to arrange multiple components next / below each other",
|
15042
|
+
"accessibility_docs": null,
|
15043
|
+
"is_form_component": false,
|
15044
|
+
"is_published": true,
|
15045
|
+
"requires_js": false,
|
15046
|
+
"component": "OpenProject::FlexLayout",
|
15047
|
+
"status": "open_project",
|
15048
|
+
"a11y_reviewed": false,
|
15049
|
+
"short_name": "OpenProjectFlexLayout",
|
15050
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/flex_layout.rb",
|
15051
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/flex_layout/default/",
|
15052
|
+
"parameters": [
|
14168
15053
|
{
|
14169
15054
|
"name": "system_arguments",
|
14170
15055
|
"type": "Hash",
|
@@ -14173,49 +15058,121 @@
|
|
14173
15058
|
}
|
14174
15059
|
],
|
14175
15060
|
"slots": [
|
15061
|
+
{
|
15062
|
+
"name": "rows",
|
15063
|
+
"description": null,
|
15064
|
+
"parameters": [
|
15065
|
+
|
15066
|
+
]
|
15067
|
+
},
|
15068
|
+
{
|
15069
|
+
"name": "columns",
|
15070
|
+
"description": null,
|
15071
|
+
"parameters": [
|
15072
|
+
|
15073
|
+
]
|
15074
|
+
},
|
15075
|
+
{
|
15076
|
+
"name": "boxes",
|
15077
|
+
"description": "boxes are used when direction is set to row or column based on responsive breakpoints",
|
15078
|
+
"parameters": [
|
14176
15079
|
|
15080
|
+
]
|
15081
|
+
}
|
14177
15082
|
],
|
14178
15083
|
"methods": [
|
14179
15084
|
|
14180
15085
|
],
|
14181
15086
|
"previews": [
|
14182
|
-
|
15087
|
+
{
|
15088
|
+
"preview_path": "primer/open_project/flex_layout/playground",
|
15089
|
+
"name": "playground",
|
15090
|
+
"snapshot": "false",
|
15091
|
+
"skip_rules": {
|
15092
|
+
"wont_fix": [
|
15093
|
+
"region"
|
15094
|
+
],
|
15095
|
+
"will_fix": [
|
15096
|
+
"color-contrast"
|
15097
|
+
]
|
15098
|
+
}
|
15099
|
+
},
|
15100
|
+
{
|
15101
|
+
"preview_path": "primer/open_project/flex_layout/default",
|
15102
|
+
"name": "default",
|
15103
|
+
"snapshot": "false",
|
15104
|
+
"skip_rules": {
|
15105
|
+
"wont_fix": [
|
15106
|
+
"region"
|
15107
|
+
],
|
15108
|
+
"will_fix": [
|
15109
|
+
"color-contrast"
|
15110
|
+
]
|
15111
|
+
}
|
15112
|
+
},
|
15113
|
+
{
|
15114
|
+
"preview_path": "primer/open_project/flex_layout/row_layout",
|
15115
|
+
"name": "row_layout",
|
15116
|
+
"snapshot": "false",
|
15117
|
+
"skip_rules": {
|
15118
|
+
"wont_fix": [
|
15119
|
+
"region"
|
15120
|
+
],
|
15121
|
+
"will_fix": [
|
15122
|
+
"color-contrast"
|
15123
|
+
]
|
15124
|
+
}
|
15125
|
+
},
|
15126
|
+
{
|
15127
|
+
"preview_path": "primer/open_project/flex_layout/column_layout",
|
15128
|
+
"name": "column_layout",
|
15129
|
+
"snapshot": "false",
|
15130
|
+
"skip_rules": {
|
15131
|
+
"wont_fix": [
|
15132
|
+
"region"
|
15133
|
+
],
|
15134
|
+
"will_fix": [
|
15135
|
+
"color-contrast"
|
15136
|
+
]
|
15137
|
+
}
|
15138
|
+
},
|
15139
|
+
{
|
15140
|
+
"preview_path": "primer/open_project/flex_layout/nested_layout",
|
15141
|
+
"name": "nested_layout",
|
15142
|
+
"snapshot": "false",
|
15143
|
+
"skip_rules": {
|
15144
|
+
"wont_fix": [
|
15145
|
+
"region"
|
15146
|
+
],
|
15147
|
+
"will_fix": [
|
15148
|
+
"color-contrast"
|
15149
|
+
]
|
15150
|
+
}
|
15151
|
+
}
|
14183
15152
|
],
|
14184
15153
|
"subcomponents": [
|
14185
15154
|
|
14186
15155
|
]
|
14187
15156
|
},
|
14188
15157
|
{
|
14189
|
-
"fully_qualified_name": "Primer::
|
14190
|
-
"description": "
|
15158
|
+
"fully_qualified_name": "Primer::OpenProject::GridLayout",
|
15159
|
+
"description": "A layouting component used to arrange multiple components in a CSS Grid\nNote that this component only provides helpers (as the class names and grid-area styles).\nHowever, it does not define the actual Grid which should be done in a separate CSS-file.",
|
14191
15160
|
"accessibility_docs": null,
|
14192
15161
|
"is_form_component": false,
|
14193
15162
|
"is_published": true,
|
14194
15163
|
"requires_js": false,
|
14195
|
-
"component": "
|
14196
|
-
"status": "
|
15164
|
+
"component": "OpenProject::GridLayout",
|
15165
|
+
"status": "open_project",
|
14197
15166
|
"a11y_reviewed": false,
|
14198
|
-
"short_name": "
|
14199
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
14200
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
15167
|
+
"short_name": "OpenProjectGridLayout",
|
15168
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/grid_layout.rb",
|
15169
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/grid_layout/default/",
|
14201
15170
|
"parameters": [
|
14202
15171
|
{
|
14203
|
-
"name": "
|
14204
|
-
"type": "
|
14205
|
-
"default": "
|
14206
|
-
"description": "
|
14207
|
-
},
|
14208
|
-
{
|
14209
|
-
"name": "side",
|
14210
|
-
"type": "Symbol",
|
14211
|
-
"default": "`:right`",
|
14212
|
-
"description": "Which side to display the sidebar on. One of `:left` or `:right`."
|
14213
|
-
},
|
14214
|
-
{
|
14215
|
-
"name": "sidebar_col",
|
14216
|
-
"type": "Integer",
|
14217
|
-
"default": "`3`",
|
14218
|
-
"description": "Sidebar column width."
|
15172
|
+
"name": "css_class",
|
15173
|
+
"type": "String",
|
15174
|
+
"default": "N/A",
|
15175
|
+
"description": "The basic css class applied on the grid-container"
|
14219
15176
|
},
|
14220
15177
|
{
|
14221
15178
|
"name": "system_arguments",
|
@@ -14226,89 +15183,91 @@
|
|
14226
15183
|
],
|
14227
15184
|
"slots": [
|
14228
15185
|
{
|
14229
|
-
"name": "
|
14230
|
-
"description":
|
14231
|
-
"parameters": [
|
14232
|
-
{
|
14233
|
-
"name": "system_arguments",
|
14234
|
-
"type": "Hash",
|
14235
|
-
"default": "N/A",
|
14236
|
-
"description": "{{link_to_system_arguments_docs}}"
|
14237
|
-
}
|
14238
|
-
]
|
14239
|
-
},
|
14240
|
-
{
|
14241
|
-
"name": "sidebar",
|
14242
|
-
"description": "The sidebar content",
|
15186
|
+
"name": "areas",
|
15187
|
+
"description": null,
|
14243
15188
|
"parameters": [
|
14244
|
-
|
14245
|
-
"name": "system_arguments",
|
14246
|
-
"type": "Hash",
|
14247
|
-
"default": "N/A",
|
14248
|
-
"description": "{{link_to_system_arguments_docs}}"
|
14249
|
-
}
|
15189
|
+
|
14250
15190
|
]
|
14251
15191
|
}
|
14252
15192
|
],
|
14253
15193
|
"methods": [
|
15194
|
+
{
|
15195
|
+
"name": "css_class",
|
15196
|
+
"description": "Returns the value of attribute css_class.",
|
15197
|
+
"parameters": [
|
14254
15198
|
|
15199
|
+
]
|
15200
|
+
}
|
14255
15201
|
],
|
14256
15202
|
"previews": [
|
14257
|
-
|
15203
|
+
{
|
15204
|
+
"preview_path": "primer/open_project/grid_layout/playground",
|
15205
|
+
"name": "playground",
|
15206
|
+
"snapshot": "false",
|
15207
|
+
"skip_rules": {
|
15208
|
+
"wont_fix": [
|
15209
|
+
"region"
|
15210
|
+
],
|
15211
|
+
"will_fix": [
|
15212
|
+
"color-contrast"
|
15213
|
+
]
|
15214
|
+
}
|
15215
|
+
},
|
15216
|
+
{
|
15217
|
+
"preview_path": "primer/open_project/grid_layout/default",
|
15218
|
+
"name": "default",
|
15219
|
+
"snapshot": "false",
|
15220
|
+
"skip_rules": {
|
15221
|
+
"wont_fix": [
|
15222
|
+
"region"
|
15223
|
+
],
|
15224
|
+
"will_fix": [
|
15225
|
+
"color-contrast"
|
15226
|
+
]
|
15227
|
+
}
|
15228
|
+
}
|
14258
15229
|
],
|
14259
15230
|
"subcomponents": [
|
14260
15231
|
|
14261
15232
|
]
|
14262
15233
|
},
|
14263
15234
|
{
|
14264
|
-
"fully_qualified_name": "Primer::
|
14265
|
-
"description": "
|
15235
|
+
"fully_qualified_name": "Primer::OpenProject::GridLayout::Area",
|
15236
|
+
"description": "GridLayout::Area is an internal component that wraps the items in a div with the given new class and responding \"grid-area\"",
|
14266
15237
|
"accessibility_docs": null,
|
14267
15238
|
"is_form_component": false,
|
14268
15239
|
"is_published": true,
|
14269
15240
|
"requires_js": false,
|
14270
|
-
"component": "
|
14271
|
-
"status": "
|
15241
|
+
"component": "OpenProject::GridLayout::Area",
|
15242
|
+
"status": "open_project",
|
14272
15243
|
"a11y_reviewed": false,
|
14273
|
-
"short_name": "
|
14274
|
-
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/
|
14275
|
-
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/
|
15244
|
+
"short_name": "OpenProjectGridLayoutArea",
|
15245
|
+
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/open_project/grid_layout/area.rb",
|
15246
|
+
"lookbook": "https://primer.style/view-components/lookbook/inspect/primer/open_project/grid_layout/area/default/",
|
14276
15247
|
"parameters": [
|
14277
15248
|
{
|
14278
|
-
"name": "
|
14279
|
-
"type": "
|
14280
|
-
"default": "
|
14281
|
-
"description": "
|
14282
|
-
},
|
14283
|
-
{
|
14284
|
-
"name": "selected",
|
14285
|
-
"type": "Boolean",
|
14286
|
-
"default": "`false`",
|
14287
|
-
"description": "Whether the Tab is selected or not."
|
14288
|
-
},
|
14289
|
-
{
|
14290
|
-
"name": "with_panel",
|
14291
|
-
"type": "Boolean",
|
14292
|
-
"default": "`false`",
|
14293
|
-
"description": "Whether the Tab has an associated panel."
|
15249
|
+
"name": "css_class",
|
15250
|
+
"type": "String",
|
15251
|
+
"default": "N/A",
|
15252
|
+
"description": "The basic css class applied on the grid-container"
|
14294
15253
|
},
|
14295
15254
|
{
|
14296
|
-
"name": "
|
14297
|
-
"type": "
|
14298
|
-
"default": "
|
14299
|
-
"description": "
|
15255
|
+
"name": "area_name",
|
15256
|
+
"type": "Symbol",
|
15257
|
+
"default": "N/A",
|
15258
|
+
"description": "The specific area name, used for creating the element class and the \"grid-area\" style"
|
14300
15259
|
},
|
14301
15260
|
{
|
14302
|
-
"name": "
|
14303
|
-
"type": "
|
14304
|
-
"default": "
|
14305
|
-
"description": "
|
15261
|
+
"name": "component",
|
15262
|
+
"type": "ViewComponent::Base",
|
15263
|
+
"default": "`Primer::BaseComponent`",
|
15264
|
+
"description": "The instance of the component to be rendered."
|
14306
15265
|
},
|
14307
15266
|
{
|
14308
|
-
"name": "
|
14309
|
-
"type": "
|
14310
|
-
"default": "`
|
14311
|
-
"description": "
|
15267
|
+
"name": "tag",
|
15268
|
+
"type": "Symbol",
|
15269
|
+
"default": "`:div`",
|
15270
|
+
"description": "One of `:div` or `:span`."
|
14312
15271
|
},
|
14313
15272
|
{
|
14314
15273
|
"name": "system_arguments",
|
@@ -14318,54 +15277,7 @@
|
|
14318
15277
|
}
|
14319
15278
|
],
|
14320
15279
|
"slots": [
|
14321
|
-
|
14322
|
-
"name": "panel",
|
14323
|
-
"description": "Panel controlled by the Tab. This will not render anything in the tab itself.\nIt will provide a accessor for the Tab's parent to call and render the panel\ncontent in the appropriate place.\nRefer to `UnderlineNav` and `TabNav` implementations for examples.",
|
14324
|
-
"parameters": [
|
14325
|
-
{
|
14326
|
-
"name": "system_arguments",
|
14327
|
-
"type": "Hash",
|
14328
|
-
"default": "N/A",
|
14329
|
-
"description": "{{link_to_system_arguments_docs}}"
|
14330
|
-
}
|
14331
|
-
]
|
14332
|
-
},
|
14333
|
-
{
|
14334
|
-
"name": "icon",
|
14335
|
-
"description": "Icon to be rendered in the Tab left.",
|
14336
|
-
"parameters": [
|
14337
|
-
{
|
14338
|
-
"name": "kwargs",
|
14339
|
-
"type": "Hash",
|
14340
|
-
"default": "N/A",
|
14341
|
-
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Octicon{{/link_to_component}}."
|
14342
|
-
}
|
14343
|
-
]
|
14344
|
-
},
|
14345
|
-
{
|
14346
|
-
"name": "text",
|
14347
|
-
"description": "The Tab's text.",
|
14348
|
-
"parameters": [
|
14349
|
-
{
|
14350
|
-
"name": "kwargs",
|
14351
|
-
"type": "Hash",
|
14352
|
-
"default": "N/A",
|
14353
|
-
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Text{{/link_to_component}}."
|
14354
|
-
}
|
14355
|
-
]
|
14356
|
-
},
|
14357
|
-
{
|
14358
|
-
"name": "counter",
|
14359
|
-
"description": "Counter to be rendered in the Tab right.",
|
14360
|
-
"parameters": [
|
14361
|
-
{
|
14362
|
-
"name": "kwargs",
|
14363
|
-
"type": "Hash",
|
14364
|
-
"default": "N/A",
|
14365
|
-
"description": "The same arguments as {{#link_to_component}}Primer::Beta::Counter{{/link_to_component}}."
|
14366
|
-
}
|
14367
|
-
]
|
14368
|
-
}
|
15280
|
+
|
14369
15281
|
],
|
14370
15282
|
"methods": [
|
14371
15283
|
|