Skip to content

Commit 45e27e0

Browse files
committed
feat: 🎸 [JIRA:HCPSDKFIORIUIKIT-2686] document public declarations
1 parent 3b1bca1 commit 45e27e0

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

Diff for: Sources/FioriSwiftUICore/FioriButton/FioriButton.swift

+9-5
Original file line numberDiff line numberDiff line change
@@ -217,11 +217,15 @@ public enum FioriButtonLoadingState {
217217
case success
218218
}
219219

220-
/// image position related to the title
220+
/// Place the image along the top, leading, bottom, or trailing edge of the button.
221221
public enum FioriButtonImagePosition {
222+
/// place the image along the top edge of the button.
222223
case top
224+
/// place the image along the leading edge of the button.
223225
case leading
226+
/// place the image along the bottom edge of the button.
224227
case bottom
228+
/// place the image along the trailing edge of the button.
225229
case trailing
226230
}
227231

@@ -232,10 +236,10 @@ public extension FioriButton {
232236
/// - isSelectionPersistent: A boolean value determines whether the button should be persistent or not.
233237
/// - action: Action triggered when tap on button.
234238
/// - title: A closure that returns a title text for each state. For a button with non-persistent selection, `.normal`, `.disabled`, `.highlighted` are supported. For a button with persistent selection, use `.selected` instead of `.highlighted`.
235-
/// - image: image of the button when loading state is .unspecified
236-
/// - loadingState: A state to show activity indicator or success icon, default is .unspecified
237-
/// - imagePosition: image position related to the title
238-
/// - imageTitleSpacing: spacing between image and title
239+
/// - image: image of the button when loading state is .unspecified.
240+
/// - loadingState: A state to show activity indicator or success icon, default is .unspecified.
241+
/// - imagePosition: Place the image along the top, leading, bottom, or trailing edge of the button.
242+
/// - imageTitleSpacing: spacing between image and title.
239243
init(isSelectionPersistent: Bool = false,
240244
action: ((UIControl.State) -> Void)? = nil,
241245
title: ((UIControl.State) -> AttributedString)? = nil,

0 commit comments

Comments
 (0)