@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
77 lines (69 loc) • 2.4 kB
TypeScript
import { LessonCommentObjectProps } from '../LessonCommentObject';
import { SCCourseLessonType } from '@selfcommunity/types';
import { CacheStrategies } from '@selfcommunity/utils';
export interface LessonCommentObjectsProps {
/**
* Id of the LessonCommentObjects
* @default `lesson_comments_object_lessonObjectId`
*/
id?: string;
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Id of lesson object
* @default null
*/
lessonObjectId?: number;
/**
* Lesson object
* @default null
*/
lessonObject?: SCCourseLessonType;
/**
* Props to spread to single comment object
* @default {}
*/
CommentComponentProps?: LessonCommentObjectProps;
/**
* Props to spread to CommentsObjectSkeleton
* @default {}
*/
CommentsObjectSkeletonProps?: any;
/**
* Props to spread to single comment object skeleton
* @default {elevation: 0},
*/
CommentObjectSkeletonProps?: any;
/**
* Caching strategies
* @default CacheStrategies.CACHE_FIRST
*/
cacheStrategy?: CacheStrategies;
/**
* Other props
*/
[p: string]: any;
}
/**
* > API documentation for the Community-JS Comments Object component. Learn about the available props and the CSS API.
#### Import
```jsx
import {LessonCommentObjects} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCLessonCommentObjects` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCLessonCommentObjects-root|Styles applied to the root element.|
|pagination|.SCLessonCommentObjects-pagination|Styles applied to the pagination controls.|
|paginationLink|.SCLessonCommentObjects-pagination-link|Styles applied to the pagination link.|
|loadNextCommentsButton|.SCLessonCommentObjects-load-next-comments-button|Styles applied to the load next comments button.|
|loadPreviousCommentsButton|.SCLessonCommentObjects-load-previous-comments-button|Styles applied to the load previous comments button.|
|commentsCounter|.SCLessonCommentObjects-comments-counter|Styles applied to the comments counter element.|
* @param inProps
*/
export default function LessonCommentObjects(inProps: LessonCommentObjectsProps): JSX.Element;