UNPKG

@selfcommunity/react-templates

Version:

React Templates Components to integrate a Community created with SelfCommunity.

60 lines (53 loc) 1.86 kB
import { FeedSidebarProps, FeedProps, NotificationProps, SCFeedWidgetType } from '@selfcommunity/react-ui'; export interface NotificationFeedProps { /** * Id of the feed object * @default 'notification_feed' */ id?: string; /** * Overrides or extends the styles applied to the component. * @default null */ className?: string; /** * Widgets to be rendered into the feed * @default [CategoriesFollowed, UserFollowed] */ widgets?: SCFeedWidgetType[] | null; /** * Props to spread to single feed object * @default empty object */ NotificationProps?: NotificationProps; /** * Props to spread to single feed object * @default {top: 0, bottomBoundary: `#${id}`} */ FeedSidebarProps?: FeedSidebarProps; /** * Props to spread to feed component * @default {} */ FeedProps?: Omit<FeedProps, 'endpoint' | 'widgets' | 'ItemComponent' | 'itemPropsGenerator' | 'itemIdGenerator' | 'ItemSkeleton' | 'ItemSkeletonProps' | 'FeedSidebarProps'>; } /** * > API documentation for the Community-JS Notification Feed Template. Learn about the available props and the CSS API. * * * This component renders the template for the notification feed. * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-templates/Components/NotificationFeed) #### Import ```jsx import {NotificationFeed} from '@selfcommunity/react-templates'; ``` #### Component Name The name `SCNotificationFeedTemplate` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCNotificationFeedTemplate-root|Styles applied to the root element.| * * @param inProps */ export default function NotificationFeed(inProps: NotificationFeedProps): JSX.Element;