UNPKG

@selfcommunity/react-ui

Version:

React UI Components to integrate a Community created with SelfCommunity Platform.

70 lines (62 loc) 2.31 kB
import { CacheStrategies } from '@selfcommunity/utils'; import { BaseDialogProps } from '../../shared/BaseDialog'; import { WidgetProps } from '../Widget'; import { PollSnippetProps } from './PollSnippet'; import { VirtualScrollerItemProps } from '../../types/virtualScroller'; export interface PollSuggestionWidgetProps extends VirtualScrollerItemProps, WidgetProps { /** * Hides this component * @default false */ autoHide?: boolean; /** * Limit the number of categories to show * @default false */ limit?: number; /** * Props to spread to single category object * @default empty object */ PollSnippetProps?: PollSnippetProps; /** * Caching strategies * @default CacheStrategies.CACHE_FIRST */ cacheStrategy?: CacheStrategies; /** * Props to spread to categories suggestion dialog * @default {} */ DialogProps?: BaseDialogProps; /** * Other props */ [p: string]: any; } /** * > API documentation for the Community-JS Poll Suggestion Widget component. Learn about the available props and the CSS API. * * * This component renders a list of suggested polls. * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/PollSuggestion) #### Import ```jsx import {PollSuggestionWidget} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCPollSuggestionWidget` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCPollSuggestionWidget-root|Styles applied to the root element.| |title|.SCPollSuggestionWidget-title|Styles applied to the title element.| |noResults|.SCPollSuggestionWidget-no-results|Styles applied to no results section.| |showMore|.SCPollSuggestionWidget-show-more|Styles applied to show more button element.| |dialogRoot|.SCPollSuggestionWidget-dialog-root|Styles applied to the root dialog element.| |endMessage|.SCPollSuggestionWidget-end-message|Styles applied to the end message element.| |pollSnippet|.SCPollSuggestionWidget-poll-snippet|Styles applied to the poll snippet element.| * * @param inProps */ export default function PollSuggestionWidget(inProps: PollSuggestionWidgetProps): JSX.Element;