Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add snippet showing system bar protection. #464

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
/*
* Copyright 2025 The Android Open Source Project
*
* 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
*
* https://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.example.compose.snippets.layouts

import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.compose.foundation.Canvas
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.Spacer
import androidx.compose.foundation.layout.WindowInsets
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.height
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.statusBars
import androidx.compose.foundation.lazy.LazyColumn
import androidx.compose.material3.Card
import androidx.compose.material3.CardDefaults
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.ui.Modifier
import androidx.compose.ui.geometry.Size
import androidx.compose.ui.graphics.Brush
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.text.TextStyle
import androidx.compose.ui.text.font.FontWeight
import androidx.compose.ui.text.style.TextOverflow
import androidx.compose.ui.tooling.preview.Preview
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import com.example.compose.snippets.designsystems.MyTheme

// [START android_compose_system_bar_protection]
class SystemBarProtectionSnippets : ComponentActivity() {

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)

// enableEdgeToEdge sets window.isNavigationBarContrastEnforced = true
// which is used to add a translucent scrim to three-button navigation
enableEdgeToEdge()

setContent {
MyTheme {
// Main content
MyContent()

// After drawing main content, draw status bar protection
StatusBarProtection()
}
}
}
}

@Composable
private fun StatusBarProtection(
color: Color = MaterialTheme.colorScheme.surfaceContainer,
heightProvider: () -> Float = calculateGradientHeight(),
) {

Canvas(Modifier.fillMaxSize()) {
val calculatedHeight = heightProvider()
val gradient = Brush.verticalGradient(
colors = listOf(
color.copy(alpha = 1f),
color.copy(alpha = .8f),
Color.Transparent
),
startY = 0f,
endY = calculatedHeight
)
drawRect(
brush = gradient,
size = Size(size.width, calculatedHeight),
)
}
}

@Composable
fun calculateGradientHeight(): () -> Float {
val statusBars = WindowInsets.statusBars
val density = LocalDensity.current
return { statusBars.getTop(density).times(1.2f) }
}
// [END android_compose_system_bar_protection]

@Composable
fun MyContent() {
Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
val colorScheme = MaterialTheme.colorScheme
val loremIpsum = LoremIpsum()

LazyColumn(
contentPadding = innerPadding
) {
items(13) { index ->
Card(
modifier = Modifier.fillMaxWidth().padding(8.dp),
colors = CardDefaults.cardColors(
containerColor = colorScheme.surfaceVariant
)
) {
Column(modifier = Modifier.padding(8.dp)) {
Text(
text = loremIpsum.titles[index],
style = TextStyle(
fontWeight = FontWeight.Bold,
fontSize = 18.sp,
color = colorScheme.onSurfaceVariant
)
)
Spacer(modifier = Modifier.height(4.dp))
Text(
text = loremIpsum.descriptions[index],
maxLines = 1,
overflow = TextOverflow.Ellipsis,
style = TextStyle(
color = colorScheme.onSurfaceVariant
)
)
}
}
}
}
}
}

class LoremIpsum {
private val lorem = "First item of the list." +
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." +
"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat." +
"Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur." +
"Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." +
"Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo." +
"Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt." +
"Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem." +
"Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?" +
"At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga." +
"Et harum quidem rerum facilis est et expedita distinctio." +
"Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus." +
"Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae." +
"Last item of the list."
val descriptions = lorem.split(".").map { description ->
description.trim()
}
val titles = descriptions.map { sentence ->
sentence.trim().split(" ").take(2).joinToString(" ")
}
}

@Preview
@Composable
fun MyContentPreview() {
MyTheme {
MyContent()
}
}