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 Name	Global class	Description
root	.SCWidget-root	Styles applied to the root element.

Extends

• VirtualScrollerItemProps.WidgetProps

Indexable

[p: string]: any

Properties

Property	Type	Description	Inherited from
DialogProps?	BaseDialogProps	Props to spread to followers users dialog Default {}	-
FeedObjectProps?	FeedObjectProps	Props to spread to single feed object Default empty object	-
autoHide?	boolean	Hides this component Default false	-
cacheStrategy?	CacheStrategies	Caching strategies Default CacheStrategies.CACHE_FIRST	-
className?	string	Overrides or extends the styles applied to the component. Default null	WidgetProps.className
feedObject?	SCFeedObjectType	Feed Object Default null	-
feedObjectType?	DISCUSSION | POST | STATUS	Type of feed object Default 'discussion'	-
limit?	number	Limit the number of categories to show Default false	-
onHeightChange?	() => void	Must 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: any) => void	Save 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?	SCFeedObjectTemplateType	Feed Object template type Default 'snippet'	-

Functions

RelatedFeedObjectWidget()

RelatedFeedObjectWidget(inProps): JSX.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 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.

Parameters

Parameter	Type	Description
inProps	RelatedFeedObjectWidgetProps

Returns

JSX.Element

Source

packages/react-ui/src/components/RelatedFeedObjectsWidget/RelatedFeedObjectsWidget.tsx:140

---

RelatedFeedObjectsWidgetSkeleton()

RelatedFeedObjectsWidgetSkeleton(): JSX.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 Name	Global class	Description
root	.SCRelatedFeedObjectsWidget-skeleton-root	Styles applied to the root element.

Returns

JSX.Element

Source

packages/react-ui/src/components/RelatedFeedObjectsWidget/Skeleton.tsx:34