Skip to main content

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 NameGlobal classDescription
root.SCWidget-rootStyles applied to the root element.

Extends

Indexable

[p: string]: any

Other props

Properties

PropertyTypeDescriptionInherited from
cacheStrategy?CacheStrategiesCaching strategies Default CacheStrategies.CACHE_FIRST-
className?stringOverrides or extends the styles applied to the component. Default nullWidgetProps.className
DialogProps?BaseDialogPropsProps to spread to followers users dialog Default {}-
group?SCGroupTypeGroup Object Default null-
groupId?string | numberId of the group Default null-
limit?numberLimit the number of users to show Default false-
onHeightChange?() => voidMust 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) => voidSave 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
UserProps?UserPropsProps to spread to single user object Default empty object-

Functions

GroupInvitedWidget()

GroupInvitedWidget(inProps): 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 NameGlobal classDescription
root.SCGroupInvitedWidget-rootStyles applied to the root element.
title.SCGroupInvitedWidget-titleStyles applied to the title element.
noResults.SCGroupInvitedWidget-no-resultsStyles applied to no results section.
showMore.SCGroupInvitedWidget-show-moreStyles applied to show more button element.
dialogRoot.SCGroupInvitedWidget-dialog-rootStyles applied to the dialog root element.
endMessage.SCGroupInvitedWidget-end-messageStyles applied to the end message element.

Parameters

ParameterTypeDescription
inPropsGroupInvitedWidgetProps

Returns

Element


GroupInvitedWidgetSkeleton()

GroupInvitedWidgetSkeleton(props): 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 NameGlobal classDescription
root.SCGroupInvitedWidget-skeleton-rootStyles applied to the root element.

Parameters

ParameterType
propsWidgetProps

Returns

Element