EnterpriseDS Documentation

Classes

DSButton

An Enterprise-styled push button element. It includes properties for adding and positioning Enterprise icons as well as all normal UIButton functionality.

DSIcon​Button

An Anatomy-styled, icon-only push button element that displays a standard icon (DSIconRenderingType) as well as all normal UIButton functionality. No title text is allowed.

DSCheckbox

An Enterprise-styled push button element in the style of a checkbox. It includes properties for providing a label.

DSCheckbox​Table​View​Cell

A UITableViewCell that implements a DSCheckbox for easy usage.

DSSelection​Control

An abstract base component for selection controls. It should not be used externally.

DSToken​Catalog

An internal Token database, from the Enterprise tokening system, for getting all typography, colors, etc. The theme for an app can be changed by assigning a new theme.

DSDate​Picker

An Enterprise-styled date & time picker. This should be used when a user needs to select a date, time, or both a date and time.

DSDivider

An Enterprise-styled content horizontal divider for use outside of UITableView contexts.

DSIcon

An Enterprise-styled drop-in replacement for a UIImageView that displays a standard Enterprise icon (DSIconRenderingType).

DSIllustration

An Enterprise-styled drop-in replacement for a UIImageView that displays a standard Enterprise illustration (DSIllustrationRenderingType).

DSRadio

An Enterprise-styled push button element in the style of a radio button. It includes properties for providing a label.

DSRadio​Table​View​Cell

A UITableViewCell that implements a DSRadio for easy usage.

DSSelect​Option

Represents a valid option to be selected in a DSSelectTableViewCell.

DSSelect​Table​View​Cell

An Enterprise-styled option selection cell. This should be used when a user needs to select a value from a set of options. Only for use as a cell in UITableView.

DSSelect

An Enterprise-styled option selection. This should be used when a user needs to select a value from a set of options.

DSSwitch​Table​View​Cell

A UITableViewCell that implements a UISwitch and label.

DSCredit​Card​Input​Mask

An input mask, when assigned to a DSTextField, will enforce use of a number pad for text entry and format credit card numbers if it recognizes the brand of the card being entered. (e.g. Visa, Mastercard, etc.)

DSCurrency​Input​Mask

An input mask, when assigned to a DSTextField, will enforce use of a decimal pad for text entry and only allows digits and a decimal point (no more than one) to be entered.

DSEmail​Address​Input​Mask

An input mask, when assigned to a DSTextField, will enforce use of an email keyboard for text entry and prevents invalid typing of email addresses where possible.

DSMax​Text​Length​Input​Mask

An input mask, when assigned to a DSTextField, will enforce use of a maximum number of characters allowed.

DSNumber​Input​Mask

An input mask, when assigned to a DSTextField, will enforce use of a number pad for numeric entry where only digits are allowed.

DSPhone​Number​Input​Mask

An input mask, when assigned to a DSTextField, will enforce use of a number pad for text entry and allows only digits to be entered and formatted. Only 10-digit phone numbers are allowed.

DSText​Field

An Enterprise-styled text entry element. It includes properties for providing a placeholder label, helper text that sits below it that educates the user on what text to enter, and DSInputMask and DSValidationRule rules which will determine user input format and display errors when validations failed.

Structures

DSAdHoc​Validation​Rule

A validation rule that allows for an error message to be expressly set. When the message is non-empty, the validation fails. This validation rule is useful for showing backend errors.

DSCredit​Card​Validation​Rule

A validation rule for requiring that a credit card number matches a legal format as much as possible.

DSCurrency​Validation​Rule

A validation rule for requiring a valid currency is entered.

DSEmail​Address​Validation​Rule

A validation rule for email addresses. Returns an error when a proper email address has not been formed. Does not verify that an email address exists, only that it's legal.

DSMax​Text​Length​Validation​Rule

A validation rule for capping the length of the text to a maximum amount.

DSMin​Max​Validation​Rule

A validation rule for requiring that text is a number and is between a min and max value. (Inclusive.)

DSNumber​Validation​Rule

A validation rule for requiring that only digits are entered.

DSPhone​Number​Validation​Rule

A validation rule for requiring text to be a phone number of format XXX-XXX-XXXX.

DSRequired​Text​Validation​Rule

A validation rule for requiring that text exists and is not an empty string. This is the only validation rule that enforces it and you should add it to your other validations to check for empty states. Other validations will only fire if data exists.

DSDate​Picker​Control​Options

Captures a set of options for DSDatePicker that are wanted on the internal UIDatePicker instance. Each property, if provided, will be set internally.

DSCredit​Card

A credit card that identifies properties of various brand types, performs validation, and can perform formatting of their numbers.

DSUIButton

An Enterprise-styled push button element for use in SwiftUI. Enterprise icons as well as all normal SwiftUI Button functionality.

DSUICheckbox

An Enterprise-styled push button element in the style of a checkbox for use in SwiftUI views.

DSUIDate​Picker

An Enterprise-styled date & time picker. This should be used when a user needs to select a date, time, or both a date and time.

DSUIDivider

An Enterprise-styled content horizontal divider for use in SwiftUI views.

DSUIIcon

An Enterprise-styled drop-in replacement for a SwiftUI Image that displays a standard Enterprise icon (DSIconRenderingType).

DSUIRadio

An Enterprise-styled push button element in the style of a radio button for use in SwiftUI views.

DSUIRadio​Group

A component for creating a group of DSUIRadio components.

DSUISelect​Cell

An Enterprise-styled option selection element for use in SwiftUI views.

DSUISwitch​Cell

An Enterprise-styled option selection element for use in SwiftUI views.

DSUIText​Field

An Enterprise-styled text entry element for use in SwiftUI views. It provides a placeholder label, helper text that sits below it that educates the user on what text to enter, and DSInputMask and DSValidationRule rules which will determine user input format and display errors when validations failed.

DSUIFont​Rendering​Type​Style

An Enterprise-based view modifier for a SwiftUI Text.

Enumerations

DSButton​Image​Location​Type

A type that defines the rendering font that a DSButton control should use.

DSButton​Rendering​Type

A type that defines the rendering font that a DSButton control should use.

DSDate​Picker​Date​Type
DSText​Field​Rendering​Type

A type that defines the rendering font that a DSTextField control should use.

DSToken​Catalog​Theme

A theme style for the internal DSTokenCatalog.

DSValue​Validation​State

A type that defines a validation status. If the validation is invalid, one offending DSValidationRule is included as part of the value.

DSCredit​Card​Type

The various brands of credit card.

DSFont​Rendering​Type

A type that defines the rendering font that a generic Enterprise control should use.

DSIcon​Rendering​Size

A type that defines the rendering size of a DSIcon.

DSIcon​Rendering​Type

A type that defines the rendering image that defined the appearance of DSIcon.

DSIllustration​Rendering​Size

A type that defines the rendering size of an DSIllustration.

DSIllustration​Rendering​Type

A type that defines the rendering image that defined the appearance of DSIllustration.

Protocols

DSCheckbox​Delegate

A delegate that is notified of various events that occur from DSCheckbox.

DSValidation​Rule

A validation framework for defining how text entered into a DSTextField can be validated and an appropriate error message provided if that validation fails. Multiple DSValidationRule objects can stack to perform multiple validations including the special DSRequiredTextValidationRule which is the only built-in rule validates empty fields.

DSDate​Picker​Delegate

A delegate that is notified of various events that occur from DSDatePicker.

DSRadio​Delegate

A delegate that is notified of various events that occur from DSRadio.

DSSelect​Control

A protocol extension for select controls.

DSSelect​Table​View​Cell​Delegate

A delegate that is notified of various events that occur from DSSelectTableViewCell.

DSSelect​Delegate

A delegate that is notified of various events that occur from DSSelect.

DSSwitch​Table​View​Cell​Delegate

A delegate that is notified of various events that occur from DSSwitchTableViewCell.

DSInput​Mask

A masking object that controls what can be legally typed into a DSTextField and handles type formatting while that typing takes place. They do not validate but often "partner" up with validation rules.

DSText​Field​Delegate

A delegate that is notified of various events that occur from DSTextField. Extends UITextViewDelegate and UITextFieldDelegate so all of those methods can be defined as well.

Typealiases

DSUISelection​Group​Item

A type used with DSUIRadioGroup component.

Extensions

Color
Font
UIColor
UIFont
UIImage
View