UNPKG

@selfcommunity/react-ui

Version:

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

71 lines (66 loc) 2.56 kB
import { BaseDialogProps } from '../../shared/BaseDialog'; import { SCGroupType } from '@selfcommunity/types'; export interface GroupFormProps extends BaseDialogProps { /** * Overrides or extends the styles applied to the component. * @default null */ className?: string; /** * Open dialog * @default true */ open?: boolean; /** * On dialog close callback function * @default null */ onClose?: () => void; /** * Group Object * @default null */ group?: SCGroupType; /** * On success callback function * @default null */ onSuccess?: (data: SCGroupType) => void; /** * Any other properties */ [p: string]: any; } /** *> API documentation for the Community-JS Group Form component. Learn about the available props and the CSS API. * #### Import ```jsx import {GroupForm} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCGroupForm` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCGroupForm-root|Styles applied to the root element.| |active|.SCGroupForm-active|Styles applied to the active element.| |title|.SCGroupForm-title|Styles applied to the title element.| |header|.SCGroupForm-header|Styles applied to the header element.| |cover|.SCGroupForm-cover|Styles applied to the cover field.| |avatar|.SCGroupForm-avatar|Styles applied to the avatar field.| |form|.SCGroupForm-form|Styles applied to the form element.| |switch|.SCGroupForm-switch|Styles applied to the switch element.| |switchLabel|.SCGroupForm-switch-label|Styles applied to the switchLabel element.| |name|.SCGroupForm-name|Styles applied to the name field.| |description|.SCGroupForm-description|Styles applied to the description field.| |content|.SCGroupForm-content|Styles applied to the element.| |privacySection|.SCGroupForm-privacy-section|Styles applied to the privacy section.| |privacySectionInfo|.SCGroupForm-privacy-section-info|Styles applied to the privacy info section.| |visibilitySection|.SCGroupForm-visibility-section|Styles applied to the visibility section.| |visibilitySectionInfo|.SCGroupForm-visibility-section-info|Styles applied to the visibility section info.| |inviteSection|.SCGroupForm-invite-section|Styles applied to the invite section.| |error|.SCGroupForm-error|Styles applied to the error elements.| * @param inProps */ export default function GroupForm(inProps: GroupFormProps): JSX.Element;