commonMain.com.skydoves.landscapist.placeholder.shimmer.LocalShimmer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of landscapist-placeholder Show documentation

A pluggable, highly optimized Jetpack Compose image loading library that fetches and displays network images with Glide, Coil, and Fresco.

There is a newer version: 2.3.8

Show newest version

/*
 * Designed and developed by 2020-2023 skydoves (Jaewoong Eum)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
@file:Suppress("unused")

package com.skydoves.landscapist.placeholder.shimmer

import androidx.compose.runtime.ProvidableCompositionLocal
import androidx.compose.runtime.compositionLocalOf
import androidx.compose.ui.graphics.Color
import com.skydoves.landscapist.placeholder.shimmer.LocalShimmerProvider.defaultShimmerPlugin

/**
 * Local containing the preferred [ShimmerPlugin] for providing the same instance
 * in the composable hierarchy.
 */
public val LocalShimmerPlugin: ProvidableCompositionLocal =
  compositionLocalOf { defaultShimmerPlugin() }

/** A provider for taking the local instances related to the [ShimmerContainer]. */
internal object LocalShimmerProvider {

  /** Returns the current or default [ShimmerPlugin] for the `shimmerParams` parameter. */
  fun defaultShimmerPlugin(): ShimmerPlugin {
    return ShimmerPlugin(
      shimmer = Shimmer.Flash(
        baseColor = Color.DarkGray,
        highlightColor = Color.LightGray,
      ),
    )
  }
}