CustomAdv
Interfaces
CustomAdvProps
Extends
VirtualScrollerItemProps
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
advId? | number | Advertising id | - |
categoriesId? | number[] | Category ids if the adv must be related to specific categories | - |
className? | string | Overrides or extends the styles applied to the component. Default null | - |
groupsId? | number[] | Group ids if the adv must be related to specific groups | - |
id? | string | Id of the feed object Default 'custom_adv' | - |
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 |
position? | SCCustomAdvPosition | Position of the ADV | - |
prefixedHeight? | number | Prefixed height. Usefull to re-mount item on scroll feed. | - |
Functions
CustomAdv()
CustomAdv(
inProps):JSX.Element
API documentation for the Community-JS CustomAdv component. Learn about the available props and the CSS API.
This component renders custom adv banners. Take a look at our demo component here
Import
import {CustomAdv} from '@selfcommunity/react-ui';
Component Name
The name SCCustomAdv can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCCustomAdv-root | Styles applied to the root element. |
| wrap | .SCCustomAdv-wrap | Styles applied to wrap an element. |
| image | .SCCustomAdv-image | Styles applied to the image element. |
| embedCode | .SCCustomAdv-embed-code | Styles applied to the embed code section. |
| prefixedHeight | .SCCustomAdv-prefixed-height | Styles applied to handle a prefixed height. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | CustomAdvProps |
Returns
JSX.Element
Source
packages/react-ui/src/components/CustomAdv/CustomAdv.tsx:91
CustomAdvSkeleton()
CustomAdvSkeleton():
JSX.Element
API documentation for the Community-JS Custom Adv Skeleton component. Learn about the available props and the CSS API.
Import
import {CustomAdvSkeleton} from '@selfcommunity/react-ui';
Component Name
The name SCCustomAdv-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCCustomAdv-skeleton-root | Styles applied to the root element. |
Returns
JSX.Element