UNPKG

@selfcommunity/react-ui

Version:

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

54 lines (50 loc) 1.76 kB
import { ButtonProps } from '@mui/material'; import { SCCourseType } from '@selfcommunity/types'; import { BaseDialogProps } from '../../shared/BaseDialog'; export interface CourseParticipantsButtonProps extends Pick<ButtonProps, Exclude<keyof ButtonProps, 'onClick' | 'disabled'>> { /** * Course Object * @default null */ course?: SCCourseType; /** * CourseId of course object * @default null */ courseId?: number; /** * Hide button label * @default false */ hideCaption?: boolean; /** * Props to spread to followedBy dialog * @default {} */ DialogProps?: BaseDialogProps; /** * Any other properties */ [p: string]: any; } /** *> API documentation for the Community-JS Course Participants Button component. Learn about the available props and the CSS API. * #### Import ```jsx import {CourseParticipantsButton} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCCourseParticipantsButton` can be used when providing style overrides in the theme. * #### CSS * |Rule Name|Global class|Description| |---|---|---| |root|.SCCourseParticipantsButton-root|Styles applied to the root element.| |dialogRoot|.SCCourseParticipantsButton-dialog-root|Styles applied to the dialog root element.| |endMessage|.SCCourseParticipantsButton-end-message|Styles applied to the end message element.| |infiniteScroll|.SCCourseParticipantsButton-infinite-scroll|Styles applied to the infinite scroll element.| |participants|.SCCourseParticipantsButton-participants|Styles applied to the participants section.| * @param inProps */ export default function CourseParticipantsButton(inProps: CourseParticipantsButtonProps): JSX.Element;