CreationKit Documentation

Classes

Component

Generic UIView type that uses a ComponentLayout

Table​View​Component

Generic UITableViewCell type that uses a ComponentLayout

Collection​View​Component

Generic UICollectionViewCell type that uses a ComponentLayout

Accordion​Data​Model
Activity​Indicator

ActivityIndicators express an unspecified wait time or display the length of a process.

Activity​Indicator​Custom​Text

ActivityIndicatorCustomText expresses an unspecified wait time or displays the length of a process.

Network​Activity​Indicator

A replacement for the systems deprecated network activity indicator. Ensure to call NetworkActivityIndicator.configure() when your app starts to properly track status bar tint changes.

Availability​Banner​Layout
Avatar

Avatars are used to quickly identify users. When an image isn’t available, initials are used instead.

Avatar​Group

A group of Avatars

Badge

Badges are small status descriptors for UI elements. A badge consists of a small circle (or racetrack shape), typically containing a number that appears in proximity to another object.

Banner

A banner displays a prominent message and related optional actions.

Action

An action that can be taken when the user taps a button.

Actions​Layout
Checkbox​Action​Layout

A layout that contains a Checkbox and a label.

Swift​UIHosted​View
Swift​UIHosted​View​Factory
Title​Layout
Vertical​Centered​Image​Text​Layout
Button

A control that executes your custom code in response to user interactions.

Card

Cards contain content and tasks about a single subject to make it easier to scan, read, and take action.

Card​Error​Layout
Card​Header​Layout
Awareness​Card​Header.​Configuration
Upcoming​Visit​Card​Header.​Configuration
Checkbox

A checkbox view that can be toggled on or off.

Checkbox​Layout

The ComponentLayout to make a Checkbox. You usually won't need to use this directly, prefer to use Checkbox instead.

Chip

Chips are compact elements that allow users to enter, make selections, filter content, or trigger actions.

Chip​Layout
Conversation​Starter​Layout
Day​Collection​View​Cell
Day​Cell​Layout

A layout for day cells in a DatePicker

Date​Picker

Date pickers let users select a date, or a range of dates. DatePickers are created with a configuration.

Divider

Divider is a line that groups content in lists and layouts.

Form​Configuration.​Date​Input​Configuration
Form​View​Controller

A ViewController that displays FormItems.

Date​Input​Form​Layout

A LabelInputFormLayout subclass that uses a DateInputFormLayout for user input.

Label​Input​Form​Layout

A layout used in forms for gathering input from a user.

Ranged​Date​Input​Form​Layout

A LabelInputFormLayout subclass that uses a DateInputFormLayout for user input. This is similar to the DateInputFormLayout, but is used in cases where the use needs Ranged Selected on the DatePicker.

Sheet​Input​Form​Layout

A LabelInputFormLayout subclass that uses a BottomSheet for user input.

Text​Input​Form​Layout

A layout used in forms for gathering text input from a user.

Input​Field

An InputField is a view where a user can input text. This type is generic to allow multiple types of inputs, such as from a textfield with a keyboard, or a a simple label with an action sheet. This type shouldn't generally be used directly. You should prefer to use one of it's subclasses.

Placeholder​Label

A UILabel that updates it self to display as a placeholder when it's text property is nil.

Placeholder​Text​Field

A UITextField that updates it self to display as a placeholder when it's text property is nil.

Text​Field​Input

An InputField generic over a PlaceholderTextField.

Label​Input

An InputField generic over a PlaceholderLabel.

Static​Input​Field​Layout

A layout for static input fields for Forms.

Avatar​List​Cell​Layout
List​Cell​Layout
List​Cell​Right​Image​Layout
Failed​Message

Insert this MessageType when a message fails to send.

Messages​Date​Formatter

A helper class with a contained DateFormatter that formats dates for the MessagesViewController.

Messages​Header​Layout

A header for MessagesViewController. This could possible be placed elsewhere, but it's main design is made to be placed in a MessagesViewController as a header.

Messages​View​Controller

A ViewController subclass for displaying conversation interfaces.

Handle

A Handle for a BottomSheet.

Modal​Dialog

Use this class to configure alerts with the message that you want to display and the actions from which to choose. After configuring the dialog with the actions and style you want, present it using the present(_:animated:, completion:) method. CreationKit displays dialogs modally over your app's content.

Modal​Dialog​Action

An action that can be taken when the user taps a button in a ModalDialog.

Progress​Indicator

ProgressIndicators express an unspecified wait time or display the length of a process.

Ratings

Ratings provide insight regarding others’ opinions and experiences with providers and facilities.

Scrim

Scrims are temporary treatments that can be applied to Material surfaces for the purpose of making content on a surface less prominent. They help direct user attention to other parts of the screen, away from the surface receiving a scrim.

Snackbar

Snackbars inform users of a process that an app has performed or will perform.

Scrollable​Stack.​Cell

A view that wraps every row in a ScrollableStack

Scrollable​Stack
Tab​View​Layout
Tag​Layout
Tag
JTApple​Cell

The JTAppleDayCell class defines the attributes and behavior of the cells that appear in JTAppleCalendarMonthView objects.

JTACDay​Cell
JTACMonth​Cell
JTACCell​Month​View
JTApple​Collection​Reusable​View

The header view class of the calendar

JTACMonth​Reusable​View
JTApple​Calendar​View

An instance of JTAppleCalendarMonthView (or simply, a calendar view) is a means for displaying and interacting with a gridstyle layout of date-cells

JTACMonth​View
JTACYear​View
Color​Manager

Colors from the design system.

Color​Provider

Conforming types from CreationKit that can be used for theming purposes. You should not use this type directly.

Blue

A blue ColorProvider

Gray

A gray ColorProvider

Green

A green ColorProvider

Red

A red ColorProvider

Yellow

A yellow ColorProvider

Teal

A teal ColorProvider

Purple

A purple ColorProvider

Pink

A pink ColorProvider

Font​Manager

Used to set the font used throughout CreationKit.

Image​Picker​Manager
Location​Manager

A general LocationManger

Structures

Accordion
Non​Scrollable​Accordion
Accordion​Container
Accordion​Row​Content
Accordion​Content
Accordion​Header
AHActivity​Indicator
Avatar.​Configuration
Card​Header​Configuration

A struct to configure CardHeaders with.

Awareness​Card​Header
AHCard
ToDoCard​Header
ToDoCell
Upcoming​Visit​Card​Content
Upcoming​Visit​Card​Header
Carousel​Configuration
Conversation​Starter.​Configuration
Date​Picker​Configuration

A configuration object for setting up a DatePicker.

Form​Configuration

A type to configure a FormViewController.

Form​Configuration.​Text​Input​Configuration
Form​Builder
Sheet​Input​Form​Configuration

The configuration for the BottomSheet that SheetInputFormLayout will use.

Image​View​Configuration
Right​Image​View​Configuration
Image​Media​Item

A MediaItem for images

Image​Message

Used in a MessagesViewController when it needs to show an image based message.

Coordinate​Item

A LocationItem type

Location​Message

Used in a MessagesViewController when it needs to show a location based message.

System​Message

Use this MessageType when the Sender is a SystemSender

System​Sender

Use this Sender when messages are sent by the "system".

Text​Message

Used in a MessagesViewController when it needs to show a text based message.

Text​With​Attachments​Message

Use this MessageType to render a message that contains text and attachments

Attachment​Message

Use this MessageType to render an attachment The MessageAttachment associated with this message should have a unique ID to track loading states on slow networks.

Message​Attachment
Messages​Header​Layout.​Configuration
Messages​View​Controller.​Avatar​Options

Used to enable/disable the avatar on either side.

Tab​View​Layout.​Configuration

The configuration for each tab

UIControl.​Event​Publisher
Image​Asset
Cell​State

Describes which month the cell belongs to

Configuration​Parameters

Defines the parameters which configures the calendar.

Month​Size
Month

Defines a month structure.

Date​Segment​Info

Contains the information for visible dates of the calendar.

Montserrat​Scaled

Enumerations

Activity​Indicator.​Style

The styles ActivityIndicator supports.

Activity​Indicator​Custom​Text.​Style
AHActivity​Indicator.​Style
Avatar.​Size

Defines standard sizes for Avatar items in the design system Standard values are as follows. A .custom case exists for passing an arbitrary value.

Badge.​Category

Each style takes a value (Int) to be displayed

Action.​Style

Styles to apply to action buttons.

Lateral​Direction
Button.​Style

The style of the Button.

Card.​State

The state of the card.

AHCard.​States

The state of the card

Carousel
Chip.​Style

An enum representing default color styles for Chip components

Day​Cell​Layout.​State
Divider.​Style

Styles of the Divider

Form​Configuration.​Action​Button​Style

Styles that the Form can support.

Validity

A type used to tell if something is valid or not. FormViewController uses this within it's FormItems validator return value to know if a field is valid or not.

Form​Item

An item that can be placed in a Form.

Sheet​Input​Form​Layout.​Accessory​State
Input​Field​State
Mask

Defines all the types of input masks that CreationKit supports for input fields. There is also a custom case incase you need to provide your own custom mask that isn't supported already by CreationKit.

System​Message.​Style

The style of the SystemMessage.

Messages​Header​Layout.​Configuration.​Avatar​Requirement
Messages​View​Controller.​Attachment​Options

Used to enable/disable the attachment types you want to support for sending.

Modal​Dialog.​Style

The style of the modal dialog.

Modal​Dialog​Action.​Style

Styles to apply to action buttons in a dialog.

Progress​Indicator.​Style

The styles ProgressIndicator supports.

Scrollable​Stack.​Errors
Image​Quality
Asset
Asset.​Action
Asset.​Communication
Asset.​Content
Asset.​File
Asset.​Finance
Asset.​Health
Asset.​Map
Asset.​Mobile​Nav
Asset.​Navigation
Asset.​Notification
Asset.​Placeholder
Asset.​Social
Asset.​Internal
Segment​Destination

Describes a scroll destination

Out​Date​Cell​Generation

Describes the types of out-date cells to be generated.

InDate​Cell​Generation

Describes the types of out-date cells to be generated.

Reading​Orientation

Describes the calendar reading direction Useful for regions that read text from right to left

Scrolling​Mode

Configures the behavior of the scrolling mode of the calendar

Date​Owner

Describes which month owns the date

Months​OfYear

Months of the year

Selection​Range​Position

Selection position of a range-selected date cell

Range​Selection​Mode

Between month segments, the range selection can either be visually disconnected or connected

Selection​Type

Signifies whether or not a selection was done programatically or by the user

Days​OfWeek

Days of the week. By setting your calendar's first day of the week, you can change which day is the first for the week. Sunday is the default value.

Banner​Duration

A type used by Snackbar and Banner to decide durations.

Banner​Style

A type used by Banner and Snackbar to dictate styling

Font.​Montserrat
UIFont.​Montserrat
Location​Manager.​Errors

Errors that can occur in the LocationManager.

Protocols

Component​Layout

A protocol to share components (view layouts) across different types.

Banner​Viewable
Text​Inputable

A protocol that is used by InputField to manage the text and placeholder of an input field.

JTACCell​Month​View​Delegate
JTApple​Calendar​View​Data​Source

The JTAppleCalendarMonthViewDataSource protocol is adopted by an object that mediates the application’™s data model for a the JTAppleCalendarMonthViewDataSource object. data source provides the the calendar-view object with the information it needs to construct and then modify it self

JTACMonth​View​Data​Source
JTApple​Calendar​View​Delegate

The delegate of a JTAppleCalendarMonthView object must adopt the JTAppleCalendarMonthViewDelegate protocol Optional methods of the protocol allow the delegate to manage selections, and configure the cells

JTACMonth​View​Delegate
JTACYear​View​Delegate
JTACYear​View​Data​Source

Typealiases

Availability​Banner
Banner​Presentation​Context
Banner​View
Banner​Tap​View
Vertical​Centered​Image​Text​Content
Card​Header
Conversation​Starter
InDate​Generation
Out​Date​Generation
Affinity​Calculation​Strategy
Static​Input​Field

A Component where it's Layout is a StaticInputFieldLayout

Message​Type

A standard protocol representing a message. Use this protocol to create your own message objects.

Sender

A standard protocol representing a sender. Use this protocol to adhere an object as the sender of a MessageType.

Message​Kind

An enum representing the kind of message and its underlying kind.

Avatar​Configuration

An object used to group the information to be used by an AvatarView.

Message​Avatar

An view backed by AvatarConfiguration representing a user in a message thread

Media​Item

A protocol used to represent the data for a media message.

Location​Item

A protocol used to represent the data for a location message.

Audio​Item

A protocol used to represent the data for an audio message.

Snackbar​Presentation​Context
Tab

Tabs organize content across different screens, data sets, and other interactions.

Variables

kLabel​Input​Field​Default​Placeholder
kText​Input​Field​Default​Placeholder

Extensions

ConversationStarter
Font
ImageAsset.Image
NSAttributedString.Key
Tab
UIButton
UIColor
UIControl
UIFont
UILabel
UILongPressGestureRecognizer
UIPanGestureRecognizer
UIPinchGestureRecognizer
UIRotationGestureRecognizer
UISwipeGestureRecognizer
UITapGestureRecognizer
UITextField
View