@trycourier/courier-ui-inbox/dist/types/inbox-defaults.d.ts

Inbox components for the Courier web UI

import { CourierInboxFeed } from './inbox-data-set';
/**
 * Header action ID types.
 */
export type CourierInboxHeaderActionId = 'readAll' | 'archiveRead' | 'archiveAll';
/**
 * List item action ID types.
 */
export type CourierInboxListItemActionId = 'read_unread' | 'archive_unarchive';
/**
 * Configuration for a header action.
 */
export type CourierInboxHeaderAction = {
    id: CourierInboxHeaderActionId;
    iconSVG?: string;
    text?: string;
};
/**
 * Configuration for a list item action.
 */
export type CourierInboxListItemAction = {
    id: CourierInboxListItemActionId;
    readIconSVG?: string;
    unreadIconSVG?: string;
    archiveIconSVG?: string;
    unarchiveIconSVG?: string;
};
/**
 * Returns the default feeds for the inbox.
 */
export declare function defaultFeeds(): CourierInboxFeed[];
/**
 * Returns the default header actions.
 */
export declare function defaultActions(): CourierInboxHeaderAction[];
/**
 * Returns the default list item actions.
 */
export declare function defaultListItemActions(): CourierInboxListItemAction[];