feat: Mark Bento as deprecated

Yelp · Jul 11, 2024 · b8bd812 · b8bd812
1 parent 02928ab
commit b8bd812
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,10 @@
-<img src="./documentation/images/bento_logo.png" width="80%"/>
+# ⛔️ DEPRECATED <Bento>
+This is no longer supported, please consider using [Jetpack Compose](https://developer.android.com/develop/ui/compose) instead.
 
-## A delicious framework for building modularized Android user interfaces, by Yelp.
+<img src="./documentation/images/bento_logo.png" width="20%"/>
 
+### A delicious framework for building modularized Android user interfaces, by Yelp.
+![No Maintenance Intended](https://unmaintained.tech/badge.svg)
 ![Maven Central](https://img.shields.io/maven-central/v/com.yelp.android/bento.svg)
 [![Build Status](https://travis-ci.org/Yelp/bento.svg?branch=master)](https://travis-ci.org/Yelp/bento)
 [![Twitter](https://img.shields.io/badge/[email protected])](https://twitter.com/YelpEngineering)
@@ -54,9 +57,9 @@ Bento can be setup with Gradle:
 ```groovy
 // Top level build.gradle
 allprojects {
-	repositories {
-		mavenCentral()
-	}
+    repositories {
+        mavenCentral()
+    }
 }
 
 // Module level build.gradle

diff --git a/bento-compose/src/main/java/com/yelp/android/bento/compose/ComposeViewHolder.kt b/bento-compose/src/main/java/com/yelp/android/bento/compose/ComposeViewHolder.kt
@@ -11,9 +11,12 @@ import androidx.compose.ui.platform.ComposeView
 import com.yelp.android.bento.core.ComponentViewHolder
 
 /**
- * ViewHolder which allows compatability with Jetpack Compose. Basically, this lets you write the
+ * ViewHolder which allows compatibility with Jetpack Compose. Basically, this lets you write the
  * view holders view code with Compose.
  */
+@Deprecated(
+    message = "Bento is deprecated! Only use ComposeViewHolder temporarily while migrating to full Jetpack Compose. Note that using Compose inside Bento may reduce performance. Please ensure a plan to migrate fully to Jetpack Compose soon.",
+)
 abstract class ComposeViewHolder<P, T> : ComponentViewHolder<P, T>() {
 
     private lateinit var composeView: ComposeView

diff --git a/bento/src/main/java/com/yelp/android/bento/core/Component.java b/bento/src/main/java/com/yelp/android/bento/core/Component.java
@@ -10,6 +10,9 @@
 import java.util.List;
 
 /**
+ * @deprecated Bento is deprecated!
+ * <p>Please consider using Jetpack Compose https://developer.android.com/jetpack/compose instead.</p>
+ * <br>
  * The building block of user interfaces in the Bento framework. Represents a self-contained
  * component to be used with a {@link ComponentController}.
  *
@@ -20,6 +23,7 @@
  * a user interface as a series of modular components instead of a complicated set of internal items
  * whose state must be managed by the component.
  */
+@Deprecated
 public abstract class Component {
 
     private final ComponentDataObservable mObservable = new ComponentDataObservable();

diff --git a/bento/src/main/java/com/yelp/android/bento/core/ComponentController.kt b/bento/src/main/java/com/yelp/android/bento/core/ComponentController.kt
@@ -8,6 +8,9 @@ import com.yelp.android.bento.utils.AccordionList.Range
  * <br></br><br></br>
  * See: [Component], [ComponentViewHolder]
  */
+@Deprecated(
+    message = "Bento is deprecated! Please consider using Jetpack Compose https://developer.android.com/jetpack/compose instead.",
+)
 interface ComponentController {
 
     /**

diff --git a/bento/src/main/java/com/yelp/android/bento/core/ComponentGroup.java b/bento/src/main/java/com/yelp/android/bento/core/ComponentGroup.java
@@ -16,10 +16,14 @@
 import java.util.Map.Entry;
 
 /**
+ * @deprecated Bento is deprecated!
+ * <p>Please consider using Jetpack Compose https://developer.android.com/jetpack/compose instead.</p>
+ * <br>
  * A {@link Component} comprising of zero or more ordered child {@link Component}s. Useful for
  * maintaining a group of related components in close proximity to each other in the {@link
  * ComponentController}.
  */
+@Deprecated
 public class ComponentGroup extends Component {
 
     /**

diff --git a/bento/src/main/java/com/yelp/android/bento/core/ComponentViewHolder.kt b/bento/src/main/java/com/yelp/android/bento/core/ComponentViewHolder.kt
@@ -15,6 +15,9 @@ import android.view.ViewGroup
  * no-arg constructor. Unfortunately, this means all subclasses must be visible from this package
  * and provide a no-arg constructor.
  */
+@Deprecated(
+    message = "Bento is deprecated! Please consider using Jetpack Compose https://developer.android.com/jetpack/compose instead.",
+)
 abstract class ComponentViewHolder<P, T> {
 
     /**