Skip to main content

Interface: UserProps

User.UserProps

API documentation for the Community-JS Widget component. Learn about the available props and the CSS API.

Import

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

Component Name

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

CSS

Rule NameGlobal classDescription
root.SCWidget-rootStyles applied to the root element.

Hierarchy

Indexable

▪ [p: string]: any

Any other properties

Properties

badgeContent

Optional badgeContent: any

Badge content to show as user avatar badge if show reaction is true.

Defined in

packages/react-ui/src/components/User/User.tsx:76


className

Optional className: string

Overrides or extends the styles applied to the component.

Default

null

Inherited from

WidgetProps.className

Defined in

packages/react-ui/src/components/Widget/index.tsx:45


followConnectUserButtonProps

Optional followConnectUserButtonProps: FollowUserButtonProps | FriendshipButtonProps

Props to spread to follow/friendship button

Default

{}

Defined in

packages/react-ui/src/components/User/User.tsx:67


handleIgnoreAction

Optional handleIgnoreAction: (u: any) => void

Type declaration

▸ (u): void

Handles actions ignore

Parameters
NameType
uany
Returns

void

Default

null

Defined in

packages/react-ui/src/components/User/User.tsx:62


showFollowers

Optional showFollowers: boolean

Prop to show user followers as secondary text

Default

false

Defined in

packages/react-ui/src/components/User/User.tsx:72


user

Optional user: SCUserType

User Object

Default

null

Defined in

packages/react-ui/src/components/User/User.tsx:57


userId

Optional userId: number

User Id

Default

null

Defined in

packages/react-ui/src/components/User/User.tsx:52