@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
68 lines (64 loc) • 2.34 kB
TypeScript
import { SCIncubatorType } from '@selfcommunity/types';
import { IncubatorProps } from '../Incubator';
export interface IncubatorDetailProps {
/**
* Incubator Object
* @default null
*/
incubator?: SCIncubatorType;
/**
* Id of scIncubator object
* @default null
*/
incubatorId?: number;
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Opens dialog
* @default false
*/
open: boolean;
/**
* On dialog close callback function
* @default null
*/
onClose?: () => void;
/**
* Props to spread to single scIncubator object
* @default {}
*/
IncubatorProps?: IncubatorProps;
/**
* Callback fired on subscribe action to update count in main list
* @param scIncubator
*/
onSubscriptionsUpdate?: (scIncubator: any) => any;
}
/**
* > API documentation for the Community-JS Incubator Detail component. Learn about the available props and the CSS API.
#### Import
```jsx
import {IncubatorDetail} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCIncubatorDetail` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCIncubatorDetail-root|Styles applied to the root element.|
|avatar|.SCIncubatorDetail-avatar|Styles applied to the avatar element.|
|title|.SCIncubatorDetail-title|Styles applied to the title element.|
|author|.SCIncubatorDetail-author|Styles applied to the author element.|
|shareCard|.SCIncubatorDetail-share-card|Styles applied to the section card.|
|copyUrlForm|.SCIncubatorDetail-copy-url-form|Styles applied to the url copy section.|
|copyButton|.SCIncubatorDetail-copy-button|Styles applied to the copy button element.|
|copyText|.SCIncubatorDetail-copy-text|Styles applied to the text copy element.|
|shareSection|.SCIncubatorDetail-share-section|Styles applied to the social share section.|
|socialShareButton|.SCIncubatorDetail-social-share-button|Styles applied to the social share button.|
|subscribers|.SCIncubatorDetail-subscribers|Styles applied to the subscribers avatar section.|
* @param inProps
*/
export default function IncubatorDetail(inProps: IncubatorDetailProps): JSX.Element;