@selfcommunity/react-ui
Version:
React UI Components to integrate a Community created with SelfCommunity Platform.
149 lines (145 loc) • 8.42 kB
JavaScript
import { __rest } from "tslib";
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
import React, { useEffect, useMemo, useReducer, useState } from 'react';
import { Button, CardContent, ListItem, Typography, styled, List } from '@mui/material';
import { CourseService } from '@selfcommunity/api-services';
import { CacheStrategies, isInteger, Logger } from '@selfcommunity/utils';
import { SCCache, SCPreferences, useSCPreferences, useSCUser } from '@selfcommunity/react-core';
import { actionWidgetTypes, dataWidgetReducer, stateWidgetInitializer } from '../../utils/widget';
import { SCCourseJoinStatusType, SCFeatureName } from '@selfcommunity/types';
import { SCOPE_SC_UI } from '../../constants/Errors';
import { FormattedMessage } from 'react-intl';
import Skeleton from './Skeleton';
import classNames from 'classnames';
import BaseDialog from '../../shared/BaseDialog';
import Widget from '../Widget';
import { useThemeProps } from '@mui/system';
import HiddenPlaceholder from '../../shared/HiddenPlaceholder';
import { PREFIX } from './constants';
import Course, { CourseSkeleton } from '../Course';
import { SCCourseTemplateType } from '../../types/course';
const classes = {
root: `${PREFIX}-root`,
title: `${PREFIX}-title`,
noResults: `${PREFIX}-no-results`,
showMore: `${PREFIX}-show-more`,
dialogRoot: `${PREFIX}-dialog-root`,
endMessage: `${PREFIX}-end-message`
};
const Root = styled(Widget, {
name: PREFIX,
slot: 'Root'
})(() => ({}));
const DialogRoot = styled(BaseDialog, {
name: PREFIX,
slot: 'DialogRoot'
})(() => ({}));
/**
* > API documentation for the Community-JS User Profile Courses Created Widget component. Learn about the available props and the CSS API.
*
*
* This component renders the list of the courses that the given user follows.
* Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/UserCreatedCourses)
#### Import
```jsx
import {UserCreatedCoursesWidget} from '@selfcommunity/react-ui';
```
#### Component Name
The name `SCUserCreatedCoursesWidget` can be used when providing style overrides in the theme.
#### CSS
|Rule Name|Global class|Description|
|---|---|---|
|root|.SCUserCreatedCoursesWidget-root|Styles applied to the root element.|
|title|.SCUserCreatedCoursesWidget-title|Styles applied to the title element.|
|noResults|.SCUserCreatedCoursesWidget-no-results|Styles applied to no results section.|
|showMore|.SCUserCreatedCoursesWidget-show-more|Styles applied to show more button element.|
|dialogRoot|.SCUserCreatedCoursesWidget-dialog-root|Styles applied to the root dialog element.|
|endMessage|.SCUserCreatedCoursesWidget-end-message|Styles applied to the end message element.|
* @param inProps
*/
export default function UserCreatedCoursesWidget(inProps) {
// PROPS
const props = useThemeProps({
props: inProps,
name: PREFIX
});
const { userId, limit = 3, className, CourseProps = {}, cacheStrategy = CacheStrategies.NETWORK_ONLY, onHeightChange, onStateChange, DialogProps = {} } = props, rest = __rest(props, ["userId", "limit", "className", "CourseProps", "cacheStrategy", "onHeightChange", "onStateChange", "DialogProps"]);
// CONTEXT
const scUserContext = useSCUser();
const { preferences, features } = useSCPreferences();
const coursesEnabled = useMemo(() => preferences &&
features &&
features.includes(SCFeatureName.COURSE) &&
SCPreferences.CONFIGURATIONS_COURSES_ENABLED in preferences &&
preferences[SCPreferences.CONFIGURATIONS_COURSES_ENABLED].value, [preferences, features]);
// STATE
const [state, dispatch] = useReducer(dataWidgetReducer, {
isLoadingNext: false,
next: null,
cacheKey: SCCache.getWidgetStateCacheKey(SCCache.USER_CREATED_COURSES_STATE_CACHE_PREFIX_KEY, userId),
cacheStrategy
}, stateWidgetInitializer);
const [openDialog, setOpenDialog] = useState(false);
/**
* Initialize component
* Fetch data only if the component is not initialized, and it is not loading data
*/
const _initComponent = useMemo(() => () => {
if (!state.initialized && !state.isLoadingNext) {
CourseService.getUserJoinedCourses(userId, { statuses: SCCourseJoinStatusType.CREATOR })
.then((courses) => {
dispatch({
type: actionWidgetTypes.LOAD_NEXT_SUCCESS,
payload: {
count: courses.count,
results: courses.results,
initialized: true
}
});
})
.catch((error) => {
dispatch({ type: actionWidgetTypes.LOAD_NEXT_FAILURE, payload: { errorLoadNext: error } });
Logger.error(SCOPE_SC_UI, error);
});
}
}, [state.isLoadingNext, state.initialized, userId, dispatch]);
// EFFECTS
useEffect(() => {
let _t;
if (coursesEnabled && isInteger(userId) && scUserContext.user !== undefined) {
_t = setTimeout(_initComponent);
return () => {
_t && clearTimeout(_t);
};
}
}, [scUserContext.user, coursesEnabled, userId]);
/**
* Virtual feed update
*/
useEffect(() => {
onHeightChange && onHeightChange();
}, [state.results.length]);
useEffect(() => {
if (!coursesEnabled && !scUserContext.user && !isInteger(userId)) {
return;
}
else if (cacheStrategy === CacheStrategies.NETWORK_ONLY) {
onStateChange && onStateChange({ cacheStrategy: CacheStrategies.CACHE_FIRST });
}
}, [coursesEnabled, cacheStrategy, scUserContext.user, userId]);
// HANDLERS
const handleToggleDialogOpen = () => {
setOpenDialog((prev) => !prev);
};
// RENDER
if (!coursesEnabled || (!state.count && state.initialized) || !userId) {
return _jsx(HiddenPlaceholder, {});
}
if (!state.initialized) {
return _jsx(Skeleton, {});
}
const content = (_jsxs(CardContent, { children: [_jsx(Typography, Object.assign({ className: classes.title, variant: "h5" }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.title", defaultMessage: "ui.userCreatedCoursesWidget.title", values: {
total: state.count
} }) })), !state.count ? (_jsx(Typography, Object.assign({ className: classes.noResults, variant: "body2" }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.subtitle.noResults", defaultMessage: "ui.userCreatedCoursesWidget.subtitle.noResults" }) }))) : (_jsxs(React.Fragment, { children: [_jsx(List, { children: state.results.slice(0, limit).map((course) => (_jsx(ListItem, { children: _jsx(Course, Object.assign({ elevation: 0, template: SCCourseTemplateType.SNIPPET, course: course, userProfileSnippet: true }, CourseProps)) }, course.id))) }), limit < state.count && (_jsx(Button, Object.assign({ className: classes.showMore, onClick: handleToggleDialogOpen }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.button.showAll", defaultMessage: "ui.userCreatedCoursesWidget.button.showAll" }) }))), openDialog && (_jsxs(DialogRoot, Object.assign({ className: classes.dialogRoot, title: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.title", defaultMessage: "ui.userCreatedCoursesWidget.title", values: { total: state.count } }), onClose: handleToggleDialogOpen, open: openDialog, scroll: "paper" }, DialogProps, { children: [_jsxs(List, { children: [state.results.map((c) => (_jsx(ListItem, { children: _jsx(Course, Object.assign({ elevation: 0, template: SCCourseTemplateType.SNIPPET, course: c, userProfileSnippet: true }, CourseProps)) }, c.id))), state.isLoadingNext && (_jsx(ListItem, { children: _jsx(CourseSkeleton, { template: SCCourseTemplateType.SNIPPET, elevation: 0, CourseProps: { userProfileSnippet: true } }) }))] }), _jsx(Typography, Object.assign({ className: classes.endMessage }, { children: _jsx(FormattedMessage, { id: "ui.userCreatedCoursesWidget.noMoreResults", defaultMessage: "ui.userCreatedCoursesWidget.noMoreResults" }) }))] })))] }))] }));
return (_jsx(Root, Object.assign({ className: classNames(classes.root, className) }, rest, { children: content })));
}