| name | view-refactor |
| description | Refactor SwiftUI view files for consistent structure, dependency injection, and Observation usage. Use when asked to clean up a SwiftUI view's layout, handle view models safely, or standardize how dependencies are initialized and passed. |
SwiftUI View Refactor
Overview
Apply consistent structure and dependency patterns to SwiftUI views, focusing on ordering, MV patterns, careful view model handling, and correct Observation usage.
View Ordering (top to bottom)
- Environment properties
private/public let constants
@State / other stored properties
- Computed
var (non-view)
init
body
- Computed view builders / view helpers
- Helper / async functions
Core Guidelines
1) Prefer MV (Model-View) Patterns
- Default to MV: views are lightweight state expressions; models/services own business logic
- Favor
@State, @Environment, @Query, task, and onChange for orchestration
- Inject services and shared models via
@Environment
- Split large views into smaller views instead of introducing a view model
2) Split Large Bodies
If body grows beyond a screen or has multiple logical sections, split it:
var body: some View {
VStack(alignment: .leading, spacing: 16) {
HeaderSection(title: title, isPinned: isPinned)
DetailsSection(details: details)
ActionsSection(onSave: onSave, onCancel: onCancel)
}
}
Or use computed view properties in the same file:
var body: some View {
List {
header
filters
results
footer
}
}
private var header: some View {
VStack(alignment: .leading, spacing: 6) {
Text(title).font(.title2)
Text(subtitle).font(.subheadline)
}
}
private var filters: some View {
ScrollView(.horizontal, showsIndicators: false) {
HStack {
ForEach(filterOptions, id: \.self) { option in
FilterChip(option: option, isSelected: option == selectedFilter)
.onTapGesture { selectedFilter = option }
}
}
}
}
3) View Model Handling (only if already present)
- Do not introduce a view model unless the request or existing code clearly calls for one
- If a view model exists, make it non-optional when possible
- Pass dependencies to the view via
init, then into the view model
@State private var viewModel: SomeViewModel
init(dependency: Dependency) {
_viewModel = State(initialValue: SomeViewModel(dependency: dependency))
}
4) Observation Usage
- For
@Observable reference types, store them as @State in the root view
- Pass observables down explicitly as needed
- Avoid optional state unless required
Refactor Workflow
- Reorder the view to match the ordering rules
- Favor MV: move orchestration into the view using
@State, @Environment, task, onChange
- If a view model exists, replace optional with non-optional
@State initialized in init
- Confirm Observation usage:
@State for root @Observable, no redundant wrappers
- Keep behavior intact: do not change layout or business logic unless requested
Large-View Handling
When a SwiftUI view file exceeds ~300 lines:
- Split using extensions to group related helpers
- Move async functions into dedicated
private extensions
- Use
// MARK: - comments (e.g., // MARK: - Actions, // MARK: - Subviews)
- Keep main
struct focused on stored properties, init, and body
struct LargeView: View {
@Environment(Store.self) private var store
@State private var items: [Item] = []
var body: some View {
List {
content
}
.task { await loadItems() }
}
}
private extension LargeView {
var content: some View {
ForEach(items) { item in
ItemRow(item: item)
}
}
}
private extension LargeView {
func loadItems() async {
items = await store.fetchItems()
}
}
Checklist