Skip to content

Latest commit

 

History

History
107 lines (77 loc) · 3.72 KB

README.md

File metadata and controls

107 lines (77 loc) · 3.72 KB
Raw

BuilderIO-Swift

The SDK for BuilderIO for iOS in Swift.

Using this SDK

Add dependency

  • Add a dependency on the Builder Swift SDK in your iOS App via the Github package: https://github.com/BuilderIO/builder-swift
  • Point to the main branch of the repository to get the latest and greatest SDK code
  • Import BuilderIO wherever you need to use the SDK methods
  • Instantiate an instance of the BuilderContentWrapper at the beginning of your view
import BuilderIO

struct ContentView: View {
    @ObservedObject var content: BuilderContentWrapper = BuilderContentWrapper();
}

(Optional) Register your custom components

Register any components you have created in your iOS App using something like

        registerComponent(component: BuilderCustomComponent(name: "MyComponentName",
          inputs: [ BuilderInput(name: "ctaText", type: "text")]
        ), factory: { (options, styles) in
            // Return an instance of your view, passing in any
            // properties from Builder to your component for rendering
            return HeroComponent(headingText: options["headingText"].stringValue, ctaText: options["ctaText"].stringValue)
        }, "YOUR_BUILDER_API_KEY");

Fetch Content

Based on your targeting requirements, fetch the necessary published content from Builder using Content.getContent. You will need to pass in the model name, apiKey, the url and locale to it.

Content.getContent(model: "page", 
                   apiKey: "YOUR_BUILDER_API_KEY", 
                   url: "/my-targeting-url", 
                   locale: "", 
                   preview: "") { content in
    // Update your view here
    // Ideally in the main thread
    DispatchQueue.main.async {
        self.content.changeContent(content);
    }
}

In the above, replace page with your model name (if you have not used the default page model in Builder), and apiKey with your API key from Builder.

Render Content

At the location where you want to render the content fetched from Builder (in a View), call the RenderContent method with the content fetched via the Content.getContent call.

RenderContent(content: content.wrappedValue!, apiKey: "<YOUR_BUILDER_API_KEY>")

Alternatively, if you want to override the click handling and want to intercept each Button click, then you can pass in your own custom click handler that can do whatever you need to do.

RenderContent(content: content.wrappedValue!, apiKey: "<YOUR_BUILDER_API_KEY>") { buttonText, urlString in
    print("Some one clicked a button!!", buttonText, urlString ?? "empty url");
}

Handle Preview Updates from the WebApp

At the end of your view where you render Builder Content, add the following snippet which

  • Adds a reload button which refreshes the content
  • Listens to notifications from Appetize (Used in the web app) to update content as you change it in the editor
if (Content.isPreviewing()) {
    Button("Reload") {
        fetchContent();
    }.onReceive(NotificationCenter.default.publisher(for: deviceDidShakeNotification)) { _ in
        fetchContent()
    }
}

Complete example

For a complete example of an iOS app using the Builder SDK, please refer to https://github.com/BuilderIO/builder/tree/main/examples/swift

You can use this as a base app, and replace the API key in the example with your own to try it out.

Current Support:

Builder Component Color Margin / Padding Horizontal Alignment Click Support
Button ✅ ✅ ✅ ✅
Text ✅ ✅ ✅ 🏗
Image ✅ ✅ ✅ 🏗
Columns 🏗 🏗 🏗 🏗
Video 🏗 🏗 🏗 🏗

Contributing