UserLiveStreamWidget

Interfaces

UserLiveStreamWidgetProps

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

• WidgetProps

Indexable

[p: string]: any

Other props

Properties

Property	Type	Description	Inherited from
cacheStrategy?	CacheStrategies	Caching strategies Default CacheStrategies.CACHE_FIRST	-
className?	string	Overrides or extends the styles applied to the component. Default null	WidgetProps.className
dialogProps?	BaseDialogProps	Props to spread to users suggestion dialog Default {}	-
endpointQueryParams?	Record<string, string | number>	API Query Params Default [{'limit': 20, 'offset': 0}]	-
limit?	number	Limit param	-
liveStreamComponentProps?	LiveStreamProps	Props to spread to single live stream object Default {}	-
user?	SCUserType	User Object Default null	-
userId	number	The user id Default null	-

Functions

UserLiveStreamWidget()

UserLiveStreamWidget(inProps): Element

Parameters

Parameter	Type
inProps	UserLiveStreamWidgetProps

Returns

Element

---

UserLiveStreamWidgetSkeleton()

UserLiveStreamWidgetSkeleton(): Element

Returns

Element