Event

Interfaces

EventProps

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

Properties

Property	Type	Description	Inherited from
EventParticipantsButtonComponentProps?	EventParticipantsButtonProps	Props to spread to EventParticipantsButton component Default {}	-
EventSkeletonComponentProps?	EventSkeletonProps	Props to spread to EventSkeleton component Default {}	-
actions?	ReactNode	Actions Default null	-
className?	string	Overrides or extends the styles applied to the component. Default null	WidgetProps.className
event?	SCEventType	Event Object Default null	-
eventId?	number	Id of the event for filter the feed Default null	-
hideEventParticipants?	boolean	Hide participants Default false	-
hideEventPlanner?	boolean	Hide event planner Default false	-
hideInProgress?	boolean	Hide in progress Default false	-
template?	SCEventTemplateType	Event template type Default 'preview'	-

---

EventSkeletonProps

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

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?	SCEventTemplateType	Event template type Default 'preview'	-

Functions

Event()

Event(inProps): JSX.Element

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

This component renders an event item. Take a look at our demo component here

Import

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

Component Name

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

CSS

Rule Name	Global class	Description
root	.SCEvent-root	Styles applied to the root element.
avatar	.SCEvent-avatar	Styles applied to the avatar element.
primary	.SCEvent-primary	Styles applied to the primary item element section
secondary	.SCEvent-secondary	Styles applied to the secondary item element section
actions	.SCEvent-actions	Styles applied to the actions section.

Parameters

Parameter	Type	Description
inProps	EventProps

Returns

JSX.Element

Source

packages/react-ui/src/components/Event/Event.tsx:157

---

EventSkeleton()

EventSkeleton(inProps): JSX.Element

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

Import

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

Component Name

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

CSS

Rule Name	Global class	Description
root	.SCEvent-skeleton-root	Styles applied to the root element.
image	.SCEvent-skeleton-image	Styles applied to the image element.
action	.SCEvent-skeleton-action	Styles applied to action section.

Parameters

Parameter	Type
inProps	EventSkeletonProps

Returns

JSX.Element

Source

packages/react-ui/src/components/Event/Skeleton.tsx:94