commonMain.com.lt.compose_views.image_banner.ImageBanner.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ComposeViews Show documentation
Jatpack(JetBrains) Compose views
There is a newer version: 1.6.11.4
/*
 * Copyright lt 2023
 *
 * 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.
 */

package com.lt.compose_views.image_banner

import androidx.compose.foundation.gestures.Orientation
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.runtime.Composable
import androidx.compose.runtime.remember
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import com.lt.compose_views.banner.Banner
import com.lt.compose_views.banner.BannerScope
import com.lt.compose_views.banner.BannerState
import com.lt.compose_views.banner.rememberBannerState
import com.lt.compose_views.compose_pager.NoPagerContentTransformation
import com.lt.compose_views.compose_pager.PagerContentTransformation
import com.lt.compose_views.pager_indicator.PagerIndicator
import com.lt.compose_views.pager_indicator.PagerIndicatorScope

/**
 * creator: lt  2022/6/27  [email protected]
 * effect : 展示图片的Banner
 *          [Banner] showing images
 * warning:
 * @param imageSize 图片数量
 *                  Number of images
 * @param imageContent 放置图片的content
 *                     Content of the images
 * @param indicatorItem 未被选中的指示器,如果为null则不展示指示器
 *                      The indicator, if null, do not display indicator
 * @param selectIndicatorItem 被选中的指示器,如果为null则不展示指示器
 *                            The indicator, if null, do not display indicator
 * @param modifier 修饰
 * @param bannerState Banner的状态
 *                    Banner's state
 * @param orientation 滑动的方向
 *                    Orientation of indicators
 * @param autoScroll 是否自动滚动
 *                   Whether to scroll automatically
 * @param autoScrollTime 自动滚动间隔时间
 *                       Auto scroll interval
 * @param bannerKey 使用key来提高性能,减少重组,效果等同于[LazyColumn#items#key]
 *                  Using key to improve performance, reduce recombination, and achieve the same effect as [LazyColumn#items#key]
 * @param clip 是否对内容区域进行裁剪
 *             Whether to crop the content area
 * @param contentTransformation 变换ComposePager的Content
 *                              Transform the Content of ComposePager
 */
@Composable
fun ImageBanner(
    imageSize: Int,
    imageContent: @Composable BannerScope.() -> Unit,
    indicatorItem: @Composable ((index: Int) -> Unit)?,
    selectIndicatorItem: @Composable (PagerIndicatorScope.() -> Unit)?,
    modifier: Modifier = Modifier,
    bannerState: BannerState = rememberBannerState(),
    orientation: Orientation = Orientation.Horizontal,
    autoScroll: Boolean = true,
    autoScrollTime: Long = 3000,
    bannerKey: (index: Int) -> Any = { it },
    clip: Boolean = true,
    contentTransformation: PagerContentTransformation = NoPagerContentTransformation,
) {
    Box(modifier = modifier) {
        //banner部分
        Banner(
            pageCount = imageSize,
            modifier = Modifier.fillMaxSize(),
            bannerState = bannerState,
            orientation = orientation,
            autoScroll = autoScroll,
            autoScrollTime = autoScrollTime,
            bannerKey = bannerKey,
            clip = clip,
            contentTransformation = contentTransformation,
        ) {
            imageContent()
        }
        //指示器部分
        if (indicatorItem != null && selectIndicatorItem != null) {
            PagerIndicator(
                size = imageSize,
                offsetPercentWithSelectFlow = remember(orientation) { bannerState.createChildOffsetPercentFlow() },
                selectIndexFlow = remember(orientation) { bannerState.createCurrSelectIndexFlow() },
                indicatorItem = indicatorItem,
                selectIndicatorItem = selectIndicatorItem,
                orientation = orientation,
                modifier = Modifier
                    .padding(8.dp)
                    .align(if (orientation == Orientation.Horizontal) Alignment.BottomCenter else Alignment.CenterEnd)
            )
        }
    }
}