JustWantSomethingToDo

To-Do and time tracking app with day planning and suggestions of what to do next when there is overwhelming choices

Development

Style and Best Practices

Composables

• Name something that is a navigation route that controls the whole screen with the suffix Screen.
  • Example: RoutinesScreen
  • The screen composable should only contain a scaffold that adds top/bottom bars, and contains a child defined in the same file without the Screen suffix that defines the main content.
  • The arguments should be ordered with the main content first, then top bar, bottom bar, and floating action button, with modifier last as the only optional argument.
• Composable components should have most arguments be optional with suitable defaults for previews.
  • Order arguments in the order they are used in the UI layout.
• Order file with Screen composable first, then the related main content, followed by any related components, with top bar, bottom bar, and floating action button last.
• Generally pass all composable arguments like name = value instead of positional arguments.
  • Exception is Text that should be just called like Text("text") if there are no additional arguments.
• Preview should have the background turned on in most cases and be 600 dp wide by 400 dp tall.

Naming

• Name lambdas passed to children for navigating as navRoute where Route is the name of the route in the navigation graph without the Route suffix, or a suitable descriptive alternative if the destination is not just a simple destination route.
  • Example: navAddToDo to navigate to form to add a to-do.
• Name lambdas that will take an action without a prefix.
  • Example: addToDo to submit the data for a new to-do.
• Use the on prefix for other lambdas that are passed down to children composeables that respond to an action being taken.
  • Example: onAddedToDo to take action after a to-do is added.