GMFYNotifications

import { GMFYNotifications } from 'gmfy-sdk'

Мотивация

Компонент провайдер для работы со списком уведомлений пользователя с userId. Он позволяет либо получить список с помощью хука. Или можно передать ID узла, в котором будут отображены уведомления.

Свойства

type GMFYNotificationsProps = {
    notificationClassName?: string;
    maxNumberToVisible?: number;
    config?: {
        updateInterval?: number;
        portalId?: string;
        showNotifications?: boolean;
    };
}

• notificationClassName - название класса стилей, которое будет присвоено каждой из карточек уведомлений
• maxNumberToVisible - максимальное количество отображаемых за раз карточек уведомлений
• maxNumberToVisible - объект настроек провайдера
  • updateInterval - частота вызова запросов в мс. Если 0, то запрос выполнится только один раз. По умолчанию 0
  • portalId - ID элемента, в котором необходимо создать портал со списком уведомлений. Если не передан или не найден элемент с таким ID, то выбирается document.body
  • showNotifications - флаг отвечающий за то, будут ли отображаться полученные уведомления. По умолчанию false

Использование

<GMFYProvider config={config}>
    <GMFYNotifications
        showNotifications
        maxNumberToVisible={4}
        updateInterval={5000}
        portalId="notifications-portal"
    >
        {/* ваше приложение */}
    </GMFYNotifications>
</GMFYProvider>;

Отображение

На карточке уведомления отображается

• сообщение с информацией
• иконка для закрытия уведомления