Skip to main content

GroupForm

Interfaces

GroupFormProps

Extends

  • BaseDialogProps

Indexable

[p: string]: any

Properties

PropertyTypeDescriptionOverridesInherited from
DialogContentProps?DialogContentPropsDialog content props

Default
{dividers: !isMobile}
BaseDialogProps.DialogContentPropsBaseDialogProps.DialogContentProps
actions?ReactNodeActions for the dialogBaseDialogProps.actionsBaseDialogProps.actions
className?stringOverrides or extends the styles applied to the component.

Default
null
BaseDialogProps.classNameBaseDialogProps.className
group?SCGroupTypeGroup Object

Default
null
--
onClose?() => voidOn dialog close callback function

Default
null
BaseDialogProps.onCloseBaseDialogProps.onClose
onSuccess?(data: SCGroupType) => voidOn success callback function

Default
null
--
open?booleanOpen dialog

Default
true
BaseDialogProps.openBaseDialogProps.open
subtitle?anyDialog subtitle

Default
''
BaseDialogProps.subtitleBaseDialogProps.subtitle
title?anyDialog title

Default
''
BaseDialogProps.titleBaseDialogProps.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 NameGlobal classDescription
root.SCGroupForm-rootStyles applied to the root element.
active.SCGroupForm-activeStyles applied to the active element.
title.SCGroupForm-titleStyles applied to the title element.
header.SCGroupForm-headerStyles applied to the header element.
cover.SCGroupForm-coverStyles applied to the cover field.
avatar.SCGroupForm-avatarStyles applied to the avatar field.
form.SCGroupForm-formStyles applied to the form element.
switch.SCGroupForm-switchStyles applied to the switch element.
switchLabel.SCGroupForm-switch-labelStyles applied to the switchLabel element.
name.SCGroupForm-nameStyles applied to the name field.
description.SCGroupForm-descriptionStyles applied to the description field.
content.SCGroupForm-contentStyles applied to the element.
privacySection.SCGroupForm-privacy-sectionStyles applied to the privacy section.
privacySectionInfo.SCGroupForm-privacy-section-infoStyles applied to the privacy info section.
visibilitySection.SCGroupForm-visibility-sectionStyles applied to the visibility section.
visibilitySectionInfo.SCGroupForm-visibility-section-infoStyles applied to the visibility section info.
inviteSection.SCGroupForm-invite-sectionStyles applied to the invite section.
error.SCGroupForm-errorStyles applied to the error elements.

Parameters

ParameterTypeDescription
inPropsGroupFormProps

Returns

JSX.Element

Source

packages/react-ui/src/components/GroupForm/GroupForm.tsx:128