Skip to main content

RelatedFeedObjectsWidget

Interfaces

RelatedFeedObjectWidgetProps

API documentation for the Community-JS Widget component. Learn about the available props and the CSS API.

Import

import {Widget} from '@selfcommunity/react-ui';

Component Name

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

CSS

Rule NameGlobal classDescription
root.SCWidget-rootStyles applied to the root element.

Extends

Indexable

[p: string]: any

Other props

Properties

PropertyTypeDescriptionInherited from
autoHide?booleanHides this component Default false-
cacheStrategy?CacheStrategiesCaching strategies Default CacheStrategies.CACHE_FIRST-
className?stringOverrides or extends the styles applied to the component. Default nullWidgetProps.className
DialogProps?BaseDialogPropsProps to spread to followers users dialog Default {}-
feedObject?SCFeedObjectTypeFeed Object Default null-
FeedObjectProps?FeedObjectPropsProps to spread to single feed object Default empty object-
feedObjectType?DISCUSSION | POST | STATUSType of feed object Default 'discussion'-
limit?numberLimit the number of categories to show Default false-
onHeightChange?() => voidMust be called whenever a list item's height changes (for example, when a user clicks an "Expand"/"Collapse" button of a list item): it re-measures the item's height and updates VirtualScroller layout. Every change in an item's height must come as a result of changing some kind of a state, be it the item's state in VirtualScroller via .onItemStateChange(), or some other state managed by the application. Call this method to re-measure the current element.VirtualScrollerItemProps.onHeightChange
onStateChange?(state) => voidSave current state and when the component re-mount restore previous state using props. It is used to keep a copy of VirtualScroller state so that it could be quickly restored in case the VirtualScroller component gets unmounted and then re-mounted back again — for example, when the user navigates away by clicking on a list item and then navigates "Back" to the list.VirtualScrollerItemProps.onStateChange
template?SCFeedObjectTemplateTypeFeed Object template type Default 'snippet'-

Functions

RelatedFeedObjectsWidgetSkeleton()

RelatedFeedObjectsWidgetSkeleton(): Element

API documentation for the Community-JS Related Feed Objects Widget Skeleton component. Learn about the available props and the CSS API.

Import

import {RelatedFeedObjectsWidgetSkeleton} from '@selfcommunity/react-ui';

Component Name

The name SCRelatedFeedObjects-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCRelatedFeedObjectsWidget-skeleton-rootStyles applied to the root element.

Returns

Element


RelatedFeedObjectWidget()

RelatedFeedObjectWidget(inProps): Element

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 demo component here

Import

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

Component Name

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

CSS

Rule NameGlobal classDescription
root.SCRelatedFeedObjectsWidget-rootStyles applied to the root element.
title.SCRelatedFeedObjectsWidget-titleStyles applied to the title element.
noResults.SCRelatedFeedObjectsWidget-no-resultsStyles applied to no results section.
showMore.SCRelatedFeedObjectsWidget-show-moreStyles applied to show more button element.
dialogRoot.SCRelatedFeedObjectsWidget-dialog-rootStyles applied to the dialog root element.
endMessage.SCRelatedFeedObjectsWidget-end-messageStyles applied to the end message element.

Parameters

ParameterTypeDescription
inPropsRelatedFeedObjectWidgetProps

Returns

Element