OnBoardingWidget
Interfaces
OnBoardingWidgetProps
Extends
VirtualScrollerItemProps
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
GenerateContentsParams? | StartStepParams | The params to add to content step generation Default {} | - |
className? | string | Overrides or extends the styles applied to the component. Default null | - |
onGeneratedContent? | (feedObjs: SCFeedObjectType[]) => void | The callback to pass to the feeds to publish the generated content Default null | - |
onHeightChange? | () => void | Must be called whenever a list item's height changes (for example, when a user clicks an "Expand"/"Collapse" button of a list item): it re-measures the item's height and updates VirtualScroller layout. Every change in an item's height must come as a result of changing some kind of a state, be it the item's state in VirtualScroller via .onItemStateChange(), or some other state managed by the application. Call this method to re-measure the current element. | VirtualScrollerItemProps.onHeightChange |
onStateChange? | (state: any) => void | Save current state and when the component re-mount restore previous state using props. It is used to keep a copy of VirtualScroller state so that it could be quickly restored in case the VirtualScroller component gets unmounted and then re-mounted back again — for example, when the user navigates away by clicking on a list item and then navigates "Back" to the list. | VirtualScrollerItemProps.onStateChange |
Functions
OnBoardingWidget()
OnBoardingWidget(
inProps):Element
Parameters
| Parameter | Type |
|---|---|
inProps | OnBoardingWidgetProps |
Returns
Element
Source
packages/react-ui/src/components/OnBoardingWidget/OnBoardingWidget.tsx:105
OnBoardingWidgetSkeleton()
OnBoardingWidgetSkeleton():
JSX.Element
Returns
JSX.Element
Source
packages/react-ui/src/components/OnBoardingWidget/Skeleton.tsx:19