mirror of
https://github.com/bitwarden/android.git
synced 2026-06-08 08:06:32 -05:00
Adds the initial boilerplate for VaultEditItemScreen (#326)
This commit is contained in:
David Perez
committed by
Álison Fernandes
Álison Fernandes
parent
a106f0852a
commit
a7dc5fe08f
@@ -0,0 +1,53 @@
|
||||
package com.x8bit.bitwarden.ui.vault.feature.edit
|
||||
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.navigation.NavController
|
||||
import androidx.navigation.NavGraphBuilder
|
||||
import androidx.navigation.NavOptions
|
||||
import androidx.navigation.NavType
|
||||
import androidx.navigation.compose.composable
|
||||
import androidx.navigation.navArgument
|
||||
import com.x8bit.bitwarden.ui.platform.theme.TransitionProviders
|
||||
|
||||
private const val VAULT_EDIT_ITEM_PREFIX = "vault_edit_item"
|
||||
private const val VAULT_EDIT_ITEM_ID = "vault_edit_item_id"
|
||||
private const val VAULT_EDIT_ROUTE = "$VAULT_EDIT_ITEM_PREFIX/{$VAULT_EDIT_ITEM_ID}"
|
||||
|
||||
/**
|
||||
* Class to retrieve vault item arguments from the [SavedStateHandle].
|
||||
*/
|
||||
class VaultEditItemArgs(val vaultItemId: String) {
|
||||
constructor(savedStateHandle: SavedStateHandle) : this(
|
||||
checkNotNull(savedStateHandle[VAULT_EDIT_ITEM_ID]) as String,
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the vault edit item screen to the nav graph.
|
||||
*/
|
||||
fun NavGraphBuilder.vaultEditItemDestination(
|
||||
onNavigateBack: () -> Unit,
|
||||
) {
|
||||
composable(
|
||||
route = VAULT_EDIT_ROUTE,
|
||||
arguments = listOf(
|
||||
navArgument(VAULT_EDIT_ITEM_ID) { type = NavType.StringType },
|
||||
),
|
||||
enterTransition = TransitionProviders.Enter.slideUp,
|
||||
exitTransition = TransitionProviders.Exit.slideDown,
|
||||
popEnterTransition = TransitionProviders.Enter.slideUp,
|
||||
popExitTransition = TransitionProviders.Exit.slideDown,
|
||||
) {
|
||||
VaultEditItemScreen(onNavigateBack)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Navigate to the vault edit item screen.
|
||||
*/
|
||||
fun NavController.navigateToVaultEditItem(
|
||||
vaultItemId: String,
|
||||
navOptions: NavOptions? = null,
|
||||
) {
|
||||
navigate("$VAULT_EDIT_ITEM_PREFIX/$vaultItemId", navOptions)
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
package com.x8bit.bitwarden.ui.vault.feature.edit
|
||||
|
||||
import android.widget.Toast
|
||||
import androidx.compose.foundation.layout.fillMaxSize
|
||||
import androidx.compose.foundation.layout.imePadding
|
||||
import androidx.compose.material3.ExperimentalMaterial3Api
|
||||
import androidx.compose.material3.TopAppBarDefaults
|
||||
import androidx.compose.material3.rememberTopAppBarState
|
||||
import androidx.compose.runtime.Composable
|
||||
import androidx.compose.runtime.getValue
|
||||
import androidx.compose.runtime.remember
|
||||
import androidx.compose.ui.Modifier
|
||||
import androidx.compose.ui.input.nestedscroll.nestedScroll
|
||||
import androidx.compose.ui.platform.LocalContext
|
||||
import androidx.compose.ui.res.painterResource
|
||||
import androidx.compose.ui.res.stringResource
|
||||
import androidx.hilt.navigation.compose.hiltViewModel
|
||||
import androidx.lifecycle.compose.collectAsStateWithLifecycle
|
||||
import com.x8bit.bitwarden.R
|
||||
import com.x8bit.bitwarden.ui.platform.base.util.EventsEffect
|
||||
import com.x8bit.bitwarden.ui.platform.components.BitwardenScaffold
|
||||
import com.x8bit.bitwarden.ui.platform.components.BitwardenTextButton
|
||||
import com.x8bit.bitwarden.ui.platform.components.BitwardenTopAppBar
|
||||
|
||||
/**
|
||||
* Top level composable for the vault edit item screen.
|
||||
*/
|
||||
@OptIn(ExperimentalMaterial3Api::class)
|
||||
@Composable
|
||||
fun VaultEditItemScreen(
|
||||
onNavigateBack: () -> Unit,
|
||||
viewModel: VaultEditItemViewModel = hiltViewModel(),
|
||||
) {
|
||||
val state by viewModel.stateFlow.collectAsStateWithLifecycle()
|
||||
val context = LocalContext.current
|
||||
val resources = context.resources
|
||||
EventsEffect(viewModel = viewModel) { event ->
|
||||
when (event) {
|
||||
VaultEditItemEvent.NavigateBack -> onNavigateBack()
|
||||
|
||||
is VaultEditItemEvent.ShowToast -> {
|
||||
Toast.makeText(context, event.message(resources), Toast.LENGTH_SHORT).show()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
val scrollBehavior = TopAppBarDefaults.pinnedScrollBehavior(rememberTopAppBarState())
|
||||
BitwardenScaffold(
|
||||
modifier = Modifier
|
||||
.imePadding()
|
||||
.fillMaxSize()
|
||||
.nestedScroll(scrollBehavior.nestedScrollConnection),
|
||||
topBar = {
|
||||
BitwardenTopAppBar(
|
||||
title = stringResource(id = R.string.edit_item),
|
||||
navigationIcon = painterResource(id = R.drawable.ic_close),
|
||||
navigationIconContentDescription = stringResource(id = R.string.close),
|
||||
onNavigationIconClick = remember(viewModel) {
|
||||
{ viewModel.trySendAction(VaultEditItemAction.CloseClick) }
|
||||
},
|
||||
scrollBehavior = scrollBehavior,
|
||||
actions = {
|
||||
BitwardenTextButton(
|
||||
label = stringResource(id = R.string.save),
|
||||
onClick = remember(viewModel) {
|
||||
{ viewModel.trySendAction(VaultEditItemAction.SaveClick) }
|
||||
},
|
||||
)
|
||||
},
|
||||
)
|
||||
},
|
||||
) { innerPadding -> }
|
||||
}
|
||||
@@ -0,0 +1,93 @@
|
||||
package com.x8bit.bitwarden.ui.vault.feature.edit
|
||||
|
||||
import android.os.Parcelable
|
||||
import androidx.lifecycle.SavedStateHandle
|
||||
import androidx.lifecycle.viewModelScope
|
||||
import com.x8bit.bitwarden.ui.platform.base.BaseViewModel
|
||||
import com.x8bit.bitwarden.ui.platform.base.util.Text
|
||||
import com.x8bit.bitwarden.ui.platform.base.util.asText
|
||||
import dagger.hilt.android.lifecycle.HiltViewModel
|
||||
import kotlinx.coroutines.flow.launchIn
|
||||
import kotlinx.coroutines.flow.onEach
|
||||
import kotlinx.parcelize.Parcelize
|
||||
import javax.inject.Inject
|
||||
|
||||
private const val KEY_STATE = "state"
|
||||
|
||||
/**
|
||||
* ViewModel responsible for handling user interactions in the vault edit item screen
|
||||
*/
|
||||
@HiltViewModel
|
||||
class VaultEditItemViewModel @Inject constructor(
|
||||
private val savedStateHandle: SavedStateHandle,
|
||||
) : BaseViewModel<VaultEditItemState, VaultEditItemEvent, VaultEditItemAction>(
|
||||
initialState = savedStateHandle[KEY_STATE]
|
||||
?: VaultEditItemState(
|
||||
vaultItemId = VaultEditItemArgs(savedStateHandle).vaultItemId,
|
||||
),
|
||||
) {
|
||||
|
||||
init {
|
||||
stateFlow
|
||||
.onEach { savedStateHandle[KEY_STATE] = it }
|
||||
.launchIn(viewModelScope)
|
||||
}
|
||||
|
||||
override fun handleAction(action: VaultEditItemAction) {
|
||||
when (action) {
|
||||
VaultEditItemAction.CloseClick -> handleCloseClick()
|
||||
VaultEditItemAction.SaveClick -> handleSaveClick()
|
||||
}
|
||||
}
|
||||
|
||||
private fun handleCloseClick() {
|
||||
sendEvent(VaultEditItemEvent.NavigateBack)
|
||||
}
|
||||
|
||||
private fun handleSaveClick() {
|
||||
// TODO: Persist the data to the vault (BIT-502)
|
||||
sendEvent(VaultEditItemEvent.ShowToast("Not yet implemented".asText()))
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents the state for editing an item to the vault.
|
||||
*/
|
||||
@Parcelize
|
||||
data class VaultEditItemState(
|
||||
val vaultItemId: String,
|
||||
) : Parcelable
|
||||
|
||||
/**
|
||||
* Represents a set of events that can be emitted during the process of editing an item in the
|
||||
* vault. Each subclass of this sealed class denotes a distinct event that can occur.
|
||||
*/
|
||||
sealed class VaultEditItemEvent {
|
||||
/**
|
||||
* Shows a toast with the given [message].
|
||||
*/
|
||||
data class ShowToast(
|
||||
val message: Text,
|
||||
) : VaultEditItemEvent()
|
||||
|
||||
/**
|
||||
* Navigate back to previous screen.
|
||||
*/
|
||||
data object NavigateBack : VaultEditItemEvent()
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a set of actions related to the process of editing an item in the vault.
|
||||
* Each subclass of this sealed class denotes a distinct action that can be taken.
|
||||
*/
|
||||
sealed class VaultEditItemAction {
|
||||
/**
|
||||
* Represents the action when the save button is clicked.
|
||||
*/
|
||||
data object SaveClick : VaultEditItemAction()
|
||||
|
||||
/**
|
||||
* User clicked close.
|
||||
*/
|
||||
data object CloseClick : VaultEditItemAction()
|
||||
}
|
||||
Reference in New Issue
Block a user