@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
74 lines (68 loc) • 2.6 kB
TypeScript
import { CacheStrategies } from '@selfcommunity/utils';
import { BaseDialogProps } from '../../shared/BaseDialog';
import { IncubatorProps } from '../Incubator';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
export interface IncubatorListWidgetProps 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 List Widget component. Learn about the available props and the CSS API.
*
*
* This component renders a list of incubators.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/IncubatorsList)
#### Import
```jsx
import {IncubatorListWidget} from '@selfcommunity/react-ui';
```
#### Component Name
The name `IncubatorListWidget` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCIncubatorListWidget-root|Styles applied to the root element.|
|header|.SCIncubatorListWidget-header|Styles applied to the header element.|
|title|.SCIncubatorListWidget-title|Styles applied to the title element.|
|noResults|.SCIncubatorListWidget-no-results|Styles applied to the no results section.|
|showMore|.SCIncubatorListWidget-show-more|Styles applied to the show more button element.|
|actions|.SCIncubatorListWidget-actions|Styles applied to the actions section.|
|helpPopover|.SCIncubatorListWidget-help-popover|Styles applied to the help popover element.|
|dialogRoot|.SCIncubatorListWidget-dialog-root|Styles applied to the root dialog element.|
|endMessage|.SCIncubatorListWidget-end-message|Styles applied to the end message element.|
|createDialog|.SCIncubatorListWidget-create-dialog|Styles applied to the create dialog element.|
* @param inProps
*/
export default function IncubatorListWidget(inProps: IncubatorListWidgetProps): JSX.Element;