-
Notifications
You must be signed in to change notification settings - Fork 15
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
QR code image logic refactoring #1732
base: main
Are you sure you want to change the base?
Conversation
The QR code image logic of the `QrCode` and `Request` screens has been refactored to work upon the newer `ZashiQr` component
86b2195
to
125302d
Compare
@@ -3,14 +3,15 @@ package co.electriccoin.zcash.ui.screen.qrcode.model | |||
import androidx.compose.ui.graphics.ImageBitmap | |||
import cash.z.ecc.android.sdk.model.WalletAddress | |||
|
|||
internal sealed class QrCodeState { | |||
sealed class QrCodeState { | |||
data object Loading : QrCodeState() | |||
|
|||
data class Prepared( | |||
val qrCodeType: QrCodeType, | |||
val walletAddress: WalletAddress, | |||
val onAddressCopy: (String) -> Unit, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
possibly we do not need to add String resource to val onAddressCopy: (String) -> Unit
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also possibly we can leverage the shared QrState here:
data class Prepared(
val qrCodeType: QrCodeType,
val walletAddress: WalletAddress,
val onBack: () -> Unit,
val qrState: QrState
)
@@ -26,7 +30,10 @@ fun ZashiQr( | |||
qrData: String, | |||
modifier: Modifier = Modifier, | |||
qrSize: Dp = ZashiQrDefaults.width, | |||
colors: QrCodeColors = QrCodeDefaults.colors() | |||
colors: QrCodeColors = QrCodeDefaults.colors(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to embed variables into a state. Maybe:
data class QrState(
val qrData: String,
val contentDescription: StringResource,
val onClick: () -> Unit,
@DrawableResource val centerImage: Int // do not use Painter here
)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we would end up with 2 overloads of the function for simplicity
fun ZashiQr(
qrData: String,
modifier: Modifier = Modifier,
qrSize: Dp = ZashiQrDefaults.width,
colors: QrCodeColors = QrCodeDefaults.colors(),
contentDescription: StringResource? = null,
onClick: () -> Unit = {},
@DrawableRes centerImage: Int? = null
) = ZashiQr(
modifier = modifier,
qrSize = qrSize,
colors = colors,
state = QrState(
qrData = qrData,
contentDescription = contentDescription,
onClick = onClick,
centerImage = centerImage,
)
)
and
fun ZashiQr(
state: QrState,
modifier: Modifier = Modifier,
qrSize: Dp = ZashiQrDefaults.width,
colors: QrCodeColors = QrCodeDefaults.colors(),
QrCode
andRequest
screens has been refactored to work upon the newerZashiQr
componentAuthor
Reviewer
Footnotes
Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs. ↩
While we aim for automated testing of the application, some aspects require manual testing. If you had to manually test something during development of this pull request, write those steps down. ↩
While we are not looking for perfect coverage, the tool can point out potential cases that have been missed. Code coverage can be generated with:
./gradlew check
for Kotlin modules and./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true
for Android modules. ↩Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit. ↩
In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass. ↩
While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data. Perform this step last, after verifying the code changes are safe to run locally. ↩