228

I would like to initialise the value of a @State var in SwiftUI through the init() method of a Struct, so it can take the proper text from a prepared dictionary for manipulation purposes in a TextField. The source code looks like this:

struct StateFromOutside: View {
    let list = [
        "a": "Letter A",
        "b": "Letter B",
        // ...
    ]
    @State var fullText: String = ""

    init(letter: String) {
        self.fullText = list[letter]!
    }

    var body: some View {
        TextField($fullText)
    }
}

Unfortunately the execution fails with the error

Thread 1: Fatal error: Accessing State outside View.body

How can I resolve the situation?

1
  • 15
    Use State(initialValue:) Commented Mar 16, 2020 at 13:05

9 Answers 9

743

SwiftUI doesn't allow you to change @State in the initializer but you can initialize it.

Remove the default value and use _fullText to set @State directly instead of going through the property wrapper accessor.

@State var fullText: String // No default value of ""

init(letter: String) {
    _fullText = State(initialValue: list[letter]!)
}
Sign up to request clarification or add additional context in comments.

13 Comments

@Diesel At first I was hesitant to use this because I thought it was accessing some internal API, but it turns out it's part of the Swift language. For concise information about how property wrappers work under the hood including the synthesized underscore (_), see docs.swift.org/swift-book/ReferenceManual/Attributes.html under propertyWrapper
You should also note that the state you initialise inside init will probably immediately be overridden after all the stored properties are initialised. See this comment where an  engineer explicitly says not to initialise @State using init but to do it inline instead.
The answer is not a solution to the problem. It will not work "like a dream", rather nightmarish. Here, we need to use bindings which can be initialised within the initialiser, if we want to mutate the value within the view. Initialising @State in init will do it only the very first time a value of this view will be created. Subsequent views will not see the value which is passed as argument in the init, but the previous value which is cached by the SwiftUI system.
developer.apple.com/forums/thread/657393 "init is not a good place to update the value of @State vars."
|
50

I would try to initialise it in onAppear.

struct StateFromOutside: View {
    let list = [
        "a": "Letter A",
        "b": "Letter B",
        // ...
    ]
    @State var fullText: String = ""

    var body: some View {
        TextField($fullText)
             .onAppear {
                 self.fullText = list[letter]!
             }
    }
}

Or, even better, use a model object (a BindableObject linked to your view) and do all the initialisation and business logic there. Your view will update to reflect the changes automatically.


Update: BindableObject is now called ObservableObject.

5 Comments

Thank you, this works perfectly (although I have applied the .onAppear on a VStack which is around the TextField).
Hacking around a little longer I have noticed that your solution is a workaround for this very situation, but I ran into more situations where I have to initialise a @State var. Although it would be possible to apply this method there as well I do not think that this is the very best way to handle it.
@DanielMessner : Yes, I agree, for more complicated cases just use a model object (BindableObject) and do the initialization in that object, either when running init() or triggered in the view by an .onAppear event.
This is not considered the best solution for the particular case in the question - but it is the best solution for another type of problem. I have a @State whose initial value depends on another object I pass in, so each time I show the view, I want it to have a different initial value. The other answer does not solve that, but setting the state in onAppear does.
@RichardVenable pass in the value as a let for read only or binding for read/write. Using onAppear for data flow is 100% wrong.
34

The top answer is an anti-pattern that will cause pain down the road, when the dependency changes (letter) and your state will not update accordingly.

One should never use State(initialValue:) or State(wrappedValue:) to initialize state in a View's init. In fact, State should only be initialized inline, like so:

@State private var fullText: String = "The value"

If that's not feasible, use @Binding, @ObservedObject, a combination between @Binding and @State or even a custom DynamicProperty

More about this here.

Comments

3

It's not an issue nowadays to set a default value of the @State variables inside the init method. But you MUST just get rid of the default value which you gave to the state and it will work as desired:

,,,
    @State var fullText: String // 👈 No default value should be here

    init(letter: String) {
        self.fullText = list[letter]!
    }

    var body: some View {
        TextField("", text: $fullText)
    }
}

Working demo: enter image description here

2 Comments

With this solution I get the error "Variable 'self.toggleValue' used before being initialized"
@user3296487 this code does not even have self.toggleValue. Just use the demo code and adapt yours, step by step to see what you are missing.
1

Depending on the case, you can initialize the State in different ways:

// With default value

@State var fullText: String = "XXX"

// Not optional value and without default value

@State var fullText: String

init(x: String) {
    fullText = x
}

// Optional value and without default value

@State var fullText: String

init(x: String) {
    _fullText = State(initialValue: x)
}

1 Comment

Did you mean to use an optional type for the third example? @State var fullText: String?
0

The answer of Bogdan Farca is right for this case but we can't say this is the solution for the asked question because I found there is the issue with the Textfield in the asked question. Still we can use the init for the same code So look into the below code it shows the exact solution for asked question.

struct StateFromOutside: View {
    let list = [
        "a": "Letter A",
        "b": "Letter B",
        // ...
    ]
    @State var fullText: String = ""

    init(letter: String) {
        self.fullText = list[letter]!
    }

    var body: some View {
        VStack {
            Text("\(self.fullText)")
            TextField("Enter some text", text: $fullText)
        }
    }
}

And use this by simply calling inside your view

struct ContentView: View {
    var body: some View {
        StateFromOutside(letter: "a")
    }
}

Comments

0

You can create a view model and initiate the same as well :

 class LetterViewModel: ObservableObject {

     var fullText: String
     let listTemp = [
         "a": "Letter A",
         "b": "Letter B",
         // ...
     ]

     init(initialLetter: String) {
         fullText = listTemp[initialLetter] ?? ""
     }
 }

 struct LetterView: View {

     @State var viewmodel: LetterViewModel

     var body: some View {
    
         TextField("Enter text", text: $viewmodel.fullText)
     }
 }

And then call the view like this:

 struct ContentView: View {

     var body: some View {

           LetterView(viewmodel: LetterViewModel(initialLetter: "a"))
     }
 }

By this you would also not have to call the State instantiate method.

Comments

-1

To initialize a @State variable in SwiftUI through the init method of a struct, you need to understand that @State properties are managed by SwiftUI and cannot be directly set within the initializer. Instead, you can use a workaround by utilizing a separate property for the initial value and then assigning it to the @State variable within the body of the view. Here is how you can achieve this:

struct StateFromOutside: View {
    let list = [
        "a": "Letter A",
        "b": "Letter B",
        // ...
    ]
    
    // Private property to hold the initial value
    private var initialText: String
    
    // @State variable to be used in the view
    @State private var fullText: String = ""
    
    init(letter: String) {
        self.initialText = list[letter] ?? ""
    }
    
    var body: some View {
        // Assign initial value to @State variable if it's not already set
        VStack {
            TextField("Enter text", text: $fullText)
                .onAppear {
                    if self.fullText.isEmpty {
                        self.fullText = self.initialText
                    }
                }
        }
    }
}

Explanation Private Property for Initial Value: A private property initialText is added to hold the initial value passed through the initializer. Setting the @State Variable: In the body of the view, use the onAppear modifier to set the @State variable fullText to initialText only if it hasn't been set already. This ensures that fullText gets its initial value when the view appears.

Comments

-3

See the .id(count) in the example code below.

import SwiftUI
import MapKit

struct ContentView: View {
    @State private var count = 0
    
    var body: some View {
        Button("Tap me") {
            self.count += 1
            print(count)
        }
        Spacer()
        testView(count: count).id(count) // <------ THIS IS IMPORTANT. Without this "id" the initializer setting affects the testView only once and calling testView again won't change it (not desirable, of course)
    }
}



struct testView: View {
    var count2: Int
    @State private var region: MKCoordinateRegion
    
    init(count: Int) {
        count2 = 2*count
        print("in testView: \(count)")
        
        let lon =  -0.1246402 + Double(count) / 100.0
        let lat =  51.50007773 + Double(count) / 100.0
        let myRegion = MKCoordinateRegion(center: CLLocationCoordinate2D(latitude: lat, longitude: lon) , span: MKCoordinateSpan(latitudeDelta: 0.01, longitudeDelta: 0.01))
        _region = State(initialValue: myRegion)
    }

    var body: some View {
        Map(coordinateRegion: $region, interactionModes: MapInteractionModes.all)
        Text("\(count2)")
    }
}

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.