CODEWITHSUNDEEP
swiftui
zumzum
zumzum

Reputation: 20138

How to print() to Xcode console in SwiftUI?

So I tried to put a print statement while debugging in a SwiftUI View.

print("landmark: \(landmark)")

In the following body.

var body: some View {
    NavigationView {
        List {
            Toggle(isOn: $userData.showFavoritesOnly) {
                Text("Favorite only")
            }
            ForEach(landmarkData) { landmark in
                print("landmark: \(landmark)")
                if !self.userData.showFavoritesOnly || landmark.isFavorite {
                    NavigationButton(destination: LandmarkDetail(landmark: landmark)) {
                        LandmarkRow(landmark: landmark)
                    }
                }
            }
        }
       .navigationBarTitle(Text("Landmarks"))            
    }
}

Compiler errors out: Xcode compiler error

So, what is the proper way to print to console in SwiftUI?

EDIT: I made Landmark conform to CustomStringConvertible:

struct Landmark: Hashable, Codable, Identifiable, CustomStringConvertible {

var description: String { name+"\(id)" }

var id: Int
var name: String
.....

I still get the "String is not convertible to any" error. Should it work now?

Upvotes: 156

Views: 102055

Answers (14)

Beetroot
Beetroot

Reputation: 111

// Try this, add a 'return' on a view then the 'print' can stay alive in.

// Option 1

struct ContentView: View {
    var num: Int = 1
    
    var body: some View {
        print(num)
        
        return  Text("hello")
    
    }
}

// option 2

// **onto a button**

.onTapGesture {
  if true {
 print("Does the Universe have a Purpose?")
 }

Upvotes: 3

Darkisa
Darkisa

Reputation: 2037

You can print in the body structure but to do so you have to explicitly return the view you want to render. The body property inside a View is just a computed property like any other in Swift that implicitly returns the view. And just like any other computed property, you can perform operations inside the computed property as long as a value is explicitly returned. For example, this will throw an error when you try to print because there is no explicit return:

struct SomeView: View {
  @State var isOpen = false
    
  var body: some View {
    print(isOpen) // error thrown here
    
    VStack {
      // other view code
    }
  }
}

But if we explicitly return the view we want then it will work e.g.

struct SomeView: View {
  @State var isOpen = false
    
  var body: some View {
    print(isOpen) // this ok because we explicitly returned the view below
    
    // Notice the added 'return' below
    return VStack {
      // other view code
    }
  }
}

The above will work well if you're looking to view how state or environment objects are changing before returning your view, but if you want to print something deeper down within the view you are trying to return, then I would go with @Rok Krulec answer.

Upvotes: 20

Andy Jazz
Andy Jazz

Reputation: 58043

You can declare a printing() method that includes print() and returns EmptyView struct.

struct ContentView: View {
    
    @State private var offset = CGSize.zero
    
    func printing(_ items: Any...) -> some View {
        let _ = print(items)
        return EmptyView()
    }
        
    var body: some View {
        
#if DEBUG
        printing(offset)                // prints [(0.0, 0.0)]
#endif

        ZStack {
            Text("Hello")
        }
    }
}

Upvotes: 5

iGhost
iGhost

Reputation: 1054

EDIT: Debug Preview is no longer supported in the latest versions of Xcode.

Very easy way to debug your Preview:

  1. Open your Swift project in Xcode 11.
  2. Right-click (or Control-click) on the Live Preview button in the bottom right corner of the preview.
  3. Select Debug Preview.

How to debug your SwiftUI previews in Xcode

Upvotes: 2

Amirca
Amirca

Reputation: 313

The safest and easiest way to print while debugging in a SwiftUI View.

extension View {
    func Print(_ item: Any) -> some View {
        #if DEBUG
        print(item)
        #endif
        return self
    }
}

Usage Example:

struct ContentView: View {
    var body: some View {
        VStack {
            ForEach((1...5), id: \.self) { number in
                Text("\(number)")
                    .Print(number)
            }
        }
    }
}

Console output:

1
2
3
4
5

Upvotes: 7

juliand665
juliand665

Reputation: 3324

You can easily add a print statement anywhere in a function builder by simply storing its return value in a wildcard, effectively ignoring it:

let _ = print("hi!")

No setup or other verbosity needed!

Why does this work while a regular print() doesn't?

The way SwiftUI's @ViewBuilder (and result builders in general) is that they consume any values in a closure that aren't used otherwise (e.g. if you just have 42 on its own line). The print function returns Void (nothing), which the builder would have to build into a view, so it fails. By instead assigning it to a variable (in this case _, basically a variable that you can never access), the Void is never offered to the view builder in the first place.

You could argue the builder should simply accept and ignore Void values, but the idea is that your builder closures should not have side effects (I'd remove print statements after finishing debugging too)—you should not rely on these closures being called at certain times.

Upvotes: 284

Binh Ho
Binh Ho

Reputation: 4936

This should work

if true {
      print(aVar, "xx")
}

return ZStack {
    ...
}

Upvotes: 1

staticVoidMan
staticVoidMan

Reputation: 20234

The following extension on View is as intuitive as print because it's made to replicate the default print(_:separator:terminator:) function signature & behavior.

extension View {
    func printUI(_ args: Any..., separator: String = " ", terminator: String = "\n") -> EmptyView {
        let output = args.map(String.init(describing:)).joined(separator: separator)
        print(output, terminator: terminator)
        return EmptyView()
    }
}

Usage Example:

struct ContentView: View {
    var body: some View {
        VStack {
            printUI("ContentView", "1")
            printUI("ContentView", "2", separator: ", ", terminator: "\n.\n.\n")
            printUI("ContentView", "3", separator: "; ")

            Text("Hello, World!")
        }
    }
}
Console Output:

ContentView 1
ContentView, 2
.
.
ContentView; 3

Upvotes: 2

Ahmad
Ahmad

Reputation: 353

Here you go. It will just work like simple print but inside a view.

      func printv( _ data : Any)-> EmptyView{
       print(data)
       return EmptyView()
      }

and use it like that

struct ContentView: View {
var body: some View  {
    VStack() {
        
        Text("hello To SwiftUI")
        
        printv("its easy to code in SwiftUI")
        
        Text("And Good to have you here")
    }
  } 
}

Upvotes: 2

Rok Krulec
Rok Krulec

Reputation: 895

Here's a helper Print( ... ) View that acts like a print( ... ) function but within a View

Put this in any of your view files

extension View {
    func Print(_ vars: Any...) -> some View {
        for v in vars { print(v) }
        return EmptyView()
    }
}

and use inside of body like so

Print("Here I am", varOne, varTwo ...)

or inside a ForEach {} like so

self.Print("Inside ForEach", varOne, varTwo ...)

Note: you might need to put Print() into a Group {} when combining with existing views

Upvotes: 68

Asperi
Asperi

Reputation: 257493

It is possible to use print() remembering that all SwiftUI View content are (a) implicit closures and (b) it is highly recommended to decompose views as much as possible to have simple structure, so it might look like the following...

struct Model: Identifiable {
    let value: String
    var id: String {
        value
    }
    init (_ value: String) {
        self.value = value
    }
}

struct TestView: View {
    @State var showFavoritesOnly = false
    @State var listData: [Model] = [Model("one"), Model("two"), Model("three")]

    var body: some View {
        NavigationView {
            List {
                Toggle(isOn: $showFavoritesOnly) {
                    Text("Favorite only")
                }
                ForEach(listData) { data in
                    self.rowView(data: data)
                }
            }
        }
    }

    private func rowView(data: Model) -> some View {
#if DEBUG
        print(">> \(data.value)")
#endif
        return NavigationLink(destination: Text("Details")) {
            Text("Go next from \(data.value)")
        }
    }
}

... and right clicking in Preview to select run as Debug Preview we get:

2019-10-31 14:28:03.467635+0200 Test[65344:11155167] [Agent] Received connection, creating agent
2019-10-31 14:28:04.472314+0200 Test[65344:11155168] [Agent] Received display message
>> one
>> two
>> three

Upvotes: 6

Philip Martin
Philip Martin

Reputation: 387

Try right-clicking on the live preview play button and selecting 'Debug Preview from the popup

Upvotes: 37

Monil Gandhi
Monil Gandhi

Reputation: 139

You can not print in body structure i.e. a structure which is some view type.For print you need to make function out of body structure and call it using button or something else.

Upvotes: 0

SwiftiSwift
SwiftiSwift

Reputation: 8687

You can't because you're in a computed property. You need for example a button and in the action you define the print. Or work with breakpoints

Upvotes: 1

Related Questions