Widget

Interfaces

WidgetProps

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 Name	Global class	Description
root	.SCWidget-root	Styles applied to the root element.

Extends

• CardProps

Extended by

• UserSuggestionWidgetProps
• UserSubscribedGroupsWidgetProps
• UserFollowersWidgetProps
• UserFollowedUsersWidgetProps
• UserFollowedCategoriesWidgetProps
• UserConnectionsWidgetProps
• UserConnectionsRequestsWidgetProps
• UserConnectionsRequestsSentWidgetProps
• UserProps
• SuggestedEventsWidgetProps
• RelatedFeedObjectWidgetProps
• RelatedEventsWidgetProps
• PollSuggestionWidgetProps
• MyEventsWidgetProps
• LoyaltyProgramWidgetProps
• GroupRequestsWidgetProps
• GroupMembersWidgetProps
• GroupInvitedWidgetProps
• GroupProps
• EventMembersWidgetProps
• EventInfoWidgetProps
• EventProps
• EventSkeletonProps
• CreateEventWidgetProps
• CommentObjectReplyProps
• CategoryTrendingUsersWidgetProps
• CategoryTrendingFeedWidgetProps
• CategoryProps
• CategoriesSuggestionWidgetProps

Indexable

[p: string]: any

Properties

Property	Type	Description	Overrides
className?	string	Overrides or extends the styles applied to the component. Default null	CardProps.className

Functions

widget()

widget(props): ReactElement<any, string | JSXElementConstructor<any>>

NOTE: Exotic components are not callable.

Parameters

Parameter	Type
props	Pick <WidgetProps, keyof WidgetProps> & RefAttributes<HTMLDivElement>

Returns

ReactElement<any, string | JSXElementConstructor<any>>

Source

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