@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
71 lines (66 loc) • 1.96 kB
TypeScript
import { ButtonProps } from '@mui/material';
import { SCIncubatorType } from '@selfcommunity/types';
import { IncubatorSubscribeButtonProps } from '../IncubatorSubscribeButton';
export interface IncubatorProps {
/**
* Incubator object id
* @default null
*/
incubatorId?: number;
/**
* Incubator object
* @default null
*/
incubator?: SCIncubatorType;
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Hides this component
* @default false
*/
autoHide?: boolean;
/**
* Props to spread to subscribe button
* @default {}
*/
subscribeButtonProps?: IncubatorSubscribeButtonProps;
/**
* Any other properties
*/
[p: string]: any;
/**
* Default props to submit button Input
* @default {}
*/
ButtonProps?: ButtonProps;
/**
* If true shows extended incubator' slogan in detail view
* @default false
*/
detailView?: boolean;
}
/**
* > API documentation for the Community-JS Incubator component. Learn about the available props and the CSS API.
*
*
* This component renders an incubator item.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/Incubator)
#### Import
```jsx
import {Incubator} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCIncubator` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCIncubator-root|Styles applied to the root element.|
|name|.SCIncubator-name|Styles applied to the name section.|
|slogan|.SCIncubator-slogan|Styles applied to the slogan section.|
|progressBar|.SCIncubator-progress-bar|Styles applied to the progress bar element.|
* @param inProps
*/
export default function Incubator(inProps: IncubatorProps): JSX.Element;