UNPKG

@selfcommunity/react-ui

Version:

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

70 lines (64 loc) 2.33 kB
import { CacheStrategies } from '@selfcommunity/utils'; import { BaseDialogProps } from '../../shared/BaseDialog'; import { IncubatorProps } from '../Incubator'; import { VirtualScrollerItemProps } from '../../types/virtualScroller'; export interface IncubatorSuggestionWidgetProps extends VirtualScrollerItemProps { /** * Hides this component * @default false */ autoHide?: boolean; /** * Limit the number of incubators to show * @default false */ limit?: number; /** * Overrides or extends the styles applied to the component. * @default null */ className?: string; /** * Props to spread to single incubator object * @default {} */ IncubatorProps?: IncubatorProps; /** * Caching strategies * @default CacheStrategies.CACHE_FIRST */ cacheStrategy?: CacheStrategies; /** * Props to spread to users suggestion dialog * @default {} */ DialogProps?: BaseDialogProps; /** * Other props */ [p: string]: any; } /** * > API documentation for the Community-JS Incubator Suggestion component. Learn about the available props and the CSS API. * * * This component renders a list of suggested incubators. * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/IncubatorSuggestion) #### Import ```jsx import {IncubatorSuggestionWidget} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCIncubatorSuggestionWidget` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCIncubatorSuggestionWidget-root|Styles applied to the root element.| |title|.SCIncubatorSuggestionWidget-title|Styles applied to the title element.| |noResults|.SCIncubatorSuggestionWidget-no-results|Styles applied to the no results section.| |showMore|.SCIncubatorSuggestionWidget-show-more|Styles applied to the show more button element.| |dialogRoot|.SCIncubatorSuggestionWidget-dialog-root|Styles applied to the root dialog element.| |endMessage|.SCIncubatorSuggestionWidget-end-message|Styles applied to the end message element.| * @param inProps */ export default function IncubatorSuggestionWidget(inProps: IncubatorSuggestionWidgetProps): JSX.Element;