GroupForm
Interfaces
GroupFormProps
Extends
BaseDialogProps
Indexable
[p
: string
]: any
Properties
Property | Type | Description | Overrides | Inherited from |
---|---|---|---|---|
DialogContentProps? | DialogContentProps | Dialog content props Default {dividers: !isMobile} | BaseDialogProps.DialogContentProps | BaseDialogProps.DialogContentProps |
actions? | ReactNode | Actions for the dialog | BaseDialogProps.actions | BaseDialogProps.actions |
className? | string | Overrides or extends the styles applied to the component. Default null | BaseDialogProps.className | BaseDialogProps.className |
group? | SCGroupType | Group Object Default null | - | - |
onClose? | () => void | On dialog close callback function Default null | BaseDialogProps.onClose | BaseDialogProps.onClose |
onSuccess? | (data : SCGroupType ) => void | On success callback function Default null | - | - |
open? | boolean | Open dialog Default true | BaseDialogProps.open | BaseDialogProps.open |
subtitle? | any | Dialog subtitle Default '' | BaseDialogProps.subtitle | BaseDialogProps.subtitle |
title? | any | Dialog title Default '' | BaseDialogProps.title | BaseDialogProps.title |
Functions
GroupForm()
GroupForm(
inProps
):JSX.Element
API documentation for the Community-JS Group Form component. Learn about the available props and the CSS API.
Import
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. |
Parameters
Parameter | Type | Description |
---|---|---|
inProps | GroupFormProps |
Returns
JSX.Element
Source
packages/react-ui/src/components/GroupForm/GroupForm.tsx:128