BP Conclusion
BP Conclusion summarizes user progress or completion of a business process.
Usage Guidance
Coming soon!
API Guidelines
Methods
Class name: ConclusionScreen Module name: UIComponentsPlugin
public init(
featureData: FeatureMetricsData,
context: SemanticContext = .default,
accentImage: AccentImage,
header: HeaderConfig,
banner: ConclusionBannerConfig? = nil,
upNextCard: UpNextCardData? = nil,
actionButton: ActionButtonData? = nil,
additionalActionButton: ActionButtonData? = nil,
viewDetailsButtonAction: @escaping (() -> Void) = nil,
localizer: LocalizationAdapting
)Parameters
| Name | Description | Default values |
|---|---|---|
| featureData | the feature name/context and the screen ID in which the component appears. | |
| context | the SemanticContext. | SemanticContext.default |
| accentImage | An icon that Indicates if the BP action was completed, denied, or canceled. | |
| header | Show the Description of the action just taken and the details the business object and the BP workflow status | |
| banner | Shown when the BP action has been successful, but the API call has returned validation errors after the fact. | nil |
| upNextCard | Provides information about the next step in the BP, and link to who it is assigned to. | nil |
| actionButton | Button that appears ONLY if the ‘Up Next’ is assigned to the user who just completed the task to continue to the next step. | nil |
| additionalActionButton | Same as actionButton. Style must be .secondary. | nil |
| viewDetailsButtonAction | Closure to the entry point view of the full conclusion page and process related to their task. | |
| localizer | Localizer used for localizing strings in the view. |
Supporting Types
enum AccentImage: Equatable {
case minus
case checkmark
case exclamation
}
```swift
struct HeaderConfig {
init(title: String, subtitle: String)
}struct ConclusionBannerConfig: Hashable {
init(
title: String,
imageName: String,
bannerItemConfigs: [ConclusionBannerItemConfig],
context: SemanticContext
) {
self.title = title
self.imageName = imageName
self.bannerItemConfigs = bannerItemConfigs
self.context = context
}
}struct ConclusionBannerItemConfig: Hashable, Identifiable {
init(bannerItemsIndex: String, title: String, description: String?) {
self.bannersItemsIndex = bannerItemsIndex
self.title = title
self.description = description
}
}struct UpNextCardData {
init(
imageName: String,
workerName: String,
task: String,
dueDate: String
) {
self.imageName = imageName
self.workerName = workerName
self.task = task
self.dueDate = dueDate
}
}public struct ActionButtonData {
init(label: String, style: ActionButtonStyle = .primary, onTapAction: @escaping (() -> Void)) {
self.label = label
self.style = style
self.onTapAction = onTapAction
}
}enum ActionButtonStyle: String {
case primary = "Primary"
case secondary = "Secondary"
}Accessibility Guidelines
Coming soon!
Usage Guidance
Coming soon!
API Guidelines
Methods
fun BPConclusionUiComponent(
modifier: Modifier = Modifier,
header: ConclusionHeader,
alertContainer: AlertContainer? = null,
actionButton: ActionButton? = null,
additionalActionButton: ActionButton? = null,
upNextCardDetails: UpNextCardDetails? = null,
onViewDetailsButtonClick: (() -> Unit)? = {},
onCloseButtonClick: (() -> Unit) = {}
)Parameters
| Name | Description | Default values |
|---|---|---|
| modifier | The modifier to be applied to the component. | Modifier |
| header | The header [ConclusionHeader] for the conclusion page specifying title, subtitle and status icon[IconType]. | |
| alertContainer | Optional. Container for any errors or warnings [AlertContainer]. | null |
| actionButton | Optional. Button to perform an action [ActionButton]. | null |
| additionalActionButton | Optional. Additional button to perform an action [ActionButton]. | null |
| upNextCardDetails | Optional. Values for up next card [UpNextCard]. | null |
| onViewDetailsButtonClick | onClick listener for view Details button. | |
| onCloseButtonClick | onClick listener for close button. See [BpConclusionFragment] for usage. |
Accessibility Guidelines
Coming soon!
Can't Find What You Need?
Check out our FAQ section which may help you find the information you're looking for. For further information, contact the #ask-canvas-design or #ask-canvas-kitchannels on Slack.