Mark Flash as deprecated (#2640)

primer · Feb 26, 2024 · 56b2413 · 56b2413
1 parent 5619810
commit 56b2413
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git a/.changeset/mighty-poems-know.md b/.changeset/mighty-poems-know.md
@@ -0,0 +1,5 @@
+---
+"@primer/view-components": minor
+---
+
+Mark `Flash` as deprecated
diff --git a/app/components/primer/beta/flash.rb b/app/components/primer/beta/flash.rb
@@ -2,9 +2,11 @@
 
 module Primer
   module Beta
+    # This component has been deprecated. Use [Banner](<%= link_to_component(Primer::Alpha::Banner) %>) instead.
+    #
     # Use `Flash` to inform users of successful or pending actions.
     class Flash < Primer::Component
-      status :beta
+      status :deprecated
 
       # Optional action content showed on the right side of the component.
       #

diff --git a/lib/primer/deprecations.yml b/lib/primer/deprecations.yml
@@ -33,6 +33,11 @@ deprecations:
     autocorrect: true
     replacement: "Primer::Beta::AutoComplete::Item"
 
+  - component: "Primer::Beta::Flash"
+    autocorrect: false
+    replacement: "Primer::Alpha::Banner"
+    guide: "https://primer.style/components/banner/rails/alpha"
+
   - component: "Primer::BlankslateComponent"
     autocorrect: true
     replacement: "Primer::Beta::Blankslate"

diff --git a/test/components/beta/flash_test.rb b/test/components/beta/flash_test.rb
@@ -69,6 +69,6 @@ def test_bottom_margin_can_be_overridden
   end
 
   def test_status
-    assert_component_state(Primer::Beta::Flash, :beta)
+    assert_component_state(Primer::Beta::Flash, :deprecated)
   end
 end