@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
47 lines (40 loc) • 1.38 kB
TypeScript
import React from 'react';
import { SCLiveStreamTemplateType } from '../../types/liveStream';
import { WidgetProps } from '../Widget';
export interface LiveStreamSkeletonProps extends WidgetProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* LiveStream template type
* @default 'preview'
*/
template?: SCLiveStreamTemplateType;
/**
* Disable skeleton animation
*/
skeletonsAnimation?: false | 'wave' | 'pulse';
/**
* Prop to pass an action to be rendered next to the skeleton
*/
actions?: React.ReactNode;
}
/**
* > API documentation for the Community-JS LiveStream Skeleton component. Learn about the available props and the CSS API.
#### Import
```jsx
import {LiveStreamSkeleton} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCLiveStream-skeleton-root` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCLiveStream-skeleton-root|Styles applied to the root element.|
|image|.SCLiveStream-skeleton-image|Styles applied to the image element.|
|action|.SCLiveStream-skeleton-action|Styles applied to action section.|
*
*/
export default function LiveStreamSkeleton(inProps: LiveStreamSkeletonProps): JSX.Element;