Skip to content

Platform: MessageStripComponent Technical Design

Jump to bottom
kavya-b edited this page May 19, 2020 · 2 revisions

Message Strip Component

No development needed for platform library. The core library Message Strip fulfills all requirements.

Summary

The Message Strip Component is used to inform the user about select application statuses or events. The application developer will be able to craft their customized message in the alert component and display it as one of five alert types: 'information', 'warning', 'error', 'success', and 'default'. The Alert Component can be configured to be dismissed by user action or after a set duration.

i18n

Link to general support for i18n: Supporting internationalization in ngx/platform

Special Usecase: No

  • fd-message-strip message can be supported by using i18n marker:
<fd-message-strip i18n="@@dismissableMessageStrip" [type]="'warning'">
    A dismissible warning message strip.
</fd-message-strip>

Redesign Required: No

Questions

  • Does the core AlertComponent meet the needs of the FRD?
  • Are there restrictions on the content body of the alert?
    • There seem to be no restrictions on the content body, as the content within the Message Strip tags is projected into the body.

@Frank

  • Can render an alert from the code? Just passing text and type? (From Service)
    • Yes

Comments

@Manju

  1. This should be renamed to "Message Strip" as per Fiori.
  • done
  1. This should be reworked to match Fiori
  • done

As per fiori3 (properties) Property:showIcon – Allows you to display an icon before the text Property:customIcon – Allows you to display an icon from the icon library Property:type – Changes the semantic color and the icon in front of the message strip Property:text – Adds text to the control Property:link – Adds a link Property:showCloseButton – Adds a Close button

We don't need to adhere to the properties as described in the Fiori documentation, we only need to adhere to the visual and UX design guidelines. Component properties should be decided on by the individual component libraries not dictated via Fiori. For example, Property: text and Property: link should not be properties in the Fundamental NGX library, because we have chosen to use content projection; instead of Property: showCloseButton the Fundamental NGX Message Strip has dismissible.

Clone this wiki locally