UserProfileEdit

Interfaces

UserProfileEditProps

Indexable

[p: string]: any

Any other properties

Properties

Property	Type	Description
className?	string	Overrides or extends the styles applied to the component. Default null
fields?	SCUserProfileFields[]	User fields to display in the profile Default [real_name, date_joined, date_of_birth, website, description, bio]
id?	string | number	Id of user object Default null
settings?	SCUserProfileSettings[]	Settings to display in the profile Default [notification, interaction, private_message]
UserProfileEditSectionAccountProps?	UserProfileEditSectionAccountProps	Props to apply to Account section Default {}
UserProfileEditSectionPublicInfoProps?	Omit<UserProfileEditSectionPublicInfoProps, "fields">	Props to apply to PublicInfo section Default {}
UserProfileEditSectionSettingsProps?	Omit<UserProfileEditSectionPublicInfoProps, "settings">	Props to apply to Settings section Default {}

---

UserProfileEditSectionAccountProps

Indexable

[p: string]: any

Any other properties

Properties

Property	Type	Description
AccountCredentialProps?	AccountCredentialProps	Props to apply to Account credential section Default {}
AccountDeleteButtonProps?	AccountDeleteButtonProps	Props to apply to Account delete button Default {}
className?	string	Overrides or extends the styles applied to the component. Default null
endActions?	ReactNode	Actions to be inserted after social associations section Default null
handleAssociationCreate?	(provider) => void	Handles create association callback
LanguageSwitcherProps?	LanguageSwitcherProps	Props to apply to LanguageSwitcher component Default {}
showCredentialsSection?	boolean	If true, shows email and password section Default false
showLanguageSwitcher?	boolean	If true, shows language switcher Default false
showSocialAccountSection?	boolean	If true, shows social account section Default true
startActions?	ReactNode	Actions to be inserted before credentials section Default null

---

UserProfileEditSectionPublicInfoProps

Indexable

[p: string]: any

Any other properties

Properties

Property	Type	Description
className?	string	Overrides or extends the styles applied to the component. Default null
endActions?	ReactNode	Actions to be inserted at the end Default null
fields?	SCUserProfileFields[]	User fields to display in the profile Default [real_name, date_joined, date_of_birth, website, description, bio]
id?	string	Id of user object Default null
onEditFailure?	(editedField?) => void	Callback on edit data with error
onEditSuccess?	(editedField?) => void	Callback on edit data with success
startActions?	ReactNode	Actions to be inserted at the start Default null

---

UserProfileEditSectionSettingsProps

Indexable

[p: string]: any

Any other properties

Properties

Property	Type	Description
className?	string	Overrides or extends the styles applied to the component. Default null
endActions?	ReactNode	Actions to be inserted at the end Default null
id?	string	Id of user object Default null
onEditSuccess?	() => void	Callback on edit data with success
settings?	SCUserProfileSettings[]	Settings to display in the profile Default [notification, interaction, private_message]
startActions?	ReactNode	Actions to be inserted at the start Default null

Functions

UserProfileEdit()

UserProfileEdit(inProps): Element

API documentation for the Community-JS User Profile Edit component. Learn about the available props and the CSS API.

This component renders a section composed of different tabs where the user can edit the settings about its public information, account and notifications. Take a look at our demo component here

Import

import {UserProfileEdit} from '@selfcommunity/react-ui';

Component Name

The name SCUserProfileEdit can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCUserProfileEdit-root	Styles applied to the root element.
tabs	.SCUserProfileEdit-tabs	Styles applied to the tab elements.
tabsContent	.SCUserProfileEdit-tabs-content	Styles applied to tab content elements.

Parameters

Parameter	Type	Description
inProps	UserProfileEditProps

Returns

Element

---

UserProfileEditSectionAccount()

UserProfileEditSectionAccount(props): Element

Parameters

Parameter	Type
props	UserProfileEditSectionAccountProps

Returns

Element

---

UserProfileEditSectionPublicInfo()

UserProfileEditSectionPublicInfo(props): Element

Parameters

Parameter	Type
props	UserProfileEditSectionPublicInfoProps

Returns

Element

---

UserProfileEditSectionSettings()

UserProfileEditSectionSettings(props): Element

Parameters

Parameter	Type
props	UserProfileEditSectionSettingsProps

Returns

Element

---

UserProfileEditSkeleton()

UserProfileEditSkeleton(): Element

API documentation for the Community-JS User Profile Edit Skeleton component. Learn about the available props and the CSS API.

Import

import {UserProfileEditSkeleton} from '@selfcommunity/react-ui';

Component Name

The name SCUserProfileEdit-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule Name	Global class	Description
root	.SCUserProfileEdit-skeleton-root	Styles applied to the root element.

Returns

Element