Skip to main content

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 NameGlobal classDescription
root.SCWidget-rootStyles applied to the root element.

Extends

Indexable

[p: string]: any

Any other properties

Properties

PropertyTypeDescriptionInherited from
actions?ReactNodeActions Default null-
className?stringOverrides or extends the styles applied to the component. Default nullWidgetProps.className
event?SCEventTypeEvent Object Default null-
eventId?numberId of the event for filter the feed Default null-
EventParticipantsButtonComponentProps?EventParticipantsButtonPropsProps to spread to EventParticipantsButton component Default {}-
EventSkeletonComponentProps?EventSkeletonPropsProps to spread to EventSkeleton component Default {}-
hideEventParticipants?booleanHide participants Default false-
hideEventPlanner?booleanHide event planner Default false-
hideInProgress?booleanHide in progress Default false-
template?SCEventTemplateTypeEvent 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 NameGlobal classDescription
root.SCWidget-rootStyles applied to the root element.

Extends

Indexable

[p: string]: any

Other props

Properties

PropertyTypeDescriptionOverrides
actions?ReactNodeProp to pass an action to be rendered next to the skeleton-
className?stringOverrides or extends the styles applied to the component. Default nullWidgetProps.className
skeletonsAnimation?false | "wave" | "pulse"Disable skeleton animation-
template?SCEventTemplateTypeEvent template type Default 'preview'-

Functions

Event()

Event(inProps): 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 NameGlobal classDescription
root.SCEvent-rootStyles applied to the root element.
avatar.SCEvent-avatarStyles applied to the avatar element.
primary.SCEvent-primaryStyles applied to the primary item element section
secondary.SCEvent-secondaryStyles applied to the secondary item element section
actions.SCEvent-actionsStyles applied to the actions section.

Parameters

ParameterTypeDescription
inPropsEventProps

Returns

Element


EventSkeleton()

EventSkeleton(inProps): 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 NameGlobal classDescription
root.SCEvent-skeleton-rootStyles applied to the root element.
image.SCEvent-skeleton-imageStyles applied to the image element.
action.SCEvent-skeleton-actionStyles applied to action section.

Parameters

ParameterType
inPropsEventSkeletonProps

Returns

Element