@selfcommunity/react-templates
Version:
React Templates Components to integrate a Community created with SelfCommunity.
76 lines (69 loc) • 2.14 kB
TypeScript
import { CommentsFeedObjectProps, FeedObjectProps, FeedSidebarProps, RelatedFeedObjectWidgetProps } from '@selfcommunity/react-ui';
import { SCContributionType, SCFeedObjectType } from '@selfcommunity/types';
export interface FeedObjectDetailProps {
/**
* Id of the feed object
* @default 'feed'
*/
id?: string;
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* Id of feed object
* @default null
*/
feedObjectId?: number | string;
/**
* Feed object
* @default null
*/
feedObject?: SCFeedObjectType;
/**
* Type of feed object
* @default SCContributionType.POST
*/
feedObjectType?: Exclude<SCContributionType, SCContributionType.COMMENT>;
/**
* Props to spread to single feed object
* @default empty object
*/
FeedObjectProps?: FeedObjectProps;
/**
* Props to spread to the sidebar
* @default {}
*/
FeedSidebarProps?: FeedSidebarProps;
/**
* Props to spread to CommentsFeedObject
* @default empty object
*/
CommentsFeedObjectProps?: CommentsFeedObjectProps;
/**
* Props to spread to RelatedFeedObject
* @default empty object
*/
RelatedFeedObjectProps?: RelatedFeedObjectWidgetProps;
}
/**
* > API documentation for the Community-JS Feed Object Detail Template. Learn about the available props and the CSS API.
*
*
* This component renders a specific feed object detail template.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-templates/Components/FeedObjectDetail)
#### Import
```jsx
import {FeedObjectDetail} from '@selfcommunity/react-templates';
```
#### Component Name
The name `SCFeedObjectDetailTemplate` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCFeedObjectDetailTemplate-root|Styles applied to the root element.|
*
* @param inProps
*/
export default function FeedObjectDetail(inProps: FeedObjectDetailProps): JSX.Element;