Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Boilerplate next steps component #1909

Merged
merged 2 commits into from
Jul 6, 2023
Merged

feat: Boilerplate next steps component #1909

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06ad6fb
feat: Boilerplate next steps component
ianjon3s Jul 4, 2023
c51225b
feat: update suggestions from QA
ianjon3s Jul 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions editor.planx.uk/src/@planx/components/NextSteps/Editor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import { TYPES } from "@planx/components/types";
import {
EditorProps,
ICONS,
InternalNotes,
MoreInformation,
} from "@planx/components/ui";
import { useFormik } from "formik";
import React from "react";
import Input from "ui/Input";
import InputRow from "ui/InputRow";
import ModalSection from "ui/ModalSection";
import ModalSectionContent from "ui/ModalSectionContent";
import RichTextInput from "ui/RichTextInput";

import { NextSteps, parseContent } from "./model";

type Props = EditorProps<TYPES.NextSteps, NextSteps>;

export default NextSteps;

function NextSteps(props: Props) {
const formik = useFormik({
initialValues: parseContent(props.node?.data),
onSubmit: (newValues) => {
props.handleSubmit?.({
type: TYPES.NextSteps,
data: newValues,
});
},
});

return (
<form onSubmit={formik.handleSubmit} id="modal">
<ModalSection>
<ModalSectionContent title="Next steps" Icon={ICONS[TYPES.NextSteps]}>
<InputRow>
<Input
format="large"
name="title"
placeholder={formik.values.title}
value={formik.values.title}
onChange={formik.handleChange}
/>
</InputRow>
<InputRow>
<RichTextInput
name="description"
placeholder="Description"
value={formik.values.description}
onChange={formik.handleChange}
/>
</InputRow>
</ModalSectionContent>
</ModalSection>
<MoreInformation
changeField={formik.handleChange}
definitionImg={formik.values.definitionImg}
howMeasured={formik.values.howMeasured}
policyRef={formik.values.policyRef}
info={formik.values.info}
/>
<InternalNotes
name="notes"
value={formik.values.notes}
onChange={formik.handleChange}
/>
</form>
);
}
25 changes: 25 additions & 0 deletions editor.planx.uk/src/@planx/components/NextSteps/Public.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import Box from "@mui/material/Box";
import Typography from "@mui/material/Typography";
import { PublicProps } from "@planx/components/ui";
import React from "react";

import Card from "../shared/Preview/Card";
import QuestionHeader from "../shared/Preview/QuestionHeader";
import { NextSteps } from "./model";

type Props = PublicProps<NextSteps>;

export default Component;

function Component(props: Props) {
return (
<Card handleSubmit={props.handleSubmit} isValid>
<QuestionHeader title={props.title} description={props.description} />
Copy link
Member

@jessicamcinchak jessicamcinchak Jul 5, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A more flexible option is to use <QuestionHeader {...props} /> here which will then also automatically pick up help text if it's defined.

Otherwise, as-is:

  • you'd define help text in the editor but it wouldn't be picked up in the Public preview
  • you'll have to keep adding those prop fields manually like howMeasured={props.howMeasured} and so on

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, updated.

<Box>
<Typography variant="h2" style={{ color: "orangered" }}>
UNDER DEVELOPMENT
</Typography>
</Box>
</Card>
);
}
18 changes: 18 additions & 0 deletions editor.planx.uk/src/@planx/components/NextSteps/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { MoreInformation, parseMoreInformation } from "../shared";

export interface NextSteps extends MoreInformation {
title: string;
description: string;
fn: string;
}

export const parseContent = (
data: Record<string, any> | undefined
): NextSteps => ({
title: data?.title || DEFAULT_TITLE,
description: data?.description || "",
fn: data?.fn || "",
...parseMoreInformation(data),
});

const DEFAULT_TITLE = "What would you like to do next?";
1 change: 1 addition & 0 deletions editor.planx.uk/src/@planx/components/Send/bops/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ function isTypeForBopsPayload(type?: TYPES) {
case TYPES.FindProperty:
case TYPES.Flow:
case TYPES.InternalPortal:
case TYPES.NextSteps:
case TYPES.Notice:
case TYPES.Pay:
case TYPES.PlanningConstraints:
Expand Down
1 change: 1 addition & 0 deletions editor.planx.uk/src/@planx/components/shared/Preview/SummaryList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ const presentationalComponents: {
[TYPES.InternalPortal]: undefined,
[TYPES.FileUploadAndLabel]: FileUploadAndLabel,
[TYPES.Notice]: undefined,
[TYPES.NextSteps]: undefined,
[TYPES.NumberInput]: NumberInput,
[TYPES.Pay]: undefined,
[TYPES.PlanningConstraints]: undefined,
Expand Down
1 change: 1 addition & 0 deletions editor.planx.uk/src/@planx/components/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ export enum TYPES {
Send = 650,
Calculate = 700,
Confirmation = 725,
NextSteps = 730,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works ➕ There's no obvious method here, but as long as it's a new unique number it'll be good to go!

One new thing the original docs don't cover I think is that this list of Component types is now also maintained in planx-core and will need to be updated here as well: https://github.com/theopensystemslab/planx-core/blob/main/src/types/component.ts

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I've added as a new PR to planx-core:
theopensystemslab/planx-core#53

}
2 changes: 2 additions & 0 deletions editor.planx.uk/src/@planx/components/ui.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import ArrowForwardIcon from "@mui/icons-material/ArrowForward";
import BorderColorIcon from "@mui/icons-material/BorderColor";
import CallSplit from "@mui/icons-material/CallSplit";
import CheckBoxOutlined from "@mui/icons-material/CheckBoxOutlined";
Expand Down Expand Up @@ -72,6 +73,7 @@ export const ICONS: {
[TYPES.Flow]: undefined,
[TYPES.InternalPortal]: undefined,
[TYPES.Notice]: ReportProblemOutlined,
[TYPES.NextSteps]: ArrowForwardIcon,
[TYPES.NumberInput]: Pin,
[TYPES.Pay]: PaymentOutlined,
[TYPES.PlanningConstraints]: Map,
Expand Down
2 changes: 2 additions & 0 deletions editor.planx.uk/src/pages/FlowEditor/components/Flow/components/Node.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ const Node: React.FC<any> = (props) => {
return <Filter {...allProps} text="(Flags Filter)" />;
case TYPES.FindProperty:
return <Question {...allProps} text="Find property" />;
case TYPES.NextSteps:
return <Question {...allProps} text="Next steps" />;
case TYPES.Notice:
return <Question {...allProps} text={node?.data?.title ?? "Notice"} />;
case TYPES.NumberInput:
Expand Down
1 change: 1 addition & 0 deletions editor.planx.uk/src/pages/FlowEditor/components/forms/FormModal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ const NodeTypeSelect: React.FC<{
<optgroup label="Question">
<option value={TYPES.Statement}>Question</option>
<option value={TYPES.Checklist}>Checklist</option>
{/* <option value={TYPES.NextSteps}>Next steps</option> */}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This grouping makes sense to me too ➕

As long as the Public display shows "Under development", I'd actually be in favor of this not being commented out in this list so we can easily test/preview on the pizza! And that should be enough of a signal to Editors to not use it yet

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I've updated so this is unhidden, also updated the description with a pizza preview link for the component.

</optgroup>
<optgroup label="Inputs">
<option value={TYPES.TextInput}>Text Input</option>
Expand Down
2 changes: 2 additions & 0 deletions editor.planx.uk/src/pages/FlowEditor/components/forms/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import FileUploadAndLabel from "@planx/components/FileUploadAndLabel/Editor";
import Filter from "@planx/components/Filter/Editor";
import FindProperty from "@planx/components/FindProperty/Editor";
import InternalPortal from "@planx/components/InternalPortal/Editor";
import NextSteps from "@planx/components/NextSteps/Editor";
import Notice from "@planx/components/Notice/Editor";
import NumberInput from "@planx/components/NumberInput/Editor";
import Pay from "@planx/components/Pay/Editor";
Expand Down Expand Up @@ -50,6 +51,7 @@ const components: {
flow: EmptyComponent,
"internal-portal": InternalPortal,
"file-upload-and-label": FileUploadAndLabel,
"next-steps": NextSteps,
notice: Notice,
"number-input": NumberInput,
pay: Pay,
Expand Down
1 change: 1 addition & 0 deletions editor.planx.uk/src/pages/FlowEditor/data/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ export const SLUGS: {
[TYPES.Flow]: "flow",
[TYPES.InternalPortal]: "internal-portal",
[TYPES.FileUploadAndLabel]: "file-upload-and-label",
[TYPES.NextSteps]: "next-steps",
[TYPES.Notice]: "notice",
[TYPES.NumberInput]: "number-input",
[TYPES.Pay]: "pay",
Expand Down
4 changes: 4 additions & 0 deletions editor.planx.uk/src/pages/Preview/Node.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import DrawBoundary from "@planx/components/DrawBoundary/Public";
import FileUpload from "@planx/components/FileUpload/Public";
import FileUploadAndLabel from "@planx/components/FileUploadAndLabel/Public";
import FindProperty from "@planx/components/FindProperty/Public";
import NextSteps from "@planx/components/NextSteps/Public";
import Notice from "@planx/components/Notice/Public";
import NumberInput from "@planx/components/NumberInput/Public";
import { GOV_PAY_PASSPORT_KEY } from "@planx/components/Pay/model";
Expand Down Expand Up @@ -163,6 +164,9 @@ const Node: React.FC<any> = (props: Props) => {
case TYPES.FindProperty:
return <FindProperty {...allProps} />;

case TYPES.NextSteps:
return <NextSteps {...allProps} />;

case TYPES.Notice:
return <Notice {...allProps} />;

Expand Down
Loading