UserProfile
Interfaces
UserProfileProps
Properties
className?
optionalclassName:string
Overrides or extends the styles applied to the component.
Default
null
editEndActions?
optionaleditEndActions:ReactNode
Actions to be inserted after default user profile actions if it is my profile (edit mode)
editStartActions?
optionaleditStartActions:ReactNode
Actions to be inserted before default user profile actions if it is my profile (edit mode)
endActions?
optionalendActions:ReactNode
Actions to be inserted after default user profile actions
FeedObjectProps?
optionalFeedObjectProps:FeedObjectProps
Props to spread to single feed object
Default
empty object
FeedSidebarProps?
optionalFeedSidebarProps:StickyBoxProps
Props to spread to single feed object
Default
{top: 0, bottomBoundary: `#${id}`}
id?
optionalid:string
Id of the user profile
Default
'user'
onEditClick()?
optionalonEditClick: (user) =>void
Click handler for edit button
Parameters
| Parameter | Type |
|---|---|
user | SCUserType |
Returns
void
Default
null
startActions?
optionalstartActions:ReactNode
Actions to be inserted before default user profile actions
user?
optionaluser:SCUserType
User Object
Default
null
UserFeedProps?
optionalUserFeedProps:UserFeedProps
Props to spread to feed component
Default
{}
userId?
optionaluserId:string|number
Id of the user for filter the feed
Default
null
UserProfileHeaderProps?
optionalUserProfileHeaderProps:UserProfileHeaderProps
Props to spread to UserTagStack component
Default
{}
viewEndActions?
optionalviewEndActions:ReactNode
Actions to be inserted after default user profile actions if is not my profile (view mode)
viewStartActions?
optionalviewStartActions:ReactNode
Actions to be inserted before default user profile actions if is not my profile (view mode)
widgets?
optionalwidgets:SCFeedWidgetType[]
Widgets to be rendered into the feed
Default
[UserFollowedCategoriesWidget, UserFollowedUsersWidget]
Functions
UserProfile()
UserProfile(
inProps):Element
API documentation for the Community-JS User Profile Template. Learn about the available props and the CSS API.
This component renders a specific user's profile template. Take a look at our demo component here
Import
import {UserProfile} from '@selfcommunity/react-templates';
Component Name
The name SCUserProfileTemplate can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCUserProfileTemplate-root | Styles applied to the root element. |
| counters | .SCUserProfileTemplate-counters | Styles applied to the counters section. |
| tags | .SCUserProfileTemplate-tags | Styles applied to the tags section. |
| info | .SCUserProfileTemplate-info | Styles applied to the info section. |
| feed | .SCUserProfileTemplate-feed | Styles applied to the feed section. |
| actions | .SCUserProfileTemplate-actions | Styles applied to the actions section. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | UserProfileProps |
Returns
Element
UserProfileSkeleton()
UserProfileSkeleton():
Element
API documentation for the Community-JS User Profile Skeleton Template. Learn about the available props and the CSS API.
Import
import {UserProfileSkeleton} from '@selfcommunity/react-templates';
Component Name
The name SCUserProfileTemplate-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCUserProfileTemplate-skeleton-root | Styles applied to the root element. |
Returns
Element