Skip to content

Configuration

Mathis Le Bonniec edited this page May 20, 2024 · 7 revisions

OnBoarding protocol

This protocol refers to the main configuration of the OnBoarding view. It contains all the elements that'll be displayed on the view.
To create an on boarding view, you've to create a struct that conforms to the OnBoarding protocol.

Property Type Optional Default value Description
image ImageStyle Yes nil The top image, usually the application icon, or a banner.
title Text No - The main title of the view.
description Text Yes nil A small text describing the your application.
features [Feature] Yes [] A list of features available in your application.
notice Notice Yes nil The bottom text notice.
button Text No - The text inside the bottom button.

ImageStyle enum

This enum refers to the style of the image. Values contains one or two parameters, for the image and a potential aspect ratio.

Property Description
appIcon The icon of the current application.
icon(Image) An image with an icon format.
banner(Image, CGFloat? = 1.1) A full width image with an optional aspect ratio.

Feature struct

This struct represent a row in the features list.

Property Type Optional Default value Description
image Image Yes nil The icon on the left side of the text.
label Text Yes nil A bold text representing the feature title.
description Text No - The feature text description.

Notice struct

This struct represent the bottom notice just on top of the button.

Property Type Optional Default value Description
icon Image Yes nil The icon on the top of the text.
text Text No - The notice text.
link Notice Yes nil The redirection link.

Link struct

This struct represent the bottom notice link.

Property Type Optional Default value Description
title Text No - The url display text.
url URL Yes nil The redirection URL. Note that the property is optional only to allow you to use the URL?(String) constructor
Clone this wiki locally