Skip to main content

CustomAdv

Interfaces

CustomAdvProps

Extends

  • VirtualScrollerItemProps

Properties

PropertyTypeDescriptionInherited from
advId?numberAdvertising id-
categoriesId?number[]Category ids if the adv must be related to specific categories-
className?stringOverrides or extends the styles applied to the component. Default null-
groupsId?number[]Group ids if the adv must be related to specific groups-
id?stringId of the feed object Default 'custom_adv'-
onHeightChange?() => voidMust 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) => voidSave 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?SCCustomAdvPositionPosition of the ADV-
prefixedHeight?numberPrefixed height. Usefull to re-mount item on scroll feed.-

Functions

CustomAdv()

CustomAdv(inProps): 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 NameGlobal classDescription
root.SCCustomAdv-rootStyles applied to the root element.
wrap.SCCustomAdv-wrapStyles applied to wrap an element.
image.SCCustomAdv-imageStyles applied to the image element.
embedCode.SCCustomAdv-embed-codeStyles applied to the embed code section.
prefixedHeight.SCCustomAdv-prefixed-heightStyles applied to handle a prefixed height.

Parameters

ParameterTypeDescription
inPropsCustomAdvProps

Returns

Element


CustomAdvSkeleton()

CustomAdvSkeleton(): 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 NameGlobal classDescription
root.SCCustomAdv-skeleton-rootStyles applied to the root element.

Returns

Element