Restored Shimmer Tokens

Author: Dhruv-Mishra

FluentUI.Demo/src/main/java/com/microsoft/fluentuidemo/demos/V2ShimmerActivity.kt

@@ -85,7 +85,17 @@ class V2ShimmerActivity : V2DemoActivity() {
     private fun CreateShimmerActivityUI() {
         var shimmerOrientation by rememberSaveable { mutableStateOf(0) }
         var isShimmering by rememberSaveable { mutableStateOf(true) }
-        val shimmerTokens = ShimmerTokens()
+        val shimmerTokens = object: ShimmerTokens(){
+            @Composable
+            override fun delay(shimmerInfo: ShimmerInfo): Int {
+                return 1000
+            }
+
+            @Composable
+            override fun orientation(shimmerInfo: ShimmerInfo): ShimmerOrientation {
+                return getShimmerOrientation(shimmerOrientation)
+            }
+        }
         Column(
             Modifier
                 .padding(all = 12.dp)

fluentui_core/src/main/java/com/microsoft/fluentui/theme/token/controlTokens/ShimmerTokens.kt

@@ -15,7 +15,8 @@ enum class ShimmerOrientation {
     LEFT_TO_RIGHT,
     RIGHT_TO_LEFT,
     TOPLEFT_TO_BOTTOMRIGHT,
-    BOTTOMRIGHT_TO_TOPLEFT
+    BOTTOMRIGHT_TO_TOPLEFT,
+    _NONE //DO NOT USE
 }
 
 @Parcelize
@@ -33,4 +34,14 @@ open class ShimmerTokens : IControlToken, Parcelable {
             themeMode = FluentTheme.themeMode
         )
     }
+
+    @Composable
+    open fun delay(shimmerInfo: ShimmerInfo): Int {
+        return -1
+    }
+
+    @Composable
+    open fun orientation(shimmerInfo: ShimmerInfo): ShimmerOrientation {
+        return ShimmerOrientation._NONE //Do not return ShimmerOrientation._NONE if you are overriding this method, it will default to ShimmerOrientation.TOPLEFT_TO_BOTTOMRIGHT in that case
+    }
 }

fluentui_progress/src/main/java/com/microsoft/fluentui/tokenized/shimmer/Shimmer.kt

@@ -101,6 +101,16 @@ internal fun InternalShimmer(
     val diagonal =
         sqrt((screenHeight * screenHeight + screenWidth * screenWidth).toDouble()).toFloat()
     val shimmerInfo = ShimmerInfo()
+    val shimmerDelayValue = if(tokens.delay(shimmerInfo) != -1){
+        tokens.delay(shimmerInfo)
+    } else {
+        shimmerDelay
+    }
+    val orientation: ShimmerOrientation = if(tokens.orientation(shimmerInfo) != ShimmerOrientation._NONE){
+        tokens.orientation(shimmerInfo)
+    } else {
+        shimmerOrientation
+    }
     val shimmerBackgroundColor = if (content != null) {
         Color.Transparent
     } else {
@@ -110,7 +120,7 @@ internal fun InternalShimmer(
     val cornerRadius =
         dpToPx(cornerRadius)
     val infiniteTransition = rememberInfiniteTransition()
-    val isLtr = if (shimmerOrientation in listOf(
+    val isLtr = if (orientation in listOf(
             ShimmerOrientation.LEFT_TO_RIGHT,
             ShimmerOrientation.TOPLEFT_TO_BOTTOMRIGHT
         )
@@ -124,7 +134,7 @@ internal fun InternalShimmer(
                 targetValue,
                 infiniteRepeatable(
                     animation = tween(
-                        durationMillis = shimmerDelay,
+                        durationMillis = shimmerDelayValue,
                         easing = LinearEasing
                     ),
                     repeatMode = RepeatMode.Restart
@@ -135,15 +145,15 @@ internal fun InternalShimmer(
         remember { mutableFloatStateOf(0f) }
     }
 
-    val startOffset: Offset = when (shimmerOrientation) {
+    val startOffset: Offset = when (orientation) {
         ShimmerOrientation.LEFT_TO_RIGHT -> Offset.Zero
         ShimmerOrientation.RIGHT_TO_LEFT -> Offset.Zero
         ShimmerOrientation.TOPLEFT_TO_BOTTOMRIGHT -> Offset.Zero
         ShimmerOrientation.BOTTOMRIGHT_TO_TOPLEFT -> Offset.Zero
         else -> Offset.Zero
     }
     val endOffset: Offset = if (isShimmering) {
-        when (shimmerOrientation) {
+        when (orientation) {
             ShimmerOrientation.LEFT_TO_RIGHT -> Offset(shimmerEffect.absoluteValue, 0F)
             ShimmerOrientation.RIGHT_TO_LEFT -> Offset(shimmerEffect.absoluteValue, 0F)
             ShimmerOrientation.TOPLEFT_TO_BOTTOMRIGHT -> Offset(shimmerEffect.absoluteValue, shimmerEffect.absoluteValue)