[To Main] Feature - DESENG 631: Add Engagement Description Block #2541
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| import React, { Suspense } from 'react'; | ||
| import { BodyText, Header2 } from 'components/common/Typography'; | ||
| import { Link } from 'components/common/Navigation'; | ||
| import { Engagement } from 'models/engagement'; | ||
| import { Grid, Skeleton } from '@mui/material'; | ||
| import { colors } from 'components/common'; | ||
| import { Await, useLoaderData } from 'react-router-dom'; | ||
| import { Editor } from 'react-draft-wysiwyg'; | ||
| import { getEditorStateFromRaw } from 'components/common/RichTextEditor/utils'; | ||
| import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; | ||
| import { faArrowLeftLong } from '@fortawesome/pro-light-svg-icons'; | ||
| import { Widget } from 'models/widget'; | ||
| import { WidgetSwitch } from 'components/engagement/view/widgets/WidgetSwitch'; | ||
|
|
||
| export const EngagementDescription = ({ engagement }: { engagement: Engagement }) => { | ||
| const { widgets } = useLoaderData() as { widgets: Widget[] }; | ||
| return ( | ||
| <section id="cta-section"> | ||
|
There was a problem hiding this comment. Could we label this accessibility region? In the last PR, we used an aria-label directly for something descriptive of the section. In this case, I think we can use the H2 below. You'd reference it with an See here for the relevant technique: https://www.w3.org/WAI/ARIA/apg/patterns/landmarks/examples/region.html |
||
| <Grid | ||
| container | ||
| justifyContent="space-between" | ||
| sx={{ | ||
| width: '100%', | ||
| margin: 0, | ||
| background: colors.surface.blue[90], | ||
| color: colors.surface.white, | ||
| borderRadius: '0px 24px 0px 0px' /* upper right corner */, | ||
| padding: { xs: '43px 16px 75px 16px', md: '32px 5vw 88px 5vw', lg: '32px 156px 88px 156px' }, | ||
| marginTop: '-56px', | ||
| zIndex: 10, | ||
| position: 'relative', | ||
| flexDirection: { xs: 'column', md: 'row' }, | ||
| }} | ||
| > | ||
| <Grid | ||
| item | ||
| sx={{ | ||
| width: '100%', | ||
| display: 'flex', | ||
| flexDirection: 'row', | ||
| marginBottom: { xs: '24px', md: '48px' }, | ||
| }} | ||
| > | ||
| <Grid item component={Link} to={'/'} alignItems="center" display="flex"> | ||
| <FontAwesomeIcon | ||
| icon={faArrowLeftLong} | ||
| color={colors.surface.white} | ||
| fontSize={'24px'} | ||
| style={{ paddingRight: '8px' }} | ||
| /> | ||
| <BodyText thin size="small" sx={{ color: colors.surface.white }}> | ||
| All engagements | ||
| </BodyText> | ||
| </Grid> | ||
| </Grid> | ||
| <Grid | ||
| item | ||
| sx={{ | ||
| width: { xs: '100%', md: '47.5%' }, | ||
| display: 'flex', | ||
| flexDirection: 'column', | ||
| minHeight: '120px', | ||
| }} | ||
| > | ||
| <Header2 decorated weight="thin" sx={{ color: colors.surface.white }}> | ||
| Engagement Description | ||
| </Header2> | ||
| <BodyText | ||
| sx={{ | ||
| color: colors.surface.white, | ||
| '& .rdw-link-decorator-icon': { display: 'none' }, | ||
| '& a': { | ||
| color: colors.surface.white, | ||
| textDecoration: 'underline', | ||
| }, | ||
| }} | ||
| > | ||
| <Editor | ||
| editorState={getEditorStateFromRaw(engagement.rich_description)} | ||
| readOnly={true} | ||
| toolbarHidden | ||
| /> | ||
| </BodyText> | ||
| </Grid> | ||
| <Grid | ||
| item | ||
| sx={{ | ||
| width: { xs: '100%', md: '47.5%' }, | ||
| display: 'flex', | ||
| minHeight: '360px', | ||
| }} | ||
| > | ||
| <Suspense fallback={<Skeleton variant="rectangular" sx={{ width: '100%', height: '360px' }} />}> | ||
| <Await resolve={widgets}> | ||
| {(resolvedWidgets: Widget[]) => { | ||
| const widget = resolvedWidgets?.[0]; | ||
| return widget && <WidgetSwitch widget={widget} />; | ||
| }} | ||
| </Await> | ||
| </Suspense> | ||
| </Grid> | ||
| </Grid> | ||
| </section> | ||
| ); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { Params, defer } from 'react-router-dom'; | ||
| import { getEngagement } from 'services/engagementService'; | ||
| import { getEngagementIdBySlug } from 'services/engagementSlugService'; | ||
| import { getWidgets } from 'services/widgetService'; | ||
|
|
||
| export const engagementLoader = async ({ params }: { params: Params<string> }) => { | ||
| const { slug } = params; | ||
| const engagement = getEngagementIdBySlug(slug ?? '').then((response) => getEngagement(response.engagement_id)); | ||
|
There was a problem hiding this comment. Are you meaning to run all these in series? I think without the await keyword, some of these will run asynchronously There was a problem hiding this comment. Actually, these promises are intentionally not resolved within the loader - it would cause the route to be slow during navigation. This method is only to construct and gather the relevant promises in one place. The defer() pattern allows us to choose what data we want to await vs. not, finding the right tradeoff between loading time and CLS. Deferred variables (promises) are awaited inside the route itself, using the element from react-router-dom in combination with with a MUI Skeleton fallback. |
||
| const widgets = engagement.then((response) => getWidgets(response.id)); | ||
| return defer({ engagement, slug, widgets }); | ||
| }; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you foresee us needing additional font weight customization as time goes on? You could just expose a prop that accepts a valid fontWeight attribute and feeds it right to the corresponding Material UI typography property
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't honestly forsee us needing this - if a specific numeric font weight is needed it can be overridden with sx.fontWeight