Interface: PollSuggestionWidgetProps
PollSuggestionWidget.PollSuggestionWidgetProps
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. |
Hierarchy
-
VirtualScrollerItemProps -
↳
PollSuggestionWidgetProps
Indexable
▪ [p: string]: any
Other props
Properties
DialogProps
• Optional DialogProps: BaseDialogProps
Props to spread to categories suggestion dialog
Default
{}
Defined in
packages/react-ui/src/components/PollSuggestionWidget/PollSuggestionWidget.tsx:70
PollSnippetProps
• Optional PollSnippetProps: PollSnippetProps
Props to spread to single category object
Default
empty object
Defined in
packages/react-ui/src/components/PollSuggestionWidget/PollSuggestionWidget.tsx:59
autoHide
• Optional autoHide: boolean
Hides this component
Default
false
Defined in
packages/react-ui/src/components/PollSuggestionWidget/PollSuggestionWidget.tsx:49
cacheStrategy
• Optional cacheStrategy: CacheStrategies
Caching strategies
Default
CacheStrategies.CACHE_FIRST
Defined in
packages/react-ui/src/components/PollSuggestionWidget/PollSuggestionWidget.tsx:64
className
• Optional className: string
Overrides or extends the styles applied to the component.
Default
null
Inherited from
Defined in
packages/react-ui/src/components/Widget/index.tsx:45
limit
• Optional limit: number
Limit the number of categories to show
Default
false
Defined in
packages/react-ui/src/components/PollSuggestionWidget/PollSuggestionWidget.tsx:54
onHeightChange
• Optional onHeightChange: () => void
Type declaration
▸ (): 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.
Returns
void
Inherited from
VirtualScrollerItemProps.onHeightChange
Defined in
packages/react-ui/src/types/virtualScroller.ts:28
onStateChange
• Optional onStateChange: (state: any) => void
Type declaration
▸ (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.
Parameters
| Name | Type |
|---|---|
state | any |
Returns
void
Inherited from
VirtualScrollerItemProps.onStateChange