primer_view_components 0.0.83 → 0.0.86

data/static/arguments.yml

@@ -1,11 +1,4 @@
 ---
-- component: BorderBoxHeader
-  source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/border_box/header.rb
-  parameters:
-  - name: system_arguments
-    type: Hash
-    default: N/A
-    description: "[System arguments](/system-arguments)"
 - component: ButtonMarketing
   source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb
   parameters:
@@ -95,6 +88,100 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: TextField
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb
+  parameters:
+  - name: name
+    type: String
+    default: N/A
+    description: Value for the HTML name attribute.
+  - name: id
+    type: String
+    default: N/A
+    description: Value for the HTML id attribute.
+  - name: class
+    type: String
+    default: N/A
+    description: A list of CSS classes to add to the input. Exists for compatibility
+      with Rails form builders.
+  - name: classes
+    type: String
+    default: N/A
+    description: A list of CSS classes to add to the input. Combined with the `:class`
+      argument.
+  - name: caption
+    type: String
+    default: N/A
+    description: Caption text to render below the input.
+  - name: label
+    type: String
+    default: N/A
+    description: Label text displayed above the input.
+  - name: visually_hide_label
+    type: Boolean
+    default: N/A
+    description: Whether or not to visually hide the label. If `true` the label will
+      be hidden visually but still available to screen readers.
+  - name: size
+    type: Symbol
+    default: N/A
+    description: The size of the field. One of `:large`, `:medium`, or `:small`.
+  - name: show_clear_button
+    type: Boolean
+    default: N/A
+    description: Whether or not to include a clear button inside the input that clears
+      the input's contents when clicked.
+  - name: clear_button_id
+    type: String
+    default: N/A
+    description: The HTML id attribute of the clear button.
+  - name: full_width
+    type: Boolean
+    default: N/A
+    description: Controls whether or not the input takes the full width of its container.
+  - name: disabled
+    type: Boolean
+    default: N/A
+    description: Whether or not the input should accept keyboard and mouse input.
+  - name: invalid
+    type: Boolean
+    default: N/A
+    description: If `true`, renders the input in a visually invalid state.
+  - name: placeholder
+    type: String
+    default: N/A
+    description: Placeholder text.
+  - name: inset
+    type: Boolean
+    default: N/A
+    description: If `true`, renders the input in a visually inset state.
+  - name: monospace
+    type: Boolean
+    default: N/A
+    description: If `true`, uses a monospace font for the input field.
+  - name: leading_visual
+    type: Hash
+    default: N/A
+    description: Renders a leading visual icon before the text field's cursor. The
+      hash will be passed to Primer's [Octicon component](https://primer.style/view-components/components/octicon).
+  - name: validation_message
+    type: String
+    default: N/A
+    description: A validation message to display beneath the input. Implicitly sets
+      `invalid` to `true`.
+  - name: label_arguments
+    type: Hash
+    default: N/A
+    description: System arugments passed to the Rails builder's `#label` method. These
+      arguments will appear as HTML attributes on the `<label>` tag.
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
+  - name: block
+    type: Proc
+    default: N/A
+    description: Unused.
 - component: Tooltip
   source: https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb
   parameters:
@@ -167,25 +254,6 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
-- component: BaseButton
-  source: https://github.com/primer/view_components/tree/main/app/components/primer/base_button.rb
-  parameters:
-  - name: tag
-    type: Symbol
-    default: "`:button`"
-    description: One of `:a`, `:button`, or `:summary`.
-  - name: type
-    type: Symbol
-    default: "`:button`"
-    description: One of `:button`, `:reset`, or `:submit`.
-  - name: block
-    type: Boolean
-    default: "`false`"
-    description: 'Whether button is full-width with `display: block`.'
-  - name: system_arguments
-    type: Hash
-    default: N/A
-    description: "[System arguments](/system-arguments)"
 - component: AutoComplete
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb
   parameters:
@@ -210,28 +278,47 @@
     type: String
     default: N/A
     description: Id of the list element.
-  - name: with_icon
+  - name: visually_hide_label
     type: Boolean
     default: "`false`"
-    description: Controls if a search icon is visible, defaults to `false`.
-  - name: is_label_visible
-    type: Boolean
-    default: "`true`"
-    description: Controls if the label is visible. If `false`, screen reader only
-      text will be added.
-  - name: is_clearable
+    description: Controls if the label is visible. If `true`, screen reader only text
+      will be added.
+  - name: show_clear_button
     type: Boolean
     default: "`false`"
     description: Adds optional clear button.
-  - name: is_label_inline
-    type: Boolean
-    default: "`false`"
-    description: Controls if the label is inline. On smaller screens, label will always
-      become stacked.
   - name: system_arguments
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+  - name: size
+    type: Hash
+    default: "`:medium`"
+    description: Input size can be small, medium (default), or large
+  - name: full_width
+    type: Boolean
+    default: "`false`"
+    description: Input can be full-width or fit to content
+  - name: disabled
+    type: Boolean
+    default: "`false`"
+    description: Disabled input
+  - name: invalid
+    type: Boolean
+    default: "`false`"
+    description: Invalid input
+  - name: placeholder
+    type: String
+    default: "`nil`"
+    description: The placeholder text displayed within the input
+  - name: inset
+    type: Boolean
+    default: "`false`"
+    description: subtle input background color
+  - name: monospace
+    type: Boolean
+    default: "`false`"
+    description: monospace input font family
 - component: AutoCompleteItem
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb
   parameters:
@@ -247,6 +334,14 @@
     type: Boolean
     default: "`false`"
     description: Whether the item is disabled.
+  - name: description_variant
+    type: Hash
+    default: "`:block`"
+    description: Changes the description style. Allowed values are :inline, :block
+  - name: description
+    type: String
+    default: N/A
+    description: Display description text below label
   - name: system_arguments
     type: Hash
     default: N/A
@@ -304,6 +399,25 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: BaseButton
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb
+  parameters:
+  - name: tag
+    type: Symbol
+    default: "`:button`"
+    description: One of `:a`, `:button`, or `:summary`.
+  - name: type
+    type: Symbol
+    default: "`:button`"
+    description: One of `:button`, `:reset`, or `:submit`.
+  - name: block
+    type: Boolean
+    default: "`false`"
+    description: 'Whether button is full-width with `display: block`.'
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: Blankslate
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb
   parameters:
@@ -323,6 +437,24 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+- component: BorderBox
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb
+  parameters:
+  - name: padding
+    type: Symbol
+    default: "`:default`"
+    description: One of `:condensed`, `:default`, or `:spacious`.
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
+- component: BorderBoxHeader
+  source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb
+  parameters:
+  - name: system_arguments
+    type: Hash
+    default: N/A
+    description: "[System arguments](/system-arguments)"
 - component: Breadcrumbs
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb
   parameters:
@@ -375,17 +507,6 @@
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
-- component: BorderBox
-  source: https://github.com/primer/view_components/tree/main/app/components/primer/border_box_component.rb
-  parameters:
-  - name: padding
-    type: Symbol
-    default: "`:default`"
-    description: One of `:condensed`, `:default`, or `:spacious`.
-  - name: system_arguments
-    type: Hash
-    default: N/A
-    description: "[System arguments](/system-arguments)"
 - component: Box
   source: https://github.com/primer/view_components/tree/main/app/components/primer/box_component.rb
   parameters:
@@ -662,11 +783,26 @@
     type: Symbol
     default: N/A
     description: One of `:button`, `:reset`, or `:submit`.
+  - name: aria-label
+    type: String
+    default: N/A
+    description: String that can be read by assistive technology. A label should be
+      short and concise. See the accessibility section for more information.
+  - name: aria-description
+    type: String
+    default: N/A
+    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.
+  - name: tooltip_direction
+    type: Symbol
+    default: "`:s`"
+    description: One of `:e`, `:n`, `:ne`, `:nw`, `:s`, `:se`, `:sw`, or `:w`.
   - name: box
     type: Boolean
     default: "`false`"
-    description: Whether the button is in a [BorderBox](/components/borderbox). If
-      `true`, the button will have the `Box-btn-octicon` class.
+    description: Whether the button is in a [BorderBox](/components/beta/borderbox).
+      If `true`, the button will have the `Box-btn-octicon` class.
   - name: system_arguments
     type: Hash
     default: N/A

data/static/audited_at.json

@@ -1,21 +1,25 @@
 {
-  "Primer::Alpha::BorderBox::Header": "",
+  "Primer::Alpha::AutoComplete": "",
+  "Primer::Alpha::AutoComplete::Item": "",
   "Primer::Alpha::ButtonMarketing": "",
   "Primer::Alpha::Layout": "",
   "Primer::Alpha::Layout::Main": "",
   "Primer::Alpha::Layout::Sidebar": "",
   "Primer::Alpha::TabNav": "",
   "Primer::Alpha::TabPanels": "",
+  "Primer::Alpha::TextField": "",
   "Primer::Alpha::Tooltip": "",
   "Primer::Alpha::UnderlineNav": "",
   "Primer::Alpha::UnderlinePanels": "",
-  "Primer::BaseButton": "",
   "Primer::BaseComponent": "",
   "Primer::Beta::AutoComplete": "",
   "Primer::Beta::AutoComplete::Item": "",
   "Primer::Beta::Avatar": "",
   "Primer::Beta::AvatarStack": "",
+  "Primer::Beta::BaseButton": "",
   "Primer::Beta::Blankslate": "",
+  "Primer::Beta::BorderBox": "",
+  "Primer::Beta::BorderBox::Header": "",
   "Primer::Beta::Breadcrumbs": "",
   "Primer::Beta::Breadcrumbs::Item": "",
   "Primer::Beta::Flash": "",
@@ -29,6 +33,7 @@
   "Primer::ButtonGroup": "",
   "Primer::ClipboardCopy": "",
   "Primer::CloseButton": "",
+  "Primer::ConditionalWrapper": "",
   "Primer::Content": "",
   "Primer::CounterComponent": "",
   "Primer::DetailsComponent": "",

data/static/classes.yml

@@ -1,4 +1,8 @@
 ---
+- ".ActionList"
+- ".ActionList-content"
+- ".ActionList-item"
+- ".ActionList-item-label"
 - ".AvatarStack"
 - ".AvatarStack--right"
 - ".AvatarStack--three-plus"
@@ -19,6 +23,21 @@
 - ".Counter"
 - ".Counter--primary"
 - ".Counter--secondary"
+- ".FormControl"
+- ".FormControl--fullWidth"
+- ".FormControl-caption"
+- ".FormControl-inlineValidation"
+- ".FormControl-input"
+- ".FormControl-input-leadingVisual"
+- ".FormControl-input-leadingVisualWrap"
+- ".FormControl-input-trailingAction"
+- ".FormControl-input-wrap"
+- ".FormControl-input-wrap--leadingVisual"
+- ".FormControl-input-wrap--trailingAction"
+- ".FormControl-inset"
+- ".FormControl-label"
+- ".FormControl-medium"
+- ".FormControl-monospace"
 - ".Label"
 - ".Label--accent"
 - ".Label--attention"
@@ -45,10 +64,15 @@
 - ".Layout-main-centered-md"
 - ".Layout-main-centered-xl"
 - ".Layout-sidebar"
-- ".Link"
 - ".Link--muted"
 - ".Link--primary"
 - ".Link--secondary"
+- ".Overlay"
+- ".Overlay--height-auto"
+- ".Overlay--width-auto"
+- ".Overlay-backdrop--anchor"
+- ".Overlay-body"
+- ".Overlay-body--paddingNone"
 - ".Popover"
 - ".Popover-message"
 - ".Popover-message--large"
@@ -82,12 +106,6 @@
 - ".UnderlineNav-item"
 - ".UnderlineNav-octicon"
 - ".anim-rotate"
-- ".autocomplete-body"
-- ".autocomplete-embedded-icon-wrap"
-- ".autocomplete-item"
-- ".autocomplete-label-inline"
-- ".autocomplete-label-stacked"
-- ".autocomplete-results"
 - ".avatar"
 - ".avatar-more"
 - ".avatar-small"
@@ -167,7 +185,6 @@
 - ".flex-justify-center"
 - ".flex-shrink-0"
 - ".float-right"
-- ".form-control"
 - ".gutter-condensed"
 - ".gutter-lg"
 - ".hidden-text-expander"

data/static/constants.json

@@ -1,14 +1,8 @@
 {
-  "Primer::Alpha::BorderBox::Header": {
-    "TITLE_TAG_FALLBACK": "h2",
-    "TITLE_TAG_OPTIONS": [
-      "h1",
-      "h2",
-      "h3",
-      "h4",
-      "h5",
-      "h6"
-    ]
+  "Primer::Alpha::AutoComplete": {
+    "Item": "Primer::Alpha::AutoComplete::Item"
+  },
+  "Primer::Alpha::AutoComplete::Item": {
   },
   "Primer::Alpha::ButtonMarketing": {
     "DEFAULT_SCHEME": "default",
@@ -138,6 +132,8 @@
       "div"
     ]
   },
+  "Primer::Alpha::TextField": {
+  },
   "Primer::Alpha::Tooltip": {
     "DIRECTION_DEFAULT": "s",
     "DIRECTION_OPTIONS": [
@@ -166,20 +162,6 @@
   },
   "Primer::Alpha::UnderlinePanels": {
   },
-  "Primer::BaseButton": {
-    "DEFAULT_TAG": "button",
-    "DEFAULT_TYPE": "button",
-    "TAG_OPTIONS": [
-      "button",
-      "a",
-      "summary"
-    ],
-    "TYPE_OPTIONS": [
-      "button",
-      "reset",
-      "submit"
-    ]
-  },
   "Primer::BaseComponent": {
     "SELF_CLOSING_TAGS": [
       "area",
@@ -199,9 +181,24 @@
     ]
   },
   "Primer::Beta::AutoComplete": {
-    "Item": "Primer::Beta::AutoComplete::Item"
+    "DEFAULT_SIZE": "medium",
+    "Item": "Primer::Beta::AutoComplete::Item",
+    "SIZE_MAPPINGS": {
+      "small": "FormControl-small",
+      "medium": "FormControl-medium",
+      "large": "FormControl-large"
+    },
+    "SIZE_OPTIONS": [
+      "small",
+      "medium",
+      "large"
+    ]
   },
   "Primer::Beta::AutoComplete::Item": {
+    "ALLOWED_DESCRIPTION_VARIANTS": [
+      "inline",
+      "block"
+    ]
   },
   "Primer::Beta::Avatar": {
     "DEFAULT_SHAPE": "circle",
@@ -238,6 +235,20 @@
       "span"
     ]
   },
+  "Primer::Beta::BaseButton": {
+    "DEFAULT_TAG": "button",
+    "DEFAULT_TYPE": "button",
+    "TAG_OPTIONS": [
+      "button",
+      "a",
+      "summary"
+    ],
+    "TYPE_OPTIONS": [
+      "button",
+      "reset",
+      "submit"
+    ]
+  },
   "Primer::Beta::Blankslate": {
     "VISUAL_OPTIONS": [
       "icon",
@@ -245,6 +256,34 @@
       "image"
     ]
   },
+  "Primer::Beta::BorderBox": {
+    "DEFAULT_PADDING": "default",
+    "DEFAULT_ROW_SCHEME": "default",
+    "Header": "Primer::Beta::BorderBox::Header",
+    "PADDING_MAPPINGS": {
+      "default": "",
+      "condensed": "Box--condensed",
+      "spacious": "Box--spacious"
+    },
+    "PADDING_SUGGESTION": "Perhaps you could consider using :padding options of default, condensed, and spacious?",
+    "ROW_SCHEME_MAPPINGS": {
+      "default": "",
+      "neutral": "Box-row--gray",
+      "info": "Box-row--blue",
+      "warning": "Box-row--yellow"
+    }
+  },
+  "Primer::Beta::BorderBox::Header": {
+    "TITLE_TAG_FALLBACK": "h2",
+    "TITLE_TAG_OPTIONS": [
+      "h1",
+      "h2",
+      "h3",
+      "h4",
+      "h5",
+      "h6"
+    ]
+  },
   "Primer::Beta::Breadcrumbs": {
     "ARGS_DENYLIST": {
       "[:p, :pt, :pb, :pr, :pl, :px, :py]": "Padding system arguments are not allowed on Breadcrumbs. Consider using margins instead.",
@@ -279,20 +318,6 @@
   "Primer::BlankslateComponent": {
   },
   "Primer::BorderBoxComponent": {
-    "DEFAULT_PADDING": "default",
-    "DEFAULT_ROW_SCHEME": "default",
-    "PADDING_MAPPINGS": {
-      "default": "",
-      "condensed": "Box--condensed",
-      "spacious": "Box--spacious"
-    },
-    "PADDING_SUGGESTION": "Perhaps you could consider using :padding options of default, condensed, and spacious?",
-    "ROW_SCHEME_MAPPINGS": {
-      "default": "",
-      "neutral": "Box-row--gray",
-      "info": "Box-row--blue",
-      "warning": "Box-row--yellow"
-    }
   },
   "Primer::BoxComponent": {
   },
@@ -336,6 +361,8 @@
       "submit"
     ]
   },
+  "Primer::ConditionalWrapper": {
+  },
   "Primer::Content": {
   },
   "Primer::CounterComponent": {

data/static/statuses.json

@@ -1,21 +1,25 @@
 {
-  "Primer::Alpha::BorderBox::Header": "alpha",
+  "Primer::Alpha::AutoComplete": "deprecated",
+  "Primer::Alpha::AutoComplete::Item": "deprecated",
   "Primer::Alpha::ButtonMarketing": "alpha",
   "Primer::Alpha::Layout": "alpha",
   "Primer::Alpha::Layout::Main": "alpha",
   "Primer::Alpha::Layout::Sidebar": "alpha",
   "Primer::Alpha::TabNav": "alpha",
   "Primer::Alpha::TabPanels": "alpha",
+  "Primer::Alpha::TextField": "alpha",
   "Primer::Alpha::Tooltip": "alpha",
   "Primer::Alpha::UnderlineNav": "alpha",
   "Primer::Alpha::UnderlinePanels": "alpha",
-  "Primer::BaseButton": "beta",
   "Primer::BaseComponent": "beta",
   "Primer::Beta::AutoComplete": "beta",
   "Primer::Beta::AutoComplete::Item": "beta",
   "Primer::Beta::Avatar": "beta",
   "Primer::Beta::AvatarStack": "beta",
+  "Primer::Beta::BaseButton": "beta",
   "Primer::Beta::Blankslate": "beta",
+  "Primer::Beta::BorderBox": "beta",
+  "Primer::Beta::BorderBox::Header": "alpha",
   "Primer::Beta::Breadcrumbs": "beta",
   "Primer::Beta::Breadcrumbs::Item": "alpha",
   "Primer::Beta::Flash": "beta",
@@ -23,12 +27,13 @@
   "Primer::Beta::Truncate": "beta",
   "Primer::Beta::Truncate::TruncateText": "alpha",
   "Primer::BlankslateComponent": "deprecated",
-  "Primer::BorderBoxComponent": "beta",
+  "Primer::BorderBoxComponent": "deprecated",
   "Primer::BoxComponent": "stable",
   "Primer::ButtonComponent": "beta",
   "Primer::ButtonGroup": "beta",
   "Primer::ClipboardCopy": "beta",
   "Primer::CloseButton": "beta",
+  "Primer::ConditionalWrapper": "alpha",
   "Primer::Content": "stable",
   "Primer::CounterComponent": "beta",
   "Primer::DetailsComponent": "beta",