-
Notifications
You must be signed in to change notification settings - Fork 19
Implement multi-form-factor presentation separation & compile-time layout contracts #32
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
Open
pflammertsma
wants to merge
1
commit into
android:main
Choose a base branch
from
pflammertsma:feature/layout-contracts
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
220 changes: 220 additions & 0 deletions
220
agent/app/src/main/java/com/example/appfunctions/agent/ui/components/TvSurfaceTextField.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| /* | ||
| * Copyright 2026 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.appfunctions.agent.ui.components | ||
|
|
||
| import kotlin.OptIn | ||
| import androidx.activity.compose.BackHandler | ||
| import androidx.compose.animation.core.animateFloatAsState | ||
| import androidx.compose.foundation.BorderStroke | ||
| import androidx.compose.foundation.layout.Column | ||
| import androidx.compose.foundation.layout.Row | ||
| import androidx.compose.foundation.layout.defaultMinSize | ||
| import androidx.compose.foundation.layout.fillMaxWidth | ||
| import androidx.compose.foundation.layout.padding | ||
| import androidx.compose.foundation.layout.WindowInsets | ||
| import androidx.compose.foundation.layout.isImeVisible | ||
| import androidx.compose.foundation.layout.ExperimentalLayoutApi | ||
| import androidx.compose.foundation.shape.CircleShape | ||
| import androidx.compose.foundation.text.KeyboardActions | ||
| import androidx.compose.foundation.text.KeyboardOptions | ||
| import androidx.compose.material3.MaterialTheme | ||
| import androidx.compose.ui.text.TextRange | ||
| import androidx.compose.material3.OutlinedTextField | ||
| import androidx.compose.material3.OutlinedTextFieldDefaults | ||
| import androidx.compose.material3.Surface | ||
| import androidx.compose.material3.Text | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.LaunchedEffect | ||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.runtime.mutableStateOf | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.runtime.setValue | ||
| import androidx.compose.ui.Alignment | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.draw.scale | ||
| import androidx.compose.ui.focus.FocusRequester | ||
| import androidx.compose.ui.focus.focusRequester | ||
| import androidx.compose.ui.focus.onFocusChanged | ||
| import androidx.compose.ui.graphics.Shape | ||
| import androidx.compose.ui.input.key.Key | ||
| import androidx.compose.ui.input.key.KeyEventType | ||
| import androidx.compose.ui.input.key.key | ||
| import androidx.compose.ui.input.key.onPreviewKeyEvent | ||
| import androidx.compose.ui.input.key.type | ||
| import androidx.compose.ui.platform.LocalFocusManager | ||
| import androidx.compose.ui.platform.LocalSoftwareKeyboardController | ||
| import androidx.compose.ui.unit.dp | ||
| import com.example.appfunctions.agent.R | ||
|
|
||
| /** | ||
| * Android TV Surface Paradigm Text Field. | ||
| * | ||
| * Unfocused / Idle state: Renders a focusable Surface container that responds to D-Pad navigation. | ||
| * High contrast focus stroke border and scale boost when focused. | ||
| * Pressing D-Pad Center (or click) enters editing mode and focuses the underlying OutlinedTextField. | ||
| * Pressing Back or Enter/Done exits editing mode, hides the keyboard, and restores D-Pad navigation. | ||
| */ | ||
| @OptIn(ExperimentalLayoutApi::class) | ||
| @Composable | ||
| fun TvSurfaceTextField( | ||
| value: String, | ||
| onValueChange: (String) -> Unit, | ||
| placeholder: String, | ||
| modifier: Modifier = Modifier, | ||
| label: String? = null, | ||
| singleLine: Boolean = true, | ||
| trailingIcon: @Composable (() -> Unit)? = null, | ||
| keyboardOptions: KeyboardOptions = KeyboardOptions.Default, | ||
| shape: Shape = CircleShape, | ||
| ) { | ||
| var isEditing by remember { mutableStateOf(false) } | ||
| var wasEditing by remember { mutableStateOf(false) } | ||
| val keyboardController = LocalSoftwareKeyboardController.current | ||
| val textFieldFocusRequester = remember { FocusRequester() } | ||
| val surfaceFocusRequester = remember { FocusRequester() } | ||
|
|
||
| val isImeVisible = WindowInsets.isImeVisible | ||
| var keyboardHasShown by remember(isEditing) { mutableStateOf(false) } | ||
|
|
||
| fun stopEditing() { | ||
| isEditing = false | ||
| keyboardController?.hide() | ||
| } | ||
|
|
||
| BackHandler(enabled = isEditing) { | ||
| stopEditing() | ||
| } | ||
|
|
||
| LaunchedEffect(isEditing) { | ||
| if (isEditing) { | ||
| wasEditing = true | ||
| textFieldFocusRequester.requestFocus() | ||
| } else if (wasEditing) { | ||
| surfaceFocusRequester.requestFocus() | ||
| } | ||
| } | ||
|
|
||
| LaunchedEffect(isImeVisible) { | ||
| if (isImeVisible) { | ||
| keyboardHasShown = true | ||
| } else if (keyboardHasShown && isEditing) { | ||
| stopEditing() | ||
| } | ||
| } | ||
|
|
||
| if (isEditing) { | ||
| var tfValue by remember { | ||
| mutableStateOf( | ||
| androidx.compose.ui.text.input.TextFieldValue( | ||
| text = value, | ||
| selection = androidx.compose.ui.text.TextRange(0, value.length), | ||
| ) | ||
| ) | ||
| } | ||
| LaunchedEffect(value) { | ||
| if (tfValue.text != value) { | ||
| tfValue = tfValue.copy(text = value, selection = TextRange(value.length)) | ||
| } | ||
| } | ||
| var tfFocused by remember { mutableStateOf(false) } | ||
| OutlinedTextField( | ||
| value = tfValue, | ||
| onValueChange = { newTfValue -> | ||
| tfValue = newTfValue | ||
| onValueChange(newTfValue.text) | ||
| }, | ||
| singleLine = singleLine, | ||
| label = label?.let { { Text(it) } }, | ||
| placeholder = { Text(placeholder) }, | ||
| trailingIcon = trailingIcon, | ||
| keyboardOptions = keyboardOptions, | ||
| keyboardActions = KeyboardActions( | ||
| onDone = { stopEditing() }, | ||
| onSearch = { stopEditing() }, | ||
| ), | ||
| shape = shape, | ||
| colors = OutlinedTextFieldDefaults.colors( | ||
| focusedContainerColor = MaterialTheme.colorScheme.surfaceBright, | ||
| unfocusedContainerColor = MaterialTheme.colorScheme.surfaceBright, | ||
| focusedBorderColor = MaterialTheme.colorScheme.primary, | ||
| unfocusedBorderColor = MaterialTheme.colorScheme.outlineVariant, | ||
| ), | ||
| modifier = modifier | ||
| .defaultMinSize(minHeight = 52.dp) | ||
| .focusRequester(textFieldFocusRequester) | ||
| .onFocusChanged { focusState -> | ||
| if (tfFocused && !focusState.isFocused) { | ||
| stopEditing() | ||
| } | ||
| tfFocused = focusState.isFocused | ||
| } | ||
| .onPreviewKeyEvent { keyEvent -> | ||
| if (keyEvent.key == Key.Back) { | ||
| if (keyEvent.type == KeyEventType.KeyDown || keyEvent.type == KeyEventType.KeyUp) { | ||
| stopEditing() | ||
| } | ||
| true | ||
| } else false | ||
| } | ||
| ) | ||
| } else { | ||
| var isFocused by remember { mutableStateOf(false) } | ||
| val scale by animateFloatAsState(if (isFocused) 1.02f else 1.0f, label = "textFieldScale") | ||
|
|
||
| Surface( | ||
| onClick = { isEditing = true }, | ||
| modifier = modifier | ||
| .defaultMinSize(minHeight = 52.dp) | ||
| .scale(scale) | ||
| .focusRequester(surfaceFocusRequester) | ||
| .onFocusChanged { isFocused = it.isFocused }, | ||
| shape = shape, | ||
| color = if (isFocused) MaterialTheme.colorScheme.primaryContainer else MaterialTheme.colorScheme.surfaceBright, | ||
| border = if (isFocused) { | ||
| BorderStroke(2.5.dp, MaterialTheme.colorScheme.primary) | ||
| } else { | ||
| BorderStroke(1.dp, MaterialTheme.colorScheme.outlineVariant) | ||
| }, | ||
| ) { | ||
| Row( | ||
| modifier = Modifier | ||
| .fillMaxWidth() | ||
| .padding(horizontal = 16.dp, vertical = 10.dp), | ||
| verticalAlignment = Alignment.CenterVertically | ||
| ) { | ||
| Column(modifier = Modifier.weight(1f)) { | ||
| if (label != null) { | ||
| Text( | ||
| text = label, | ||
| style = MaterialTheme.typography.labelSmall, | ||
| color = if (isFocused) MaterialTheme.colorScheme.onPrimaryContainer else MaterialTheme.colorScheme.primary, | ||
| ) | ||
| } | ||
| Text( | ||
| text = value.ifEmpty { placeholder }, | ||
| color = when { | ||
| isFocused -> MaterialTheme.colorScheme.onPrimaryContainer | ||
| value.isNotEmpty() -> MaterialTheme.colorScheme.onSurface | ||
| else -> MaterialTheme.colorScheme.onSurfaceVariant | ||
| }, | ||
| style = MaterialTheme.typography.bodyLarge, | ||
| ) | ||
| } | ||
| trailingIcon?.invoke() | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.