RelatedEventsWidget
Interfaces
RelatedEventsWidgetProps
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
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> | Feed API Query Params Default [{'limit': 20, 'offset': 0}] | - |
event? | SCEventType | Event Object Default null | - |
eventComponentProps? | EventProps | Props to spread to single event object Default {} | - |
eventId? | number | Id of event object Default null | - |
limit? | number | - | - |
Functions
RelatedEventsWidget()
RelatedEventsWidget(
inProps):Element
Parameters
| Parameter | Type |
|---|---|
inProps | RelatedEventsWidgetProps |
Returns
Element
Source
packages/react-ui/src/components/RelatedEventsWidget/RelatedEventsWidget.tsx:101
RelatedEventsWidgetSkeleton()
RelatedEventsWidgetSkeleton():
Element
Returns
Element
Source
packages/react-ui/src/components/RelatedEventsWidget/Skeleton.tsx:24