Describe the bug While making a SwiftUI view everyt

Hey <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url=

<a class="user-mention notranslate" data-hovercard-type="user" data-hover

WithViewStore not refreshing about swift-composable-architecture HOT 5 CLOSED

pointfreeco commented on May 23, 2024

WithViewStore not refreshing

from swift-composable-architecture.

Comments (5)

mbrandonw commented on May 23, 2024 4

Hey @alexito4 thanks for the report!

You are correct there is some weird behavior here, and it's something we've run into ourselves. We actually have this called out in the documentation:

swift-composable-architecture/Sources/ComposableArchitecture/SwiftUI/WithViewStore.swift

Lines 7 to 18 in d2240d0

 /// Due to a bug in SwiftUI, there are times that use of this view can interfere with some core 

 /// views provided by SwiftUI. The known problematic views are: 

 /// 

 /// * If a `GeometryReader` is used inside a `WithViewStore` it will not receive state updates 

 /// correctly. To work around you either need to reorder the views so that `GeometryReader` 

 /// wraps the `WithViewStore`, or, if that is not possible, then you must hold onto an explicit 

 /// `@ObservedObject var viewStore: ViewStore<State, Action>` in your view in lieu of using 

 /// this helper (see [here](https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18)). 

 /// * If you create a `Stepper` via the `Stepper.init(onIncrement:onDecrement:label:)` initializer 

 /// inside a `WithViewStore` it will behave erratically. To work around you should use the 

 /// initializer that takes a binding (see 

 /// [here](https://gist.github.com/mbrandonw/dee2ceac2c316a1619cfdf1dc7945f66)).

This bug is even reproducible in vanilla SwiftUI code, so it's not related to TCA at all. We've filed feedbacks and have gotten a response that it is definitely a bug in SwiftUI.

You have two options for working around this. First, sometimes it's possible to put the GeometryReader on the outside of the WithViewStore, and then everything works correctly. We are able to do this in the animations case study:

swift-composable-architecture/Examples/CaseStudies/SwiftUICaseStudies/01-GettingStarted-Animations.swift

Lines 36 to 37 in d95caec

 GeometryReader { proxy in 

 WithViewStore(self.store) { viewStore in

It's not always possible to do that, but if it is then it's the easiest workaround.

If you can't flip the views then gotta use the ViewStore as a @ObservableObject, which requires a small amount of manual work. We demonstrate this in the voice memos app:

swift-composable-architecture/Examples/VoiceMemos/VoiceMemos/VoiceMemos.swift

Lines 346 to 352 in d2240d0

 struct VoiceMemoView: View { 

 // NB: We are using an explicit `ObservedObject` for the view store here instead of 

 // `WithViewStore` due to a SwiftUI bug where `GeometryReader`s inside `WithViewStore` will 

 // not properly update. 

 // 

 // Feedback filed: https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18 

 @ObservedObject var viewStore: ViewStore<VoiceMemo, VoiceMemoAction>

Can you give that a shot and let us know if it works out?

Hopefully this is fixed in SwiftUI soon!

from swift-composable-architecture.

mbrandonw commented on May 23, 2024 1

@mbrandonw can you share a code snippet that reproduces the bug?

We've got links to feedbacks we have submitted to Apple in the documentation of WithViewStore:

swift-composable-architecture/Sources/ComposableArchitecture/SwiftUI/WithViewStore.swift

Lines 11 to 20 in edfe198

 /// * If a `GeometryReader` or `ScrollViewReader` is used inside a ``WithViewStore`` it will not 

 /// receive state updates correctly. To work around you either need to reorder the views so that 

 /// the `GeometryReader` or `ScrollViewReader` wraps ``WithViewStore``, or, if that is not 

 /// possible, then you must hold onto an explicit 

 /// `@ObservedObject var viewStore: ViewStore<State, Action>` in your view in lieu of using this 

 /// helper (see [here](https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18)). 

 /// * If you create a `Stepper` via the `Stepper.init(onIncrement:onDecrement:label:)` initializer 

 /// inside a ``WithViewStore`` it will behave erratically. To work around you should use the 

 /// initializer that takes a binding (see 

 /// [here](https://gist.github.com/mbrandonw/dee2ceac2c316a1619cfdf1dc7945f66)).

Here's a gist of the feedback, which shows how to reproduce the bug in vanilla SwiftUI:

https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18

from swift-composable-architecture.

alexito4 commented on May 23, 2024

We actually have this called out in the documentation

Dang! I'm so sorry! I totally read that days ago and I knew there was some issue with the geometry reader, in my mind that's why I nested it inside because otherwise the sizes were wrong. Now I realise that causes this other issue, sorry for not reading it again ^^'

I juggled some geometry readers around but ended up moving the viewStore to a property, seems safer and easier to maintain.

Thank you @mbrandonw 🤗

from swift-composable-architecture.

ferologics commented on May 23, 2024

This is still an issue, if anyone's wondering.

from swift-composable-architecture.

doesnotexist commented on May 23, 2024

This bug is even reproducible in vanilla SwiftUI code,

@mbrandonw can you share a code snippet that reproduces the bug?

from swift-composable-architecture.

WithViewStore not refreshing about swift-composable-architecture HOT 5 CLOSED

Comments (5)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	/// Due to a bug in SwiftUI, there are times that use of this view can interfere with some core
	/// views provided by SwiftUI. The known problematic views are:
	///
	/// * If a `GeometryReader` is used inside a `WithViewStore` it will not receive state updates
	/// correctly. To work around you either need to reorder the views so that `GeometryReader`
	/// wraps the `WithViewStore`, or, if that is not possible, then you must hold onto an explicit
	/// `@ObservedObject var viewStore: ViewStore<State, Action>` in your view in lieu of using
	/// this helper (see [here](https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18)).
	/// * If you create a `Stepper` via the `Stepper.init(onIncrement:onDecrement:label:)` initializer
	/// inside a `WithViewStore` it will behave erratically. To work around you should use the
	/// initializer that takes a binding (see
	/// [here](https://gist.github.com/mbrandonw/dee2ceac2c316a1619cfdf1dc7945f66)).

	GeometryReader { proxy in
	WithViewStore(self.store) { viewStore in

	struct VoiceMemoView: View {
	// NB: We are using an explicit `ObservedObject` for the view store here instead of
	// `WithViewStore` due to a SwiftUI bug where `GeometryReader`s inside `WithViewStore` will
	// not properly update.
	//
	// Feedback filed: https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18
	@ObservedObject var viewStore: ViewStore<VoiceMemo, VoiceMemoAction>

	/// * If a `GeometryReader` or `ScrollViewReader` is used inside a ``WithViewStore`` it will not
	/// receive state updates correctly. To work around you either need to reorder the views so that
	/// the `GeometryReader` or `ScrollViewReader` wraps ``WithViewStore``, or, if that is not
	/// possible, then you must hold onto an explicit
	/// `@ObservedObject var viewStore: ViewStore<State, Action>` in your view in lieu of using this
	/// helper (see [here](https://gist.github.com/mbrandonw/cc5da3d487bcf7c4f21c27019a440d18)).
	/// * If you create a `Stepper` via the `Stepper.init(onIncrement:onDecrement:label:)` initializer
	/// inside a ``WithViewStore`` it will behave erratically. To work around you should use the
	/// initializer that takes a binding (see
	/// [here](https://gist.github.com/mbrandonw/dee2ceac2c316a1619cfdf1dc7945f66)).