furo-ui5-notification-list-display

furo-ui5-notification-list-display #

@furo/ui5 v1.18.0
import '@furo/ui5/src/furo-ui5-notification-list-display.js';
exports FuroUi5NotificationListDisplay js
exports <furo-ui5-notification-list-display> custom-element-definition
superclass LitElement
mixes FBP

Summary: ui5 notification list

Description #

Notification display component that works together with furo-ui5-notification. Displays google.rpc.Status messages in a grouped list. https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto.

Best place the furo-ui5-notification-list-display on the main site. then you only need one furo-ui5-notification-list-display. you can also use more than one furo-ui5-notification-list-display for special needs. But you have to be sure the furo-ui5-notification-list-display can receive the notification events from furo-ui5-notification.

Example #

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

github.com/googleapis/…

1
2
3
4
5
6
7
8
9

<furo-ui5-notification-list-display 
  header-text="Notifications &amp; Errors" 
  fn-clear-all="--clearRequested" 
  group-title-message="Localized Messages" 
  group-title-help="Helpful information" 
  group-title-bad-request="Field Violations" 
  @-notification-counter-update="--ncUpdated"></furo-ui5-notification-list-display>
<furo-ui5-notification 
  fn-parse-grpc-status="--grpcStatus"></furo-ui5-notification>

Attributes and Properties #

headerText #

header-text string default: ''

the header text of the notification

noDataText #

no-data-text string default: 'No messages'

Defines the text that is displayed when the list contains no items.

_notificationCount #

default: 0



groupTitleHelp #

group-title-help string default: 'Help'

Defines the notification group element title for notifications of type “type.googleapis.com/google.rpc.Help”

groupTitleBadRequest #

group-title-bad-request string default: 'Bad Request'

Defines the notification group element title for notifications of type “type.googleapis.com/google.rpc.BadRequest”

groupTitleMessage #

group-title-message string default: 'Information'

Defines the notification group element title for notifications of type “type.googleapis.com/google.rpc.LocalizedMessage”

_md #



showClose #

show-close Boolean

Defines if the close button would be displayed.

Events #

notification-counter-update #

at-notification-counter-update → CustomEvent



furo-value-changed #

at-furo-value-changed → Number

Fires a notification counter changed. Use this event to show the amount of notifications to the user.

Methods #

parseGrpcStatus #

parseGrpcStatus(d `` ) ⟹ void

`` → fn-parse-grpc-status

parse grpc status object and set the notification text according to the LocalizedMessage in status. https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto.

  • d

parseNotificationMessage #

parseNotificationMessage(message `` ) ⟹ void

`` → fn-parse-notification-message

parse notification message and set the ui5 notification properties like priority, actions, heading.. the notification message should be a furo.notification type: { “id”: 1, “display_name”: “”, “heading”: “heading 1”, “message_priority”: “High”, “category”: “warning”, “category_priority”: “High”, “actions”: [ { “icon”:“accept”, “command”:“accept”, “text”: “accept” }, { “icon”:“message-error”, “command”:“reject”, “text”: “Reject” } ], “message”: “Markdown | Less | Pretty\n— | — | —\nStill | renders | nicely\n1 | 2 | 3” }

  • message

_show #

_show() ⟹ void

* → fn–show

shows grpc status notifications implemented types are:

  • Bad Request with Field Violations



_dispatchNotificationCounterUpdates #

_dispatchNotificationCounterUpdates(count `` ) ⟹ void

`` → fn–dispatch-notification-counter-updates

  • count

clearAll #

clearAll() ⟹ void

* → fn-clear-all

clear all notifications