FormField

A wrapper component which support UIView components with label and helper message (Success/Info/Error management).

Specifications

The formfield specifications on Zeroheight is here.

Usage

FormField is available on UIKit and SwiftUI.

FormFieldUIView

Parameters:

• theme: The current Spark-Theme. You can always define your own theme.
• component: The component (UIView) is covered by formfield.
• feedbackState: The formfield feedback state. 'Default' or 'Error'.(There aren't design changes for Success and Info states. They will be managed with 'Default')
• title: An option string. The title is rendered above the component.
• attributedTitle: An option attributed string to change label of font or size.
• helper: An option string. The title is rendered under the component.
• attributedDescription: An option attributed string to change helper message of font or size.
• isTitleRequired: A bool value to add asterisk character at the end of title for specifying required field.
• isEnabled: A bool value to change wrapped component enabled state
• isSelected: A bool value to change wrapped component selected state

Subviews

The FormField contains some public subviews :

• titleLabel: The title label of the input. The label is positioned at the top left.
• helperLabel: The helper label of the input. The label is positioned at the bottom left.
• secondaryHelperLabel: The secondary helper label of the input. The label is positioned at the bottom right.

Functions:

If the component inside the FormField is inherit from an UITextInput (The Spark TextField and TextEditor for example), a function to set the number of the characters is available:

func setCounter(on text: String?, limit: Int?)

FormFieldView

Parameters:

• theme: The current Spark-Theme. You can always define your own theme.
• component: The component (UIView) is covered by formfield.
• feedbackState: The formfield feedback state. 'Default' or 'Error'.(There aren't design changes for Success and Info states. They will be managed with 'Default')
• title: An option string. The title is rendered above the component.
• attributedTitle: An option attributed string to change label of font or size.
• helper: An option string. The title is rendered under the component.
• attributedDescription: An option attributed string to change helper message of font or size.
• isTitleRequired: A bool value to add asterisk character at the end of title for specifying required field.

Examples

FormFieldUIView

let component: UIView = CheckboxUIView(
   theme: SparkTheme.shared,
   text: "Hello World",
   checkedImage: DemoIconography.shared.checkmark.uiImage,
   selectionState: .unselected,
   alignment: .left
)

let formfield = FormFieldUIView(
   theme: SparkTheme.shared,
   component: self.component,
   feedbackState: .default,
   title: "Agreement",
   helper: "Your agreement is important to us."
)

view.addSubview(formfield)

NSLayoutConstraint.activate([
  formfield.leadingAnchor.constraint(equalTo: view.leadingAnchor),
  formfield.trailingAnchor.constraint(equalTo: view.trailingAnchor),
  formfield.topAnchor.constraint(equalTo: view.topAnchor),
  formfield.bottomAnchor.constraint(equalTo: view.bottomAnchor)
])

FormFieldView

var component: some View {
   CheckboxView(
      text: "Hello World",
      checkedImage: DemoIconography.shared.checkmark.image,
      theme: SparkTheme.shared,
      intent: .success,
      selectionState: .constant(.selected)
   )
}

var body: some View {
    FormFieldView(
       theme: SparkTheme.shared,
       component: {
          self.component
       },
       feedbackState: .default,
       title: "Agreement",
       helper: "Your agreement is important to us.",
       isTitleRequired: false
    )
   .disabled(false)
}

License

MIT License

Copyright (c) 2024 Adevinta

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.