-
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
63 changed files
with
2,899 additions
and
1,820 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import { Button, ButtonGroup, Col, FormGroup, Row } from "react-bootstrap"; | ||
| import { FC, memo, useCallback, useEffect, useMemo } from "react"; | ||
| import { FormItem, FormLabel } from "components/generic/form"; | ||
| import { faMinus, faPlus } from "@fortawesome/free-solid-svg-icons"; | ||
| import { useFieldArray, useFormContext, useWatch } from "react-hook-form"; | ||
|
|
||
| import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; | ||
| import { StringFieldArray } from "types/config"; | ||
| import { diffObjects } from "utils/diff-objects"; | ||
|
|
||
| interface Props { | ||
| name: string; | ||
| label?: string; | ||
| tooltip?: string; | ||
|
|
||
| defaults?: StringFieldArray; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a set of form fields for a list of strings | ||
| * | ||
| * @param name - The name of the field in the form | ||
| * @param label - The label for the field | ||
| * @param tooltip - The tooltip for the field | ||
| * @param defaults - The default values for the field | ||
| * @returns A set of form fields for a list of strings | ||
| */ | ||
| const FormList: FC<Props> = ({ | ||
| name, | ||
| label = "List", | ||
| tooltip, | ||
|
|
||
| defaults, | ||
| }) => { | ||
| const { setValue, trigger } = useFormContext(); | ||
| const { fields, append, remove } = useFieldArray({ | ||
| name: name, | ||
| }); | ||
| const addItem = useCallback(() => { | ||
| append({ arg: "" }, { shouldFocus: false }); | ||
| }, []); | ||
|
|
||
| // keep track of the array values so we can switch defaults when they're unchanged | ||
| const fieldValues: StringFieldArray = useWatch({ name: name }); | ||
| // useDefaults when the fieldValues are undefined or the same as the defaults | ||
| const useDefaults = useMemo( | ||
| () => | ||
| (defaults && diffObjects(fieldValues ?? fields ?? [], defaults)) ?? false, | ||
| [fieldValues, defaults] | ||
| ); | ||
| // trigger validation on change of defaults being used/not | ||
| useEffect(() => { | ||
| trigger(name); | ||
|
|
||
| // Give the defaults back if the field is empty | ||
| if ((fieldValues ?? fields ?? [])?.length === 0) | ||
| defaults?.forEach(() => { | ||
| addItem(); | ||
| }); | ||
| }, [useDefaults]); | ||
|
|
||
| const placeholder = useCallback( | ||
| (index: number) => (useDefaults && defaults?.[index]?.arg) || "", | ||
| [useDefaults, defaults] | ||
| ); | ||
|
|
||
| // on load, ensure we don't have another types actions | ||
| // and give the defaults if not overridden | ||
| useEffect(() => { | ||
| for (const item of fieldValues ?? fields ?? []) { | ||
| if ((item.arg ?? "") === "") { | ||
| setValue(name, []); | ||
| break; | ||
| } | ||
| } | ||
| }, []); | ||
|
|
||
| // remove the last item if it's not the only one or doesn't match the defaults | ||
| const removeLast = useCallback(() => { | ||
| !(useDefaults && fields.length == 1) && remove(fields.length - 1); | ||
| }, [fields.length, useDefaults]); | ||
|
|
||
| return ( | ||
| <FormGroup> | ||
| <Row> | ||
| <Col className="pt-1"> | ||
| <FormLabel text={label} tooltip={tooltip} /> | ||
| </Col> | ||
| <Col> | ||
| <ButtonGroup style={{ float: "right" }}> | ||
| <Button | ||
| aria-label={`Add new ${label}`} | ||
| className="btn-unchecked mb-1" | ||
| variant="success" | ||
| style={{ float: "right" }} | ||
| onClick={addItem} | ||
| > | ||
| <FontAwesomeIcon icon={faPlus} /> | ||
| </Button> | ||
| <Button | ||
| aria-label={`Remove last ${label}`} | ||
| className="btn-unchecked mb-1" | ||
| variant="danger" | ||
| style={{ float: "left" }} | ||
| onClick={removeLast} | ||
| disabled={fields.length === 0} | ||
| > | ||
| <FontAwesomeIcon icon={faMinus} /> | ||
| </Button> | ||
| </ButtonGroup> | ||
| </Col> | ||
| </Row> | ||
| <Row> | ||
| {fields.map(({ id }, index) => ( | ||
| <FormItem | ||
| key={id} | ||
| name={`${name}.${index}.arg`} | ||
| required | ||
| defaultVal={placeholder(index)} | ||
| position={index % 2 === 1 ? "right" : "left"} | ||
| /> | ||
| ))} | ||
| </Row> | ||
| </FormGroup> | ||
| ); | ||
| }; | ||
|
|
||
| export default memo(FormList); |
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
Oops, something went wrong.