Tutorial update #1159
Draft
Tutorial update #1159
Conversation
This file contains 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
It's time to get the Tutorial caught up with undeprecated API. This PR modifies only the final tutorial module. Once we're happy with the code, I'll back port the changes and update the prose in follow ups.
- Use `AndroidScreen` and drop `ViewRegistry`
- Better, more consistent use of `BackStackScreen`
- Use `View.setBackHandler`
- Use `TextController`
- Delete a lot of `// Exactly what the function name and the code say` comments
- More consistent naming, code style for actions and event handlers in `Screen` renderings
- Event handler fields are named `onVerbPhrase`, like `onBackPressed`
- Action names are verb phrases describing the action that is being taken, not the event that is being handled
- Output names are generally in terms of the semantic event being reported to the parent, rather than describing what the parent will do
Thus:
```kotlin
return TodoListScreen(
onRowPressed = { context.actionSink.send(reportSelection(it)) }
```
```kotlin
private fun reportSelection(index: Int) = action {
// Tell our parent that a todo item was selected.
setOutput(TodoSelected(index))
}
```
I did not introduce `RenderContext.eventHandler {}`, that seems like it would just be confusing to a newcomer.
Also not introducing big new blocks of material, in particular not introducing `Overlay`. I do think we should do that, but for this release I just want to focus on getting the deprecated code deleted.
Our templates were out of date, and our `install.sh` script doesn't work any more.
Replaced with an IDE-produced zip file that the IDE is willing to import.
Replaces `Layout Runner (ViewBinding)` with `Android Screen (ViewBinding)`:
```kotlin
package ${PACKAGE_NAME}
import com.squareup.workflow1.ui.AndroidScreen
import com.squareup.workflow1.ui.ScreenViewFactory
import com.squareup.workflow1.ui.ScreenViewRunner
import com.squareup.workflow1.ui.ViewEnvironment
import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
@OptIn(WorkflowUiExperimentalApi::class)
data class $Name(
// TODO: add properties needed to update $VIEW_BINDING_TYPE
) : AndroidScreen<$Name> {
override val viewFactory =
ScreenViewFactory.fromViewBinding($VIEW_BINDING_TYPE::inflate, ::${Name}Runner)
}
@OptIn(WorkflowUiExperimentalApi::class)
private class ${Name}Runner(
private val viewBinding: $VIEW_BINDING_TYPE
) : ScreenViewRunner<$Name> {
override fun showRendering(
rendering: $Name,
environment: ViewEnvironment
) {
TODO("Update viewBinding from rendering")
}
}
```
…tchup Final tutorial catches up to container > navigation package name change
Fix tutorial fileTemplates
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Long lived branch that is collecting commits that bring the tutorial up to date with undeprecated workflow UI API. Expect rebases. So far the source code in
samples/tutorial/tutorial-finalis in the proper form. No prose has been updated yet.