@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
33 lines (32 loc) • 1.05 kB
TypeScript
import { StartStepParams } from '@selfcommunity/api-services';
import { SCFeedObjectType, SCOnBoardingStepType } from '@selfcommunity/types';
import { VirtualScrollerItemProps } from '../../types/virtualScroller';
export interface OnBoardingWidgetProps extends VirtualScrollerItemProps {
/**
* Overrides or extends the styles applied to the component.
* @default null
*/
className?: string;
/**
* The params to add to content step generation
* @default {}
*/
GenerateContentsParams?: StartStepParams;
/**
* The callback to pass to the feeds to publish the generated content
* @param feedObj
* @default null
*/
onGeneratedContent?: (feedObjs: SCFeedObjectType[]) => void;
/**
* Force widget expanded
* @default false
*/
forceExpanded?: boolean;
/**
* The initial step to display
*/
initialStep?: SCOnBoardingStepType;
}
declare const OnBoardingWidget: (inProps: OnBoardingWidgetProps) => JSX.Element;
export default OnBoardingWidget;