@selfcommunity/react-ui/lib/esm/components/LiveStream/LiveStream.d.ts

React UI Components to integrate a Community created with SelfCommunity Platform.

import { SCLiveStreamType } from '@selfcommunity/types';
import React from 'react';
import { SCLiveStreamTemplateType } from '../../types/liveStream';
import { WidgetProps } from '../Widget';
import { LiveStreamSkeletonProps } from './index';
export interface LiveStreamProps extends WidgetProps {
    /**
     * Event Object
     * @default null
     */
    liveStream?: SCLiveStreamType;
    /**
     * Id of the liveStream for filter the feed
     * @default null
     */
    liveStreamId?: number;
    /**
     * Event template type
     * @default 'preview'
     */
    template?: SCLiveStreamTemplateType;
    /**
     * Actions
     * @default null
     */
    actions?: React.ReactNode;
    /**
     * Hide in progress
     * @default false
     */
    hideInProgress?: boolean;
    /**
     * Hide liveStream planner
     * @default false
     */
    hideLiveStreamHost?: boolean;
    /**
     * Props to spread to EventSkeleton component
     * @default {}
     */
    LiveStreamSkeletonComponentProps?: LiveStreamSkeletonProps;
    /**
     * Any other properties
     */
    [p: string]: any;
}
/**
 * > API documentation for the Community-JS Live Stream component. Learn about the available props and the CSS API.
 *
 *
 * This component renders an liveStream item.
 * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/Event)

 #### Import

 ```jsx
 import {liveStream} from '@selfcommunity/react-ui';
 ```

 #### Component Name

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


 #### CSS

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


 *
 * @param inProps
 */
export default function LiveStream(inProps: LiveStreamProps): JSX.Element;