UserSuggestionWidget

Interfaces

UserSuggestionWidgetProps

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 users suggestion dialog Default {}	-
UserProps?	UserProps	Props to spread to single user object Default empty object	-
autoHide?	boolean	Hides this component Default false	-
cacheStrategy?	CacheStrategies	Caching strategies Default CacheStrategies.CACHE_FIRST	-
className?	string	Overrides or extends the styles applied to the component. Default null	WidgetProps.className
limit?	number	Limit the number of categories 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

UserSuggestionWidget()

UserSuggestionWidget(inProps): JSX.Element

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

This component renders a list of suggested users. Take a look at our demo component here

Import

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

Component Name

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

CSS

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

Parameters

Parameter	Type	Description
inProps	UserSuggestionWidgetProps

Returns

JSX.Element

Source

packages/react-ui/src/components/UserSuggestionWidget/UserSuggestionWidget.tsx:115

---

UserSuggestionWidgetSkeleton()

UserSuggestionWidgetSkeleton(props): JSX.Element

API documentation for the Community-JS People Suggestion Skeleton component. Learn about the available props and the CSS API.

Import

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

Component Name

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

CSS

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

Parameters

Parameter	Type
props	any

Returns

JSX.Element

Source

packages/react-ui/src/components/UserSuggestionWidget/Skeleton.tsx:39