LiveStream
Interfaces
LiveStreamProps
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
Indexable
[p: string]: any
Any other properties
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
actions? | ReactNode | Actions Default null | - |
className? | string | Overrides or extends the styles applied to the component. Default null | WidgetProps.className |
hideInProgress? | boolean | Hide in progress Default false | - |
hideLiveStreamHost? | boolean | Hide liveStream planner Default false | - |
liveStream? | SCLiveStreamType | Event Object Default null | - |
liveStreamId? | number | Id of the liveStream for filter the feed Default null | - |
LiveStreamSkeletonComponentProps? | LiveStreamSkeletonProps | Props to spread to EventSkeleton component Default {} | - |
template? | SCLiveStreamTemplateType | Event template type Default 'preview' | - |
LiveStreamSkeletonProps
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
Indexable
[p: string]: any
Other props
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
actions? | ReactNode | Prop to pass an action to be rendered next to the skeleton | - |
className? | string | Overrides or extends the styles applied to the component. Default null | WidgetProps.className |
skeletonsAnimation? | false | "wave" | "pulse" | Disable skeleton animation | - |
template? | SCLiveStreamTemplateType | LiveStream template type Default 'preview' | - |
Functions
LiveStream()
LiveStream(
inProps):Element
API documentation for the Community-JS Live Stream component. Learn about the available props and the CSS API.
This component renders an liveStream item. Take a look at our demo component here
Import
import {liveStream} from '@selfcommunity/react-ui';
Component Name
The name SCLiveStream can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCLiveStream-root | Styles applied to the root element. |
| avatar | .SCLiveStream-avatar | Styles applied to the avatar element. |
| primary | .SCLiveStream-primary | Styles applied to the primary item element section |
| secondary | .SCLiveStream-secondary | Styles applied to the secondary item element section |
| actions | .SCLiveStream-actions | Styles applied to the actions section. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | LiveStreamProps |
Returns
Element
LiveStreamSkeleton()
LiveStreamSkeleton(
inProps):Element
API documentation for the Community-JS LiveStream Skeleton component. Learn about the available props and the CSS API.
Import
import {LiveStreamSkeleton} from '@selfcommunity/react-ui';
Component Name
The name SCLiveStream-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCLiveStream-skeleton-root | Styles applied to the root element. |
| image | .SCLiveStream-skeleton-image | Styles applied to the image element. |
| action | .SCLiveStream-skeleton-action | Styles applied to action section. |
Parameters
| Parameter | Type |
|---|---|
inProps | LiveStreamSkeletonProps |
Returns
Element