Skip to main content

PlatformWidget

Interfaces

PlatformWidgetProps

Extends

  • VirtualScrollerItemProps

Indexable

[p: string]: any

Other props

Properties

PropertyTypeDescriptionInherited from
autoHide?booleanHides this component Default false-
className?stringOverrides or extends the styles applied to the component. Default null-
endActions?PlatformWidgetActionType[]Actions to be inserted after-
hideConsoleAction?boolean--
hideContactUsAction?boolean--
hideHubAction?booleanHide actions-
hideModerationAction?boolean--
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
startActions?PlatformWidgetActionType[]Actions to be inserted before-
title?ReactNodeOverrides or extends the styles applied to the component. Default null-

Functions

PlatformWidget()

PlatformWidget(inProps): Element

API documentation for the Community-JS PlatformWidget component. Learn about the available props and the CSS API.

This component renders a widget containing the links that allow users and moderators to handle their application content. Take a look at our demo component here

Import

import {PlatformWidget} from '@selfcommunity/react-ui';

Component Name

The name SCPlatformWidget can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCPlatformWidget-rootStyles applied to the root element.
title.SCPlatformWidget-titleStyles applied to the title element.
actions.SCPlatformWidget-actionsStyles applied to the actions container.
action.SCPlatformWidget-actionStyles applied to the single action element.
actionHighlighted.SCPlatformWidget-action-highlightedStyles applied to the action highlighted.
tutorial.SCPlatformWidget-tutorialStyles applied to the tutorial element.
tutorialContent.SCPlatformWidget-tutorial-contentStyles applied to the content of the tutorial element.
tutorialTitle.SCPlatformWidget-tutorial-titleStyles applied to the title element of the tutorial.
tutorialTitleClose.SCPlatformWidget-tutorial-title-closeStyles applied to the close button of the title in the tutorial.
tutorialDesc.SCPlatformWidget-tutorial-descStyles applied to the tutorial description element.
tutorialOpen.SCPlatformWidget-tutorial-openStyles applied to the tutorial element when is active.
divider.SCPlatformWidget-dividerStyles applied to the divider element in the tutorial container.
tutorialControls.SCPlatformWidget-tutorial-controlsStyles applied to the tutorial bottom controls.
btnStep.SCPlatformWidget-btn-stepStyles applied to the button next/previous/skip/close of the tutorial controls.
btnPreviousStep.SCPlatformWidget-btn-previous-stepStyles applied to the button previous element of the tutorial controls.
btnNextStep.SCPlatformWidget-btn-next-stepStyles applied to the button next element of the tutorial controls.

Parameters

ParameterTypeDescription
inPropsPlatformWidgetProps

Returns

Element


PlatformWidgetSkeleton()

PlatformWidgetSkeleton(props): Element

API documentation for the Community-JS Platform Skeleton component. Learn about the available props and the CSS API.

Import

import {PlatformWidgetSkeleton} from '@selfcommunity/react-ui';

Component Name

The name SCPlatformWidget-skeleton-root can be used when providing style overrides in the theme.

CSS

Rule NameGlobal classDescription
root.SCPlatformWidget-skeleton-rootStyles applied to the root element.

Parameters

ParameterType
propsany

Returns

Element