@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
74 lines (65 loc) • 2.14 kB
TypeScript
import { SCEventType } from '@selfcommunity/types';
import { EventActionsMenuProps } from '../../shared/EventActionsMenu';
import { EventSubscribeButtonProps } from '../EventSubscribeButton';
export interface EventHeaderProps {
/**
* Id of event object
* @default null
*/
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
* @default null
*/
eventId?: number;
/**
* Props to spread event button
* @default {}
*/
EventSubscribeButtonProps?: EventSubscribeButtonProps;
/**
* Props to spread event actions menu
* @default {}
*/
EventActionsProps?: Omit<EventActionsMenuProps, 'event'>;
/**
* Any other properties
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS Event Header component. Learn about the available props and the CSS API.
*
*
* This component renders the events top section.
#### Import
```jsx
import {UserProfileHeader} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCEventHeader` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCEventHeader-root|Styles applied to the root element.|
|cover|.SCEventHeader-cover|Styles applied to the cover element.|
|time|.SCEventHeader-time|Styles applied to the time element.|
|calendar|.SCEventHeader-calendar|Styles applied to the calendar element.|
|info|SCEventHeader-info|Styles applied to the info section.|
|name|SCEventHeader-username|Styles applied to the username element.|
|visibility|SCEventHeader-visibility|Styles applied to the visibility section.|
|visibilityItem|SCEventHeader-visibility-item|Styles applied to the visibility element.|
|multiActions|SCEventHeader-multi-action|Styles applied to the multi actions section.|
* @param inProps
*/
export default function EventHeader(inProps: EventHeaderProps): JSX.Element;