@selfcommunity/react-templates
Version:
React Templates Components to integrate a Community created with SelfCommunity.
78 lines (71 loc) • 2.05 kB
TypeScript
import { FeedObjectProps, FeedSidebarProps, SCFeedWidgetType, EventHeaderProps } from '@selfcommunity/react-ui';
import { SCEventType } from '@selfcommunity/types';
import { EventFeedProps } from '../EventFeed';
export interface EventProps {
/**
* Id of the feed object
* @default 'feed'
*/
id?: string;
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Event Object
* @default null
*/
event?: SCEventType;
/**
* Id of the event for filter the feed
* @default null
*/
eventId?: number;
/**
* Widgets to be rendered into the feed
* @default []
*/
widgets?: SCFeedWidgetType[] | null;
/**
* Props to spread to single feed object
* @default empty object
*/
FeedObjectProps?: FeedObjectProps;
/**
* Props to spread to single feed object
* @default {top: 0, bottomBoundary: `#${id}`}
*/
FeedSidebarProps?: FeedSidebarProps;
/**
* Props to spread to EventFeed component
* @default {}
*/
EventFeedProps?: EventFeedProps;
/**
* Props to spread EventHeader component
* @default {}
*/
EventHeaderProps?: EventHeaderProps;
}
/**
* > API documentation for the Community-JS Category Template. Learn about the available props and the CSS API.
*
*
* This component renders a specific event's template.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-templates/Components/Group)
#### Import
```jsx
import {Group} from '@selfcommunity/react-templates';
```
#### Component Name
The name `SCGroupTemplate` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCGroupTemplate-root|Styles applied to the root element.|
|feed|.SCGroupTemplate-feed|Styles applied to the feed element.|
*
* @param inProps
*/
export default function Event(inProps: EventProps): JSX.Element;