WelcomeScreen

public struct WelcomeScreen

extension WelcomeScreen: View

extension WelcomeScreen: _ViewEmptyChecking

WelcomeScreen is used to display a welcome/launch screen to the application for onboarding. The screen mainly displays the application name, instructions on how to start the activation process and an option to trigger the demo mode of the application.

Usage

WelcomeScreen(title: {
    Text(titleStr)
}, description: {
    Text(descriptionStr)
}, icon: {
    Image("oski")
}, footnote: {
    Text("Want to explore?")
}, action: {
    FioriButton { _ in
        //
    } label: { _ in
        Text(primaryButtonTitleStr)
            .multilineTextAlignment(.center)
    }
}, secondaryAction: {
    //
}, illustratedMessage: {
    //
}, headlineImage: {
    Image("SAPLogo")
}, inputText: self.$email, legalText: {
    Text("legal text")
}, isLegalAgreementRequired: isLegalAgreementRequired, showsIllustratedMessage: self.showsIllustratedMessage, state: state, options: options, isDemoAvailable: isDemoAvailable, footerText: {
   if showTermsOfService, type != .link, type != .customLogo {
       Text("footer text")
   }
})


                      
                      
                      init(title:description:icon:footnote:action:secondaryAction:illustratedMessage:headlineImage:inputText:legalText:isLegalAgreementRequired:showsIllustratedMessage:state:options:isDemoAvailable:footerText:componentIdentifier:)

Undocumented

Declaration

Swift

public init(@ViewBuilder title: () -> any View,
            @ViewBuilder description: () -> any View = { EmptyView() },
            @ViewBuilder icon: () -> any View = { EmptyView() },
            @ViewBuilder footnote: () -> any View = { EmptyView() },
            @ViewBuilder action: () -> any View = { EmptyView() },
            @ViewBuilder secondaryAction: () -> any View = { EmptyView() },
            @ViewBuilder illustratedMessage: () -> any View = { EmptyView() },
            @ViewBuilder headlineImage: () -> any View = { EmptyView() },
            inputText: Binding<String> = .constant(""),
            @ViewBuilder legalText: () -> any View = { EmptyView() },
            isLegalAgreementRequired: Bool = false,
            showsIllustratedMessage: Bool = false,
            state: WelcomeScreenState = .notConfigured,
            options: Set<WelcomeScreenOption> = Set<WelcomeScreenOption>(),
            isDemoAvailable: Bool = true,
            @ViewBuilder footerText: () -> any View = { EmptyView() },
            componentIdentifier: String? = WelcomeScreen.identifier)

identifier
Undocumented
Declaration
Swift

static let identifier: String


                      
                      
                      init(title:description:icon:footnote:action:secondaryAction:illustratedMessage:headlineImage:inputText:legalText:isLegalAgreementRequired:showsIllustratedMessage:state:options:isDemoAvailable:footerText:)

Undocumented

Declaration

Swift

init(title: AttributedString,
     description: AttributedString? = nil,
     icon: Image? = nil,
     footnote: AttributedString? = nil,
     action: FioriButton? = nil,
     secondaryAction: FioriButton? = nil,
     illustratedMessage: IllustratedMessage? = nil,
     @ViewBuilder headlineImage: () -> any View = { EmptyView() },
     inputText: Binding<String>,
     legalText: AttributedString? = nil,
     isLegalAgreementRequired: Bool = false,
     showsIllustratedMessage: Bool = false,
     state: WelcomeScreenState = .notConfigured,
     options: Set<WelcomeScreenOption> = Set<WelcomeScreenOption>(),
     isDemoAvailable: Bool = true,
     footerText: AttributedString? = nil)


                      
                      
                      init(_:)

Undocumented

Declaration

Swift

init(_ configuration: WelcomeScreenConfiguration)

body
Declaration
Swift

public var body: some View { get }
isEmpty
Undocumented
Declaration
Swift

public var isEmpty: Bool { get }