primer_view_components 0.5.1 → 0.7.0

data/previews/primer/alpha/tooltip_preview.rb

@@ -4,40 +4,29 @@ module Primer
   module Alpha
     # @label Tooltip
     class TooltipPreview < ViewComponent::Preview
-      # @param type [Symbol] select [["Description", description], ["Label", label]]
       # @param direction select [s, n, e, w, ne, nw, se, sw]
       # @param tooltip_text text
-      def playground(type: :description, direction: :s, tooltip_text: "You can press a button")
+      def playground(direction: :s, tooltip_text: "You can press a button")
         render(Primer::Beta::Button.new(id: "button-with-tooltip")) do |component|
-          component.with_tooltip(text: tooltip_text, type: type, direction: direction)
+          component.with_tooltip(text: tooltip_text, direction: direction)
           "Button"
         end
       end
 
-      # @param type [Symbol] select [["Description", description], ["Label", label]]
       # @param direction select [s, n, e, w, ne, nw, se, sw]
       # @param tooltip_text text
-      def default(type: :description, direction: :s, tooltip_text: "You can press a button")
+      def default(direction: :s, tooltip_text: "You can press a button")
         render(Primer::Beta::Button.new(id: "button-with-tooltip")) do |component|
-          component.with_tooltip(text: tooltip_text, type: type, direction: direction)
+          component.with_tooltip(text: tooltip_text, direction: direction)
           "Button"
         end
       end
 
       # @param direction select [s, n, e, w, ne, nw, se, sw]
       # @param tooltip_text text
-      def label_tooltip_on_button_with_existing_labelledby(type: :label, direction: :s, tooltip_text: "You can press a button")
-        render(Primer::Beta::Button.new(id: "button-with-existing-label", "aria-labelledby": "existing-label-id")) do |component|
-          component.with_tooltip(text: tooltip_text, type: type, direction: direction)
-          "Button"
-        end
-      end
-
-      # @param direction select [s, n, e, w, ne, nw, se, sw]
-      # @param tooltip_text text
-      def description_tooltip_on_button_with_existing_describedby(type: :description, direction: :s, tooltip_text: "You can press a button")
+      def description_tooltip_on_button_with_existing_describedby(direction: :s, tooltip_text: "You can press a button")
         render(Primer::Beta::Button.new(id: "button-with-existing-description", "aria-describedby": "existing-description-id")) do |component|
-          component.with_tooltip(text: tooltip_text, type: type, direction: direction)
+          component.with_tooltip(text: tooltip_text, direction: direction)
           "Button"
         end
       end
@@ -56,10 +45,9 @@ module Primer
 
       # @param direction select [s, n, e, w, ne, nw, se, sw]
       # @param tooltip_text text
-      def with_multiple_on_a_page(type: :description, direction: :s, tooltip_text: "You can press a button")
+      def with_multiple_on_a_page(direction: :s, tooltip_text: "You can press a button")
         render_with_template(
           locals: {
-            type: type,
             direction: direction,
             tooltip_text: tooltip_text
           }
@@ -68,17 +56,17 @@ module Primer
 
       # @!group Tooltip enabled elements
       # @label Tooltip with Primer::Beta::Button
-      def tooltip_with_button(type: :description, direction: :s, tooltip_text: "You can press a button")
+      def tooltip_with_button(direction: :s, tooltip_text: "You can press a button")
         render(Primer::Beta::Button.new(id: "button-with-tooltip")) do |component|
-          component.with_tooltip(text: tooltip_text, type: type, direction: direction)
+          component.with_tooltip(text: tooltip_text, direction: direction)
           "Button"
         end
       end
 
       # @label Tooltip with Primer::Beta::Link
-      def tooltip_with_link(type: :description, direction: :s, tooltip_text: "You can press a button")
+      def tooltip_with_link(direction: :s, tooltip_text: "You can press a button")
         render(Primer::Beta::Link.new(href: "#link-with-tooltip", id: "link-with-tooltip")) do |component|
-          component.with_tooltip(text: tooltip_text, type: type, direction: direction)
+          component.with_tooltip(text: tooltip_text, direction: direction)
           "Button"
         end
       end

data/static/arguments.json

@@ -270,7 +270,7 @@
         "name": "description_scheme",
         "type": "Symbol",
         "default": "`:block`",
-        "description": "Display description inline with label, or block on the next line."
+        "description": "Display description inline with label, or block on the next line. One of `:block` or `:inline`."
       },
       {
         "name": "active",
@@ -521,10 +521,10 @@
         "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
       },
       {
-        "name": "dismissible",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether the component can be dismissed with an \"x\" button."
+        "name": "dismiss_scheme",
+        "type": "Symbol",
+        "default": "`:none`",
+        "description": "Whether the component can be dismissed with an \"x\" button. One of `:hide`, `:none`, or `:remove`."
       },
       {
         "name": "description",
@@ -544,12 +544,6 @@
         "default": "`:default`",
         "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
       },
-      {
-        "name": "reappear",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
-      },
       {
         "name": "system_arguments",
         "type": "Hash",
@@ -2986,7 +2980,7 @@
       {
         "name": "alt",
         "type": "String",
-        "default": "N/A",
+        "default": "`nil`",
         "description": "Passed through to alt on img tag."
       },
       {
@@ -4254,7 +4248,18 @@
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/conditional_wrapper.rb",
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/conditional_wrapper/default/",
     "parameters": [
-
+      {
+        "name": "condition",
+        "type": "Boolean",
+        "default": "N/A",
+        "description": "Whether or not to wrap the content in a `Primer::BaseComponent`."
+      },
+      {
+        "name": "base_component_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "The arguments to pass to `Primer::BaseComponent`."
+      }
     ]
   },
   {

data/static/constants.json

@@ -146,6 +146,7 @@
   "Primer::Alpha::AutoComplete::Item": {
   },
   "Primer::Alpha::Banner": {
+    "DEFAULT_DISMISS_SCHEME": "none",
     "DEFAULT_ICONS": {
       "default": "bell",
       "warning": "alert",
@@ -153,6 +154,11 @@
       "success": "check-circle"
     },
     "DEFAULT_SCHEME": "default",
+    "DISMISS_SCHEMES": [
+      "none",
+      "remove",
+      "hide"
+    ],
     "LEGACY_SCHEME_MAPPINGS": {
       "default": "",
       "warning": "flash-warn",