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

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

import { FeedObjectProps } from '../FeedObject';
import { SCFeedObjectTemplateType } from '../../types/feedObject';
import { BaseDialogProps } from '../../shared/BaseDialog';
import { WidgetProps } from '../Widget';
import { CacheStrategies } from '@selfcommunity/utils';
import { SCContributionType, SCFeedObjectType } from '@selfcommunity/types';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
export interface RelatedFeedObjectWidgetProps extends VirtualScrollerItemProps, WidgetProps {
    /**
     * Type of  feed object
     * @default 'discussion'
     */
    feedObjectType?: Exclude<SCContributionType, SCContributionType.COMMENT>;
    /**
     * Feed Object
     * @default null
     */
    feedObject?: SCFeedObjectType;
    /**
     * Feed Object template type
     * @default 'snippet'
     */
    template?: SCFeedObjectTemplateType;
    /**
     * Props to spread to single feed object
     * @default empty object
     */
    FeedObjectProps?: FeedObjectProps;
    /**
     * Hides this component
     * @default false
     */
    autoHide?: boolean;
    /**
     * Limit the number of categories to show
     * @default false
     */
    limit?: number;
    /**
     * Caching strategies
     * @default CacheStrategies.CACHE_FIRST
     */
    cacheStrategy?: CacheStrategies;
    /**
     * Props to spread to followers users dialog
     * @default {}
     */
    DialogProps?: BaseDialogProps;
    /**
     * Other props
     */
    [p: string]: any;
}
/**
 * > API documentation for the Community-JS Related FeedObjects component. Learn about the available props and the CSS API.
 *
 *
 * This component renders a list of related feed objects (posts, discussions or statuses).
 * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/RelatedFeedObjects)

 #### Import

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

 #### Component Name

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

 #### CSS

 |Rule Name|Global class|Description|
 |---|---|---|
 |root|.SCRelatedFeedObjectsWidget-root|Styles applied to the root element.|
 |title|.SCRelatedFeedObjectsWidget-title|Styles applied to the title element.|
 |noResults|.SCRelatedFeedObjectsWidget-no-results|Styles applied to no results section.|
 |showMore|.SCRelatedFeedObjectsWidget-show-more|Styles applied to show more button element.|
 |dialogRoot|.SCRelatedFeedObjectsWidget-dialog-root|Styles applied to the dialog root element.|
 |endMessage|.SCRelatedFeedObjectsWidget-end-message|Styles applied to the end message element.|

 *
 * @param inProps
 */
export default function RelatedFeedObjectWidget(inProps: RelatedFeedObjectWidgetProps): JSX.Element;