Snackbar Api

Snackbar Api

Open Notification by Template

Special Parameter

• keepOpenUntilDismissOrDuration: force snackbar to stay open. if true, the snackbar will be kept open until it is dismissed or the duration is reached. If false, the snackbar will be closed after the duration is reached or another snackbar got opnened.
• duration: undefined: the duration of the snackbar in milliseconds. If set to duration: undefined, the snackbar will be kept open until it is dismissed or another snackbar is opened
• keepTrack if true, the snackbar will be kept in the snackbar service and can be closed later. If false, the snackbar will be removed from the snackbar service after it is closed.

How to Open

const { snackbarApi } = fyzUtils;
snackbarApi.openNotification('Hallo Welt!', {
    template: 'warning',
    variation: 'full',
    ... // customize the template
});

Variations

1. Minimal minimal

3. Action Only actionOnly

5. Headline Only headlineOnly

7. Indicator Only indicatorOnly

8. Action Headline actionHeadline

9. Action Indicator actionIndicator

10. Headline Indicator headlineIndicator

11. Full full

Templates

1. Neutral neutral

Default Variation is headlineIndicator

3. Info info

Default Variation is headlineIndicator

4. Warning warning

Default Variation is headlineIndicator

5. Error error

Default Variation is headlineIndicator

6. Success success

Default Variation is headlineIndicator

7. System Alarm systemAlarm

Default Variation is headlineIndicator

8. Notice notice

Default Variation is headlineIndicator

9. Acknoledgement Request acknowledgementRequest

• Default Variation is full
• Location: Bottom Center
• keepOpenUntilDismissOrDuration: true // keeps the snackbar open, even a new snackar opened
• duration: undefined // keeps the snackbar open
• keepTrack: false // do not track closeAll() has no effect
• closeShow: true

10. Critical Alarm criticalAlarm

Default Variation is full

• Location: Bottom Center
• keepOpenUntilDismissOrDuration: true // keeps the snackbar open, even a new snackar opened
• duration: undefined // keeps the snackbar open
• closeShow: true

11. Safety Alarm safetyAlarm

Default Variation is headlineIndicator

12. Environmental Alarm environmentalAlarm

Default Variation is headlineIndicator

13. Production Alarm productionAlarm

Default Variation is headlineIndicator

14. Diagonstic Alarm diagnosticAlarm

Default Variation is headlineIndicator

15. Communication Alarm communicationAlarm

Default Variation is headlineIndicator

16. Energy Alarm energyAlarm

Default Variation is headlineIndicator

17. Tampering Alarm tamperingAlarm

Default Variation is headlineIndicator

18. State Change Alarm stateChangeAlarm

Default Variation is headlineIndicator

19. Limit Exceedance Alarm limitExceedanceAlarm

Default Variation is headlineIndicator

20. Maintenance Alarm maintenanceAlarm

• Location: Bottom Center
• Default Variation is full
• keepOpenUntilDismissOrDuration: true // keeps the snackbar open, even a new snackar opened
• duration: undefined // keeps the snackbar open
• closeShow: true

How to Catch a Result

const { snackbarApi } = fyzUtils;
const result = snackbarApi.openNotification('Hallo Welt!', {
    template: 'warning',
    variation: 'full',
    ... // customize the template
}).result$;

result.pipe(rxjs.take(1)).subscribe(res => {
  if(res === true) {
    // action clicked
  } else {
    // close clicked
  }
})

How to Close Programatically

const { snackbarApi } = fyzUtils;
const id = snackbarApi.openNotification('Hallo Welt!', {
    template: 'warning',
    variation: 'full',
    ... // customize the template
}).id;

// close by id
snackbarApi.close(id);

// cloase all where keepTrack = true
snackbarApi.closeAll();