GroupInvitedWidget

Interfaces

GroupInvitedWidgetProps

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

• VirtualScrollerItemProps.WidgetProps

Indexable

[p: string]: any

Properties

Property	Type	Description	Inherited from
DialogProps?	BaseDialogProps	Props to spread to followers users dialog Default {}	-
UserProps?	UserProps	Props to spread to single user object Default empty object	-
cacheStrategy?	CacheStrategies	Caching strategies Default CacheStrategies.CACHE_FIRST	-
className?	string	Overrides or extends the styles applied to the component. Default null	WidgetProps.className
group?	SCGroupType	Group Object Default null	-
groupId?	string | number	Id of the group Default null	-
limit?	number	Limit the number of users to show Default false	-
onHeightChange?	() => void	Must be called whenever a list item's height changes (for example, when a user clicks an "Expand"/"Collapse" button of a list item): it re-measures the item's height and updates VirtualScroller layout. Every change in an item's height must come as a result of changing some kind of a state, be it the item's state in VirtualScroller via .onItemStateChange(), or some other state managed by the application. Call this method to re-measure the current element.	VirtualScrollerItemProps.onHeightChange
onStateChange?	(state: any) => void	Save current state and when the component re-mount restore previous state using props. It is used to keep a copy of VirtualScroller state so that it could be quickly restored in case the VirtualScroller component gets unmounted and then re-mounted back again — for example, when the user navigates away by clicking on a list item and then navigates "Back" to the list.	VirtualScrollerItemProps.onStateChange

Functions

GroupInvitedWidget()

GroupInvitedWidget(inProps): JSX.Element

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

This component renders the list of users who have been invited to join the specified group.

Import

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

Component Name

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

CSS

Rule Name	Global class	Description
root	.SCGroupInvitedWidget-root	Styles applied to the root element.
title	.SCGroupInvitedWidget-title	Styles applied to the title element.
noResults	.SCGroupInvitedWidget-no-results	Styles applied to no results section.
showMore	.SCGroupInvitedWidget-show-more	Styles applied to show more button element.
dialogRoot	.SCGroupInvitedWidget-dialog-root	Styles applied to the dialog root element.
endMessage	.SCGroupInvitedWidget-end-message	Styles applied to the end message element.

Parameters

Parameter	Type	Description
inProps	GroupInvitedWidgetProps

Returns

JSX.Element

Source

packages/react-ui/src/components/GroupInvitedWidget/GroupInvitedWidget.tsx:124

---

GroupInvitedWidgetSkeleton()

GroupInvitedWidgetSkeleton(props): JSX.Element

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

Import

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

Component Name

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

CSS

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

Parameters

Parameter	Type
props	WidgetProps

Returns

JSX.Element

Source

packages/react-ui/src/components/GroupInvitedWidget/Skeleton.tsx:36