@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
215 lines (209 loc) • 13 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const tslib_1 = require("tslib");
const jsx_runtime_1 = require("react/jsx-runtime");
const react_1 = tslib_1.__importStar(require("react"));
const styles_1 = require("@mui/material/styles");
const material_1 = require("@mui/material");
const api_services_1 = require("@selfcommunity/api-services");
const utils_1 = require("@selfcommunity/utils");
const Skeleton_1 = tslib_1.__importDefault(require("./Skeleton"));
const Errors_1 = require("../../constants/Errors");
const react_intl_1 = require("react-intl");
const Category_1 = tslib_1.__importStar(require("../Category"));
const classnames_1 = tslib_1.__importDefault(require("classnames"));
const BaseDialog_1 = tslib_1.__importDefault(require("../../shared/BaseDialog"));
const InfiniteScroll_1 = tslib_1.__importDefault(require("../../shared/InfiniteScroll"));
const Widget_1 = tslib_1.__importDefault(require("../Widget"));
const system_1 = require("@mui/system");
const HiddenPlaceholder_1 = tslib_1.__importDefault(require("../../shared/HiddenPlaceholder"));
const react_core_1 = require("@selfcommunity/react-core");
const widget_1 = require("../../utils/widget");
const constants_1 = require("./constants");
const pubsub_js_1 = tslib_1.__importDefault(require("pubsub-js"));
const PubSub_1 = require("../../constants/PubSub");
const classes = {
root: `${constants_1.PREFIX}-root`,
title: `${constants_1.PREFIX}-title`,
noResults: `${constants_1.PREFIX}-no-results`,
showMore: `${constants_1.PREFIX}-show-more`,
dialogRoot: `${constants_1.PREFIX}-dialog-root`,
endMessage: `${constants_1.PREFIX}-end-message`
};
const Root = (0, styles_1.styled)(Widget_1.default, {
name: constants_1.PREFIX,
slot: 'Root'
})(() => ({}));
const DialogRoot = (0, styles_1.styled)(BaseDialog_1.default, {
name: constants_1.PREFIX,
slot: 'DialogRoot'
})(() => ({}));
/**
* > API documentation for the Community-JS Categories Popular widget component. Learn about the available props and the CSS API.
*
*
* This component renders a list of popular categories.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/CategoriesPopular)
#### Import
```jsx
import {CategoriesPopular} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCCategoriesPopularWidget` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCCategoriesPopularWidget-root|Styles applied to the root element.|
|title|.SCCategoriesPopularWidget-title|Styles applied to the title element.|
|noResults|.SCCategoriesPopularWidget-no-results|Styles applied to no results section.|
|showMore|.SCCategoriesPopularWidget-show-more|Styles applied to show more button element.|
|dialogRoot|.SCCategoriesPopularWidget-dialog-root|Styles applied to the root dialog element.|
|endMessage|.SCCategoriesPopularWidget-end-message|Styles applied to the end message element.|
* @param inProps
*/
function CategoriesPopularWidget(inProps) {
// PROPS
const props = (0, system_1.useThemeProps)({
props: inProps,
name: constants_1.PREFIX
});
const { autoHide = true, limit = 3, className, CategoryProps = {}, cacheStrategy = utils_1.CacheStrategies.CACHE_FIRST, onHeightChange, onStateChange, DialogProps = {}, categoryId } = props, // Removed from root DOM
rest = tslib_1.__rest(props, ["autoHide", "limit", "className", "CategoryProps", "cacheStrategy", "onHeightChange", "onStateChange", "DialogProps", "categoryId"]);
// CONTEXT
const scUserContext = (0, react_1.useContext)(react_core_1.SCUserContext);
const scPreferencesContext = (0, react_1.useContext)(react_core_1.SCPreferencesContext);
const contentAvailability = (0, react_1.useMemo)(() => react_core_1.SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY in scPreferencesContext.preferences &&
scPreferencesContext.preferences[react_core_1.SCPreferences.CONFIGURATIONS_CONTENT_AVAILABILITY].value, [scPreferencesContext]);
// STATE
const [state, dispatch] = (0, react_1.useReducer)(widget_1.dataWidgetReducer, {
isLoadingNext: false,
next: null,
cacheKey: react_core_1.SCCache.getWidgetStateCacheKey(react_core_1.SCCache.CATEGORIES_POPULAR_TOOLS_STATE_CACHE_PREFIX_KEY),
cacheStrategy,
visibleItems: limit
}, widget_1.stateWidgetInitializer);
const [openDialog, setOpenDialog] = (0, react_1.useState)(false);
// HOOKS
const theme = (0, material_1.useTheme)();
const isMobile = (0, material_1.useMediaQuery)(theme.breakpoints.down('md'));
// REFS
const updatesSubscription = (0, react_1.useRef)(null);
/**
* Initialize component
* Fetch data only if the component is not initialized and it is not loading data
*/
const _initComponent = (0, react_1.useMemo)(() => () => {
if (!state.initialized && !state.isLoadingNext) {
dispatch({ type: widget_1.actionWidgetTypes.LOADING_NEXT });
api_services_1.CategoryService.getPopularCategories({ limit })
.then((payload) => {
dispatch({ type: widget_1.actionWidgetTypes.LOAD_NEXT_SUCCESS, payload: Object.assign(Object.assign({}, payload), { initialized: true }) });
})
.catch((error) => {
dispatch({ type: widget_1.actionWidgetTypes.LOAD_NEXT_FAILURE, payload: { errorLoadNext: error } });
utils_1.Logger.error(Errors_1.SCOPE_SC_UI, error);
});
}
}, [state.isLoadingNext, state.initialized, limit, dispatch]);
/**
* Subscriber for pubsub callback
*/
const onEditCategoryHandler = (0, react_1.useCallback)((_msg, edited) => {
const _categories = [...state.results];
const updatedCategories = _categories.map((c) => (c.id === edited.id ? Object.assign(Object.assign({}, c), edited) : c));
dispatch({ type: widget_1.actionWidgetTypes.SET_RESULTS, payload: { results: updatedCategories } });
}, [dispatch, state.results]);
/**
* On mount, subscribe to receive event updates (only edit)
*/
(0, react_1.useEffect)(() => {
updatesSubscription.current = pubsub_js_1.default.subscribe(`${PubSub_1.SCTopicType.CATEGORY}.${PubSub_1.SCCategoryEventType.EDIT}`, onEditCategoryHandler);
return () => {
updatesSubscription.current && pubsub_js_1.default.unsubscribe(updatesSubscription.current);
};
}, [onEditCategoryHandler]);
// EFFECTS
(0, react_1.useEffect)(() => {
var _a;
let _t;
if (scUserContext.user !== undefined && (contentAvailability || (!contentAvailability && ((_a = scUserContext.user) === null || _a === void 0 ? void 0 : _a.id)))) {
_t = setTimeout(_initComponent);
return () => {
_t && clearTimeout(_t);
};
}
}, [scUserContext.user, contentAvailability]);
(0, react_1.useEffect)(() => {
if (openDialog && state.next && state.initialized && state.results.length === limit) {
api_services_1.CategoryService.getPopularCategories({ offset: limit, limit: 10 })
.then((payload) => {
dispatch({ type: widget_1.actionWidgetTypes.LOAD_NEXT_SUCCESS, payload: payload });
})
.catch((error) => {
dispatch({ type: widget_1.actionWidgetTypes.LOAD_NEXT_FAILURE, payload: { errorLoadNext: error } });
utils_1.Logger.error(Errors_1.SCOPE_SC_UI, error);
});
}
}, [openDialog, limit, state.next, state.initialized, state.results.length]);
/**
* Virtual feed update
*/
(0, react_1.useEffect)(() => {
onHeightChange && onHeightChange();
}, [state.results]);
(0, react_1.useEffect)(() => {
if (!contentAvailability && !scUserContext.user) {
return;
}
else if (cacheStrategy === utils_1.CacheStrategies.NETWORK_ONLY) {
onStateChange && onStateChange({ cacheStrategy: utils_1.CacheStrategies.CACHE_FIRST });
}
}, [contentAvailability, cacheStrategy, scUserContext.user]);
// HANDLERS
/**
* Fetches popular categories list
*/
const handleNext = (0, react_1.useMemo)(() => () => {
dispatch({ type: widget_1.actionWidgetTypes.LOADING_NEXT });
api_services_1.http
.request({
url: state.next,
method: api_services_1.Endpoints.PopularCategories.method
})
.then((res) => {
dispatch({ type: widget_1.actionWidgetTypes.LOAD_NEXT_SUCCESS, payload: res.data });
});
}, [dispatch, state.next, state.isLoadingNext, state.initialized]);
/**
* Update counters above the category name and the user follow state
* @param category
*/
const handleFollowersUpdate = (category) => {
const newCategories = [...state.results];
const index = newCategories.findIndex((u) => u.id === category.id);
if (index !== -1) {
if (category.followed) {
newCategories[index].followers_counter = category.followers_counter - 1;
newCategories[index].followed = !category.followed;
}
else {
newCategories[index].followers_counter = category.followers_counter + 1;
newCategories[index].followed = !category.followed;
}
dispatch({ type: widget_1.actionWidgetTypes.SET_RESULTS, payload: { results: newCategories } });
}
};
const handleToggleDialogOpen = () => {
setOpenDialog((prev) => !prev);
};
// RENDER
if ((!contentAvailability && !scUserContext.user) || (state.initialized && autoHide && !state.count)) {
return (0, jsx_runtime_1.jsx)(HiddenPlaceholder_1.default, {});
}
if (!state.initialized) {
return (0, jsx_runtime_1.jsx)(Skeleton_1.default, {});
}
const content = ((0, jsx_runtime_1.jsxs)(material_1.CardContent, { children: [(0, jsx_runtime_1.jsx)(material_1.Typography, Object.assign({ className: classes.title, variant: "h5" }, { children: (0, jsx_runtime_1.jsx)(react_intl_1.FormattedMessage, { id: "ui.categoriesPopularWidget.title", defaultMessage: "ui.categoriesPopularWidget.title" }) })), !state.count ? ((0, jsx_runtime_1.jsx)(material_1.Typography, Object.assign({ className: classes.noResults, variant: "body2" }, { children: (0, jsx_runtime_1.jsx)(react_intl_1.FormattedMessage, { id: "ui.categoriesPopularWidget.noResults", defaultMessage: "ui.categoriesPopularWidget.noResults" }) }))) : ((0, jsx_runtime_1.jsxs)(react_1.default.Fragment, { children: [(0, jsx_runtime_1.jsx)(material_1.List, { children: state.results.slice(0, state.visibleItems).map((category) => ((0, jsx_runtime_1.jsx)(material_1.ListItem, { children: (0, jsx_runtime_1.jsx)(Category_1.default, Object.assign({ elevation: 0, category: category, categoryFollowButtonProps: { onFollow: handleFollowersUpdate } }, CategoryProps)) }, category.id))) }), state.count > state.visibleItems && ((0, jsx_runtime_1.jsx)(material_1.Button, Object.assign({ className: classes.showMore, onClick: handleToggleDialogOpen }, { children: (0, jsx_runtime_1.jsx)(react_intl_1.FormattedMessage, { id: "ui.categoriesPopularWidget.button.showAll", defaultMessage: "ui.categoriesPopularWidget.button.showAll" }) })))] })), openDialog && ((0, jsx_runtime_1.jsx)(DialogRoot, Object.assign({ className: classes.dialogRoot, title: (0, jsx_runtime_1.jsx)(react_intl_1.FormattedMessage, { defaultMessage: "ui.categoriesPopularWidget.title", id: "ui.categoriesPopularWidget.title" }), onClose: handleToggleDialogOpen, open: openDialog }, DialogProps, { children: (0, jsx_runtime_1.jsx)(InfiniteScroll_1.default, Object.assign({ dataLength: state.results.length, next: handleNext, hasMoreNext: Boolean(state.next), loaderNext: (0, jsx_runtime_1.jsx)(Category_1.CategorySkeleton, Object.assign({ elevation: 0 }, CategoryProps)), height: isMobile ? '100%' : 400, endMessage: (0, jsx_runtime_1.jsx)(material_1.Typography, Object.assign({ className: classes.endMessage }, { children: (0, jsx_runtime_1.jsx)(react_intl_1.FormattedMessage, { id: "ui.categoriesPopularWidget.noMoreResults", defaultMessage: "ui.categoriesPopularWidget.noMoreResults" }) })) }, { children: (0, jsx_runtime_1.jsx)(material_1.List, { children: state.results.map((c) => ((0, jsx_runtime_1.jsx)(material_1.ListItem, { children: (0, jsx_runtime_1.jsx)(Category_1.default, Object.assign({ elevation: 0, category: c }, CategoryProps, { categoryFollowButtonProps: { onFollow: handleFollowersUpdate } })) }, c.id))) }) })) })))] }));
return ((0, jsx_runtime_1.jsx)(Root, Object.assign({ className: (0, classnames_1.default)(classes.root, className) }, rest, { children: content })));
}
exports.default = CategoriesPopularWidget;