Skip to main content

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

Extends

Indexable

[p: string]: any

Other props

Properties

PropertyTypeDescriptionInherited from
autoHide?booleanHides this component Default false-
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 users suggestion dialog Default {}-
limit?numberLimit the number of categories 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

UserSuggestionWidget()

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

Parameters

ParameterTypeDescription
inPropsUserSuggestionWidgetProps

Returns

Element


UserSuggestionWidgetSkeleton()

UserSuggestionWidgetSkeleton(props): 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 NameGlobal classDescription
root.SCUserSuggestionWidget-skeleton-rootStyles applied to the root element.
list.SCUserSuggestionWidget-listStyles applied to the list element.

Parameters

ParameterType
propsany

Returns

Element