Interface: FeedProps
Feed.FeedProps
Properties
CustomAdvProps
• Optional CustomAdvProps: CustomAdvProps
Props to spread to single custom adv element (this props can be used only if Custom Adv are enabled)
Default
{}
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:193
FeedSidebarProps
• Optional FeedSidebarProps: StickyBoxProps
Props to spread to the sidebar
Default
{}
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:187
FooterComponent
• Optional FooterComponent: ElementType<any>
Component used as footer. It will be displayed after the end messages
Default
<Footer>
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:116
FooterComponentProps
• Optional FooterComponentProps: any
Props to spread to FooterComponent
Default
empty object
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:122
HeaderComponent
• Optional HeaderComponent: Element
Component used as header. It will be displayed at the beginning of the feed
Default
null
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:110
ItemComponent
• ItemComponent: ElementType<any>
Component used to render single feed item retrieved by the endpoint
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:133
ItemProps
• Optional ItemProps: any
Props to spread to single feed item
Default
empty object
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:149
ItemSkeleton
• ItemSkeleton: ElementType<any>
Skeleton used to render loading effect during fetch
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:154
ItemSkeletonProps
• Optional ItemSkeletonProps: any
Props to spread to single feed item skeleton
Default
empty object
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:160
PaginationLinkProps
• Optional PaginationLinkProps: Record<string, any>
Props to spread to the pagination Link component
Default
{}
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:243
VirtualizedScrollerProps
• Optional VirtualizedScrollerProps: VirtualizedScrollerCommonProps
Props to spread to VirtualizedScroller object.
Default
{}
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:219
cacheStrategy
• Optional cacheStrategy: CacheStrategies
Caching strategies
Default
CacheStrategies.CACHE_FIRST
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:181
className
• Optional className: string
Overrides or extends the styles applied to the component.
Default
null
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:81
disablePaginationLinks
• Optional disablePaginationLinks: boolean
Add/remove pagination links on top/bottom of items
Default
false
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:225
enabledCustomAdvPositions
• Optional enabledCustomAdvPositions: SCCustomAdvPosition[]
Props to programmatically enable the custom adv position in the feed
Default
[SCCustomAdvPosition.POSITION_FEED_SIDEBAR, SCCustomAdvPosition.POSITION_FEED]
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:199
endMessage
• Optional endMessage: ReactNode
End message, rendered when no more feed item can be displayed
Default
<FormattedMessage id="ui.feed.noOtherFeedObject" defaultMessage="ui.feed.noOtherFeedObject" />
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:98
endpoint
• endpoint: EndpointType
Feed API Endpoint
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:86
endpointQueryParams
• Optional endpointQueryParams: Record<string, string | number>
Feed API Query Params
Default
[{'limit': 5}]
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:92
hideAdvs
• Optional hideAdvs: boolean
Show/hide adv banners
Default
false
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:249
hidePaginationLinks
• Optional hidePaginationLinks: boolean
Show/hide pagination links
Default
true
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:231
id
• Optional id: string
Id of the feed object
Default
'feed'
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:75
itemIdGenerator
• itemIdGenerator: (item: any) => any
Type declaration
▸ (item): any
Function used to generate an id from the single result returned by the Endpoint
Parameters
| Name | Type |
|---|---|
item | any |
Returns
any
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:143
itemPropsGenerator
• itemPropsGenerator: (scUser: SCUserType, item: any) => any
Type declaration
▸ (scUser, item): any
Function used to convert the single result returned by the Endpoint into the props necessary to render the ItemComponent
Parameters
| Name | Type |
|---|---|
scUser | SCUserType |
item | any |
Returns
any
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:138
onNextData
• Optional onNextData: (page: number, offset: number, total: number, data: any[]) => any
Type declaration
▸ (page, offset, total, data): any
Callback invoked whenever data is loaded during paging next
Parameters
| Name | Type |
|---|---|
page | number |
offset | number |
total | number |
data | any[] |
Returns
any
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:165
onPreviousData
• Optional onPreviousData: (page: number, offset: number, total: number, data: any[]) => any
Type declaration
▸ (page, offset, total, data): any
Callback invoked whenever data is loaded during paging previous
Parameters
| Name | Type |
|---|---|
page | number |
offset | number |
total | number |
data | any[] |
Returns
any
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:170
paginationLinksPageQueryParam
• Optional paginationLinksPageQueryParam: string
Page query parameter name
Default
'page'
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:237
prefetchedData
• Optional prefetchedData: SCPaginatedResponse<SCFeedUnitType>
Prefetch data. Useful for SSR. Use this to init the component (in particular useSCFetchFeed)
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:205
refreshMessage
• Optional refreshMessage: ReactNode
Refresh message, rendered when no more feed item can be displayed
Default
<FormattedMessage id="ui.feed.refreshRelease" defaultMessage="ui.feed.refreshRelease" />
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:104
requireAuthentication
• Optional requireAuthentication: boolean
Authenticated or not
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:175
scrollableTargetId
• Optional scrollableTargetId: string
If the feed is being rendered in a "scrollable container" (for example, if one of the parent elements of the list is styled with max-height and overflow: auto), then passing the "scrollableTargetId"
Defined in
packages/react-ui/src/components/Feed/Feed.tsx:213
widgets
• Optional widgets: SCFeedWidgetType[]
Widgets to insert into the feed
Default
empty array