Recipes

Task-focused, copy-pasteable solutions to common Circuit patterns. Start with the problem you have; there is no required reading order.

New to Circuit? Start with the Tutorial and States and Events first; these recipes assume you know what a Screen, Presenter, and Ui are.

Loading data

• Show loading, loaded, and error states
• Observe a Flow or repository without leaking it
• Retry a failed load
• Pull to refresh
• Paginate a list (load more on scroll)
• Debounce a search field

Navigation & results

• Return a result to the previous screen
• Ask for confirmation with a dialog
• Pick a value from a bottom sheet
• Tabs with independent back stacks
• Navigate to an Android Activity or URL
• Intercept, block, or rewrite navigation
• Deep linking on Android

Composing & reusing UI

• Embed a reusable component that delegates navigation
• Share selection state across list items
• Keep UI state across rotation and the back stack

Effects & lifecycle

• Log an impression once when a screen opens
• Run a one-shot suspend action from an event

Forms

• A form with validation and submit

Testing

• Test a presenter that navigates
• Test a presenter that shows an overlay