static/arguments.json in primer_view_components-0.0.104 vs static/arguments.json in primer_view_components-0.0.105
- old
+ new
@@ -1,9 +1,11 @@
[
{
"component": "ActionList",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/default/",
"parameters": [
{
"name": "role",
"type": "Boolean",
"default": "`:list`",
@@ -35,11 +37,13 @@
}
]
},
{
"component": "ActionList::Divider",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/",
"parameters": [
{
"name": "scheme",
"type": "Symbol",
"default": "`:subtle`",
@@ -53,11 +57,13 @@
}
]
},
{
"component": "ActionList::Heading",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/",
"parameters": [
{
"name": "list_id",
"type": "String",
"default": "N/A",
@@ -95,11 +101,13 @@
}
]
},
{
"component": "ActionList::Item",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/item.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item/default/",
"parameters": [
{
"name": "list",
"type": "Primer::Alpha::ActionList",
"default": "N/A",
@@ -197,11 +205,13 @@
}
]
},
{
"component": "ButtonMarketing",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing/default/",
"parameters": [
{
"name": "scheme",
"type": "Symbol",
"default": "`:default`",
@@ -233,11 +243,13 @@
}
]
},
{
"component": "Dialog",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/default/",
"parameters": [
{
"name": "id",
"type": "String",
"default": "`\"dialog-#{(36**3 + rand(36**4)).to_s(36)}\"`",
@@ -287,11 +299,13 @@
}
]
},
{
"component": "HiddenTextExpander",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander/default/",
"parameters": [
{
"name": "inline",
"type": "Boolean",
"default": "`false`",
@@ -310,12 +324,72 @@
"description": "[System arguments](/system-arguments)"
}
]
},
{
+ "component": "Image",
+ "status": "alpha",
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image/default/",
+ "parameters": [
+ {
+ "name": "src",
+ "type": "String",
+ "default": "N/A",
+ "description": "The source url of the image."
+ },
+ {
+ "name": "alt",
+ "type": "String",
+ "default": "N/A",
+ "description": "Specifies an alternate text for the image."
+ },
+ {
+ "name": "lazy",
+ "type": "Boolean",
+ "default": "`false`",
+ "description": "Whether or not to lazily load the image."
+ },
+ {
+ "name": "system_arguments",
+ "type": "Hash",
+ "default": "N/A",
+ "description": "[System arguments](/system-arguments)"
+ }
+ ]
+ },
+ {
+ "component": "ImageCrop",
+ "status": "alpha",
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop/default/",
+ "parameters": [
+ {
+ "name": "src",
+ "type": "String",
+ "default": "N/A",
+ "description": "The path of the image to crop."
+ },
+ {
+ "name": "rounded",
+ "type": "Boolean",
+ "default": "`true`",
+ "description": "If the crop mask should be a circle. Defaults to true."
+ },
+ {
+ "name": "system_arguments",
+ "type": "Hash",
+ "default": "N/A",
+ "description": "[System arguments](/system-arguments)"
+ }
+ ]
+ },
+ {
"component": "Layout",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/default/",
"parameters": [
{
"name": "stacking_breakpoint",
"type": "Symbol",
"default": "`:md`",
@@ -341,11 +415,13 @@
}
]
},
{
"component": "NavList",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/default/",
"parameters": [
{
"name": "selected_item_id",
"type": "Symbol",
"default": "`nil`",
@@ -359,11 +435,13 @@
}
]
},
{
"component": "NavList::Item",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/",
"parameters": [
{
"name": "selected_item_id",
"type": "Symbol",
"default": "`nil`",
@@ -395,11 +473,13 @@
}
]
},
{
"component": "NavList::Section",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/section.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/section/default/",
"parameters": [
{
"name": "selected_item_id",
"type": "Symbol",
"default": "`nil`",
@@ -412,12 +492,46 @@
"description": "[System arguments](/system-arguments)"
}
]
},
{
+ "component": "SegmentedControl",
+ "status": "alpha",
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/default/",
+ "parameters": [
+ {
+ "name": "hide_labels",
+ "type": "Boolean",
+ "default": "`false`",
+ "description": "Whether to hide the labels and only show the icons"
+ },
+ {
+ "name": "full_width",
+ "type": "Boolean",
+ "default": "`false`",
+ "description": "If the component should be full width"
+ },
+ {
+ "name": "size",
+ "type": "Symbol",
+ "default": "`:medium`",
+ "description": "One of `:large`, `:medium`, or `:small`."
+ },
+ {
+ "name": "system_arguments",
+ "type": "Hash",
+ "default": "N/A",
+ "description": "[System arguments](/system-arguments)"
+ }
+ ]
+ },
+ {
"component": "TabNav",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:nav`",
@@ -443,11 +557,13 @@
}
]
},
{
"component": "TabPanels",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_panels.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels/default/",
"parameters": [
{
"name": "label",
"type": "String",
"default": "N/A",
@@ -479,11 +595,13 @@
}
]
},
{
"component": "TextField",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field/default/",
"parameters": [
{
"name": "name",
"type": "String",
"default": "N/A",
@@ -611,11 +729,13 @@
}
]
},
{
"component": "ToggleSwitch",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/toggle_switch.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch/default/",
"parameters": [
{
"name": "src",
"type": "String",
"default": "`nil`",
@@ -659,11 +779,13 @@
}
]
},
{
"component": "Tooltip",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip/default/",
"parameters": [
{
"name": "for_id",
"type": "String",
"default": "N/A",
@@ -695,11 +817,13 @@
}
]
},
{
"component": "UnderlineNav",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:nav`",
@@ -731,11 +855,13 @@
}
]
},
{
"component": "UnderlinePanels",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels/default/",
"parameters": [
{
"name": "label",
"type": "String",
"default": "N/A",
@@ -767,11 +893,13 @@
}
]
},
{
"component": "AutoComplete",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/default/",
"parameters": [
{
"name": "label_text",
"type": "String",
"default": "N/A",
@@ -863,11 +991,13 @@
}
]
},
{
"component": "AutoComplete::Item",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item/default/",
"parameters": [
{
"name": "value",
"type": "String",
"default": "N/A",
@@ -905,11 +1035,13 @@
}
]
},
{
"component": "Avatar",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar/default/",
"parameters": [
{
"name": "src",
"type": "String",
"default": "N/A",
@@ -947,11 +1079,13 @@
}
]
},
{
"component": "AvatarStack",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar_stack.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:div`",
@@ -983,11 +1117,13 @@
}
]
},
{
"component": "BaseButton",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:button`",
@@ -1013,11 +1149,13 @@
}
]
},
{
"component": "Blankslate",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate/default/",
"parameters": [
{
"name": "narrow",
"type": "Boolean",
"default": "`false`",
@@ -1043,11 +1181,13 @@
}
]
},
{
"component": "BorderBox",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/default/",
"parameters": [
{
"name": "padding",
"type": "Symbol",
"default": "`:default`",
@@ -1061,11 +1201,13 @@
}
]
},
{
"component": "BorderBox::Header",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -1073,11 +1215,13 @@
}
]
},
{
"component": "Breadcrumbs",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -1085,11 +1229,13 @@
}
]
},
{
"component": "Button",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button/default/",
"parameters": [
{
"name": "scheme",
"type": "Symbol",
"default": "`:default`",
@@ -1133,11 +1279,13 @@
}
]
},
{
"component": "ButtonGroup",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group/default/",
"parameters": [
{
"name": "variant",
"type": "Symbol",
"default": "`nil`",
@@ -1157,11 +1305,13 @@
}
]
},
{
"component": "CloseButton",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/close_button.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button/default/",
"parameters": [
{
"name": "type",
"type": "Symbol",
"default": "`:button`",
@@ -1175,11 +1325,13 @@
}
]
},
{
"component": "Counter",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/counter.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter/default/",
"parameters": [
{
"name": "count",
"type": "Integer, Float::INFINITY, nil",
"default": "`0`",
@@ -1223,11 +1375,13 @@
}
]
},
{
"component": "Details",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/details.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details/default/",
"parameters": [
{
"name": "overlay",
"type": "Symbol",
"default": "`:none`",
@@ -1247,11 +1401,13 @@
}
]
},
{
"component": "Flash",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/flash.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash/default/",
"parameters": [
{
"name": "full",
"type": "Boolean",
"default": "`false`",
@@ -1289,11 +1445,13 @@
}
]
},
{
"component": "Heading",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/heading.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading/default/",
"parameters": [
{
"name": "tag",
"type": "String",
"default": "N/A",
@@ -1307,11 +1465,13 @@
}
]
},
{
"component": "IconButton",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/icon_button.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button/default/",
"parameters": [
{
"name": "icon",
"type": "String",
"default": "N/A",
@@ -1378,12 +1538,102 @@
"description": "[System arguments](/system-arguments)"
}
]
},
{
+ "component": "Label",
+ "status": "beta",
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/label.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label/default/",
+ "parameters": [
+ {
+ "name": "tag",
+ "type": "Symbol",
+ "default": "`:span`",
+ "description": "One of `:a`, `:div`, `:span`, or `:summary`."
+ },
+ {
+ "name": "scheme",
+ "type": "Symbol",
+ "default": "`:default`",
+ "description": "One of `:accent`, `:attention`, `:danger`, `:default`, `:done`, `:info`, `:orange`, `:primary`, `:purple`, `:secondary`, `:severe`, `:sponsors`, `:success`, or `:warning`."
+ },
+ {
+ "name": "size",
+ "type": "Symbol",
+ "default": "`:medium`",
+ "description": "One of `:large` or `:medium`."
+ },
+ {
+ "name": "inline",
+ "type": "Boolean",
+ "default": "`false`",
+ "description": "Whether or not to render this label inline."
+ },
+ {
+ "name": "variant",
+ "type": "Symbol",
+ "default": "`:none`",
+ "description": "One of `:inline`, `:large`, or `:none`."
+ },
+ {
+ "name": "system_arguments",
+ "type": "Hash",
+ "default": "N/A",
+ "description": "[System arguments](/system-arguments)"
+ }
+ ]
+ },
+ {
+ "component": "Link",
+ "status": "beta",
+ "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/",
+ "parameters": [
+ {
+ "name": "tag",
+ "type": "String",
+ "default": "`:a`",
+ "description": "One of `:a` or `:span`."
+ },
+ {
+ "name": "href",
+ "type": "String",
+ "default": "`nil`",
+ "description": "URL to be used for the Link. Required if tag is `:a`. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
+ },
+ {
+ "name": "scheme",
+ "type": "Symbol",
+ "default": "`:default`",
+ "description": "One of `:default`, `:primary`, or `:secondary`."
+ },
+ {
+ "name": "muted",
+ "type": "Boolean",
+ "default": "`false`",
+ "description": "Uses light gray for Link color, and blue on hover."
+ },
+ {
+ "name": "underline",
+ "type": "Boolean",
+ "default": "`true`",
+ "description": "Whether or not to underline the link."
+ },
+ {
+ "name": "system_arguments",
+ "type": "Hash",
+ "default": "N/A",
+ "description": "[System arguments](/system-arguments)"
+ }
+ ]
+ },
+ {
"component": "Text",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:span`",
@@ -1397,11 +1647,13 @@
}
]
},
{
"component": "Truncate",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -1409,11 +1661,13 @@
}
]
},
{
"component": "Box",
+ "status": "stable",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -1421,11 +1675,13 @@
}
]
},
{
"component": "Button",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button/default/",
"parameters": [
{
"name": "scheme",
"type": "Symbol",
"default": "`:default`",
@@ -1481,11 +1737,13 @@
}
]
},
{
"component": "ClipboardCopy",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/clipboard_copy.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/clipboard_copy/default/",
"parameters": [
{
"name": "aria-label",
"type": "String",
"default": "N/A",
@@ -1511,11 +1769,13 @@
}
]
},
{
"component": "Dropdown",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/dropdown.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown/default/",
"parameters": [
{
"name": "overlay",
"type": "Symbol",
"default": "`:default`",
@@ -1535,11 +1795,13 @@
}
]
},
{
"component": "DropdownMenu",
+ "status": "deprecated",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/dropdown_menu_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown_menu/default/",
"parameters": [
{
"name": "direction",
"type": "Symbol",
"default": "`:se`",
@@ -1565,11 +1827,13 @@
}
]
},
{
"component": "HellipButton",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/hellip_button.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/hellip_button/default/",
"parameters": [
{
"name": "inline",
"type": "Boolean",
"default": "`false`",
@@ -1583,11 +1847,13 @@
}
]
},
{
"component": "IconButton",
+ "status": "deprecated",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button/default/",
"parameters": [
{
"name": "scheme",
"type": "Symbol",
"default": "`:default`",
@@ -1642,108 +1908,14 @@
"description": "[System arguments](/system-arguments)"
}
]
},
{
- "component": "Image",
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/image.rb",
- "parameters": [
- {
- "name": "src",
- "type": "String",
- "default": "N/A",
- "description": "The source url of the image."
- },
- {
- "name": "alt",
- "type": "String",
- "default": "N/A",
- "description": "Specifies an alternate text for the image."
- },
- {
- "name": "lazy",
- "type": "Boolean",
- "default": "`false`",
- "description": "Whether or not to lazily load the image."
- },
- {
- "name": "system_arguments",
- "type": "Hash",
- "default": "N/A",
- "description": "[System arguments](/system-arguments)"
- }
- ]
- },
- {
- "component": "ImageCrop",
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/image_crop.rb",
- "parameters": [
- {
- "name": "src",
- "type": "String",
- "default": "N/A",
- "description": "The path of the image to crop."
- },
- {
- "name": "rounded",
- "type": "Boolean",
- "default": "`true`",
- "description": "If the crop mask should be a circle. Defaults to true."
- },
- {
- "name": "system_arguments",
- "type": "Hash",
- "default": "N/A",
- "description": "[System arguments](/system-arguments)"
- }
- ]
- },
- {
- "component": "Label",
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/label_component.rb",
- "parameters": [
- {
- "name": "tag",
- "type": "Symbol",
- "default": "`:span`",
- "description": "One of `:a`, `:div`, `:span`, or `:summary`."
- },
- {
- "name": "scheme",
- "type": "Symbol",
- "default": "`:default`",
- "description": "One of `:accent`, `:attention`, `:danger`, `:default`, `:done`, `:info`, `:orange`, `:primary`, `:purple`, `:secondary`, `:severe`, `:sponsors`, `:success`, or `:warning`."
- },
- {
- "name": "size",
- "type": "Symbol",
- "default": "`:medium`",
- "description": "One of `:large` or `:medium`."
- },
- {
- "name": "inline",
- "type": "Boolean",
- "default": "`false`",
- "description": "Whether or not to render this label inline."
- },
- {
- "name": "variant",
- "type": "Symbol",
- "default": "`:none`",
- "description": "One of `:inline`, `:large`, or `:none`."
- },
- {
- "name": "system_arguments",
- "type": "Hash",
- "default": "N/A",
- "description": "[System arguments](/system-arguments)"
- }
- ]
- },
- {
"component": "Layout",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout/default/",
"parameters": [
{
"name": "responsive",
"type": "Boolean",
"default": "`false`",
@@ -1768,54 +1940,14 @@
"description": "[System arguments](/system-arguments)"
}
]
},
{
- "component": "Link",
- "source": "https://github.com/primer/view_components/tree/main/app/components/primer/link_component.rb",
- "parameters": [
- {
- "name": "tag",
- "type": "String",
- "default": "`:a`",
- "description": "One of `:a` or `:span`."
- },
- {
- "name": "href",
- "type": "String",
- "default": "`nil`",
- "description": "URL to be used for the Link. Required if tag is `:a`. If the requirements are not met an error will be raised in non production environments. In production, an empty link element will be rendered."
- },
- {
- "name": "scheme",
- "type": "Symbol",
- "default": "`:default`",
- "description": "One of `:default`, `:primary`, or `:secondary`."
- },
- {
- "name": "muted",
- "type": "Boolean",
- "default": "`false`",
- "description": "Uses light gray for Link color, and blue on hover."
- },
- {
- "name": "underline",
- "type": "Boolean",
- "default": "`true`",
- "description": "Whether or not to underline the link."
- },
- {
- "name": "system_arguments",
- "type": "Hash",
- "default": "N/A",
- "description": "[System arguments](/system-arguments)"
- }
- ]
- },
- {
"component": "LocalTime",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/local_time.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/local_time/default/",
"parameters": [
{
"name": "datetime",
"type": "DateTime",
"default": "N/A",
@@ -1883,11 +2015,13 @@
}
]
},
{
"component": "Markdown",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/markdown.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/markdown/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:div`",
@@ -1901,11 +2035,13 @@
}
]
},
{
"component": "Menu",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/menu_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/menu/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -1913,11 +2049,13 @@
}
]
},
{
"component": "Navigation::Tab",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab/default/",
"parameters": [
{
"name": "list",
"type": "Boolean",
"default": "`false`",
@@ -1961,11 +2099,13 @@
}
]
},
{
"component": "Octicon",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/octicon_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/octicon/default/",
"parameters": [
{
"name": "icon_name",
"type": "Symbol, String",
"default": "`nil`",
@@ -1997,11 +2137,13 @@
}
]
},
{
"component": "OcticonSymbols",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/octicon_symbols_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/octicon_symbols/default/",
"parameters": [
{
"name": "icons",
"type": "Array<Hash>",
"default": "`[]`",
@@ -2009,11 +2151,13 @@
}
]
},
{
"component": "Popover",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/popover_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/popover/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -2021,11 +2165,13 @@
}
]
},
{
"component": "ProgressBar",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/progress_bar_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/progress_bar/default/",
"parameters": [
{
"name": "size",
"type": "Symbol",
"default": "`:default`",
@@ -2039,11 +2185,13 @@
}
]
},
{
"component": "Spinner",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/spinner_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/spinner/default/",
"parameters": [
{
"name": "size",
"type": "Symbol",
"default": "`:medium`",
@@ -2063,11 +2211,13 @@
}
]
},
{
"component": "State",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/state_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/state/default/",
"parameters": [
{
"name": "title",
"type": "String",
"default": "N/A",
@@ -2099,11 +2249,13 @@
}
]
},
{
"component": "Subhead",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/subhead_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/subhead/default/",
"parameters": [
{
"name": "spacious",
"type": "Boolean",
"default": "`false`",
@@ -2123,11 +2275,13 @@
}
]
},
{
"component": "TabContainer",
+ "status": "alpha",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/tab_container_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tab_container/default/",
"parameters": [
{
"name": "system_arguments",
"type": "Hash",
"default": "N/A",
@@ -2135,11 +2289,13 @@
}
]
},
{
"component": "TimeAgo",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/time_ago_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago/default/",
"parameters": [
{
"name": "time",
"type": "Time",
"default": "N/A",
@@ -2159,11 +2315,13 @@
}
]
},
{
"component": "TimelineItem",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/timeline_item_component.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/timeline_item/default/",
"parameters": [
{
"name": "condensed",
"type": "Boolean",
"default": "`false`",
@@ -2177,11 +2335,13 @@
}
]
},
{
"component": "Tooltip",
+ "status": "deprecated",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/tooltip.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip/default/",
"parameters": [
{
"name": "label",
"type": "String",
"default": "N/A",
@@ -2219,10 +2379,12 @@
}
]
},
{
"component": "Truncate",
+ "status": "beta",
"source": "https://github.com/primer/view_components/tree/main/app/components/primer/truncate.rb",
+ "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate/default/",
"parameters": [
{
"name": "tag",
"type": "Symbol",
"default": "`:div`",