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