primer_view_components 0.5.0 → 0.6.0

data/previews/primer/alpha/banner_preview.rb

@@ -8,15 +8,14 @@ module Primer
       #
       # @param full toggle
       # @param full_when_narrow toggle
-      # @param dismissible toggle
+      # @param dismiss_scheme [Symbol] select [none, remove, hide]
       # @param icon [Symbol] octicon
       # @param scheme [Symbol] select [default, warning, danger, success]
       # @param content text
       # @param description text
-      # @param reappear [Boolean]
-      def playground(full: false, full_when_narrow: false, dismissible: false, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, reappear: true, content: "This is a banner!", description: nil)
+      def playground(full: false, full_when_narrow: false, dismiss_scheme: Primer::Alpha::Banner::DEFAULT_DISMISS_SCHEME, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, content: "This is a banner!", description: nil)
         icon = nil if icon == :none
-        render(Primer::Alpha::Banner.new(full: full, full_when_narrow: full_when_narrow, dismissible: dismissible, icon: icon == :none ? nil : icon, scheme: scheme, description: description, reappear: reappear)) { content }
+        render(Primer::Alpha::Banner.new(full: full, full_when_narrow: full_when_narrow, dismiss_scheme: dismiss_scheme, icon: icon == :none ? nil : icon, scheme: scheme, description: description)) { content }
       end
 
       # @label Default
@@ -54,8 +53,8 @@ module Primer
 
       # @label Dismissable
       # @snapshot
-      def dismissable
-        render(Primer::Alpha::Banner.new(dismissible: true, reappear: true)) { "This is a dismissable banner." }
+      def dismissible
+        render(Primer::Alpha::Banner.new(dismiss_scheme: :hide, reappear: true)) { "This is a dismissable banner." }
       end
 
       # @!group Full Width
@@ -76,29 +75,27 @@ module Primer
       # @label With action button
       #
       # @param full toggle
-      # @param dismissible toggle
+      # @param dismiss_scheme [Symbol] select [none, remove, hide]
       # @param icon [Symbol] octicon
       # @param scheme [Symbol] select [default, warning, danger, success]
       # @param content text
-      # @param reappear [Boolean]
       # @snapshot
-      def with_action_button(full: false, dismissible: false, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, reappear: true, content: "This is a banner with an action!")
+      def with_action_button(full: false, dismiss_scheme: Primer::Alpha::Banner::DEFAULT_DISMISS_SCHEME, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, content: "This is a banner with an action!")
         icon = nil if icon == :none
-        render_with_template(locals: { full: full, dismissible: dismissible, icon: icon == :none ? nil : icon, scheme: scheme, content: content, reappear: reappear })
+        render_with_template(locals: { full: full, dismiss_scheme: dismiss_scheme, icon: icon == :none ? nil : icon, scheme: scheme, content: content })
       end
 
       # @label With action content
       #
       # @param full toggle
-      # @param dismissible toggle
+      # @param dismiss_scheme [Symbol] select [none, remove, hide]
       # @param icon [Symbol] octicon
       # @param scheme [Symbol] select [default, warning, danger, success]
       # @param content text
-      # @param reappear [Boolean]
       # @snapshot
-      def with_action_content(full: false, dismissible: false, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, reappear: true, content: "Did you know? Comments can be edited.")
+      def with_action_content(full: false, dismiss_scheme: Primer::Alpha::Banner::DEFAULT_DISMISS_SCHEME, icon: :people, scheme: Primer::Alpha::Banner::DEFAULT_SCHEME, content: "Did you know? Comments can be edited.")
         icon = nil if icon == :none
-        render_with_template(locals: { full: full, dismissible: dismissible, icon: icon == :none ? nil : icon, scheme: scheme, content: content, reappear: reappear })
+        render_with_template(locals: { full: full, dismiss_scheme: dismiss_scheme, icon: icon == :none ? nil : icon, scheme: scheme, content: content })
       end
     end
   end

data/previews/primer/alpha/nav_list_preview.rb

@@ -50,6 +50,15 @@ module Primer
           list.with_group do |group|
             group.with_heading(title: "Access")
 
+            group.with_avatar_item(
+              src: "https://avatars.githubusercontent.com/u/103004183?v=4",
+              username: "hulk_smash",
+              full_name: "Bruce Banner",
+              full_name_scheme: :inline,
+              href: "/profile",
+              avatar_arguments: { shape: :square }
+            )
+
             group.with_item(label: "Collaborators and teams", href: "/collaborators", selected_by_ids: :collaborators) do |item|
               item.with_leading_visual_icon(icon: :people)
             end
@@ -82,6 +91,14 @@ module Primer
           list.with_item(label: "Change password", href: "/change_password") do |item|
             item.with_leading_visual_icon(icon: :key)
           end
+
+          list.with_avatar_item(
+            src: "https://avatars.githubusercontent.com/u/103004183?v=4",
+            username: "hulk_smash",
+            full_name: "Bruce Banner",
+            full_name_scheme: :inline,
+            href: "/profile"
+          )
         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."
       },
       {

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",