CategoriesSuggestionWidget

Interfaces

CategoriesSuggestionWidgetProps

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

Other props

Properties

Property	Type	Description	Inherited from
autoHide?	boolean	Hides this component Default false	-
cacheStrategy?	CacheStrategies	Caching strategies Default CacheStrategies.CACHE_FIRST	-
CategoryProps?	CategoryProps	Props to spread to single category object Default empty object	-
className?	string	Overrides or extends the styles applied to the component. Default null	WidgetProps.className
DialogProps?	BaseDialogProps	Props to spread to categories suggestion dialog Default {}	-
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) => 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

CategoriesSuggestionWidget()

CategoriesSuggestionWidget(inProps): Element

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

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

Import

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

Component Name

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

CSS

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

Parameters

Parameter	Type	Description
inProps	CategoriesSuggestionWidgetProps

Returns

Element

---

CategoriesSuggestionWidgetSkeleton()

CategoriesSuggestionWidgetSkeleton(props): Element

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

Import

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

Component Name

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

CSS

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

Parameters

Parameter	Type
props	any

Returns

Element