@selfcommunity/react-ui/lib/esm/components/FeedUpdatesWidget/FeedUpdatesWidget.d.ts

React UI Components to integrate a Community created with SelfCommunity Platform.

import { ReactNode } from 'react';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
export interface FeedUpdatesWidgetProps extends VirtualScrollerItemProps {
    /**
     * Id of the feed object
     * @default 'custom_adv'
     */
    id?: string;
    /**
     * Overrides or extends the styles applied to the component.
     * @default null
     */
    className?: string;
    /**
     * Update message, rendered when no more feed item can be displayed
     * @default <FormattedMessage id="ui.feedUpdatesWidget.message" defaultMessage="ui.feedUpdatesWidget.message" />
     */
    message?: ReactNode;
    /**
     * Subscription channel for updates notification
     */
    subscriptionChannel: string;
    /**
     * Callback used to check if the message published to the channel is an update message
     * @default (msg, data) => true
     * @return boolean
     */
    subscriptionChannelUpdatesCallback?: (msg: any, data: any) => boolean;
    /**
     * Publish channel for refresh notification
     */
    publicationChannel?: string;
    /**
     * Other Card props
     */
    [p: string]: any;
}
/**
 * > API documentation for the Community-JS Feed Updates Widget component. Learn about the available props and the CSS API.
 *
 *
 * This component allows the subscription to updates from PubSub channel (e.g. websocket) and tell the feed to updates if necessary.
 * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/FeedUpdates)

 #### Import

 ```jsx
 import {FeedUpdatesWidget} from '@selfcommunity/react-ui';
 ```

 #### Component Name

 The name `SCFeedUpdatesWidget` can be used when providing style overrides in the theme.


 #### CSS

 |Rule Name|Global class|Description|
 |---|---|---|
 |root|.SCFeedUpdatesWidget-root|Styles applied to the root element.|
 |buttonLoadMore|.SCFeedUpdatesWidget-button-load-more|Styles applied to the to load more button.|
 *
 * @param inProps
 */
export default function FeedUpdatesWidget(inProps: FeedUpdatesWidgetProps): JSX.Element;