User Interface Scheme¶

The User Interface Scheme defines the configuration options for the presentation style, swipe-to-dismiss policy, and theme settings of the SDK's UI components.

User Interface¶

UserInterface {
  presentationStyle: PresentationStyle
  swipeToDismiss: SwipeToDismissPolicy
  theme: Theme // (1)!
}

1. Specifies the theme configuration settings that determine the appearance and style of the UI components within the SDK. This includes defining color schemes, typography, and other visual elements to ensure a cohesive and customizable user interface experience.

PresentationStyle¶

enum PresentationStyle {
  fullScreen // (1)!
  bottomSheet // (2)!
  pageSheet // (3)!
}

1. Presents the SDK in full-screen mode. This style occupies the entire screen, hiding the parent view completely.

2. Opens the SDK in a bottom sheet.

   Partial iOS support

   This mode is supported on iOS from version 16 onwards. For older versions, it defaults to pageSheet. Unlike pageSheet, the parent view remains fullscreen but is covered by the sheet, rather than being stacked behind it.

3. The SDK appears in a page sheet, which partially covers the parent view, allowing users to see some of the underlying content while interacting with the SDK. Unlike a bottomSheet, which keeps parent view fullscreen, a page sheet stacking the parent view behind, slightly shrinking and moving it away from the screen edges.

   • This mode is recommended starting from iOS 13. For more information, refer to Best practices from Apple's HIG .
   • On Android, this mode behaves as a bottomSheet.

SwipeToDismissPolicy¶

enum SwipeToDismissPolicy {
  allowAlways // (1)!
  allowHeaderSwipeOnly // (2)!
  protectTheNecessaryPages // (3)!
}

1. Allows the SDK to be dismissed at any time by swiping down anywhere on the screen.

   This policy provides the most flexibility for users, enabling them to close the SDK from any page or context.

2. Restricts dismissal to swiping down on the header area only.

   This policy limits the swipe-to-dismiss gesture to the header area, reducing the likelihood of accidental dismissals.

3. Applies different swipe-to-dismiss policies based on the page context.

   • On pages that are safe to close, such as onboarding or photo picker pages, the allowAlways policy is applied, allowing dismissal from anywhere on the screen.
   • On critical pages, such as those waiting for generation or displaying results, the allowHeaderSwipeOnly policy is applied to prevent accidental dismissals.

   This policy provides a balance between user convenience and protecting critical workflows, ensuring that users can dismiss the SDK when appropriate while safeguarding important pages.