Skip to content

Use original FieldGroup component in Field array #1146

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

Merged
merged 2 commits into from
Oct 13, 2021
Merged

Use original FieldGroup component in Field array #1146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
673332a
feat(pf4): use FormFieldGroup in FieldArray
rvsia Oct 13, 2021
2c0015f
Add buttonLabels to pf4 field array doc
rvsia Oct 13, 2021
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
8 changes: 8 additions & 0 deletions packages/pf4-component-mapper/src/field-array/field-array.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
import { ReactNode } from "react";
import { FieldArrayField } from "@data-driven-forms/react-form-renderer";

interface FieldArrayButtonLabels {
add?: ReactNode;
remove?: ReactNode;
removeAll?: ReactNode;
}

export interface FieldArrayProps {
label?: ReactNode;
description?: ReactNode;
Expand All @@ -9,6 +15,8 @@ export interface FieldArrayProps {
minItems?: number;
maxItems?: number;
noItemsMessage?: ReactNode;
name: string;
buttonLabels?: FieldArrayButtonLabels;
}

declare const FieldArray: React.ComponentType<FieldArrayProps>;
Expand Down
141 changes: 75 additions & 66 deletions packages/pf4-component-mapper/src/field-array/field-array.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,47 @@
import React, { Fragment, memo } from 'react';
import React, { memo } from 'react';
import isEqual from 'lodash/isEqual';
import PropTypes from 'prop-types';
import { useFormApi, FieldArray } from '@data-driven-forms/react-form-renderer';

import { Bullseye, FormHelperText, Grid, GridItem } from '@patternfly/react-core';
import { Bullseye, Button, Flex, FlexItem, FormFieldGroup, FormFieldGroupHeader, FormHelperText, Grid, GridItem } from '@patternfly/react-core';

import { AddCircleOIcon, CloseIcon } from '@patternfly/react-icons';
import { TrashIcon } from '@patternfly/react-icons';

import './final-form-array.css';
import { useFieldApi } from '@data-driven-forms/react-form-renderer';

const Spacer = () => <span className="ddf-final-form-spacer" />;

const ArrayItem = memo(
({ fields, fieldIndex, name, remove, length, minItems }) => {
({ fields, fieldIndex, name, remove, length, minItems, buttonLabels, isLast }) => {
const { renderForm } = useFormApi();

const widths = {
label: fields[0].label ? 5 : 0,
field: fields[0].label ? 7 : 12,
};

const editedFields = fields.map((field, index) => {
const computedName = field.name ? `${name}.${field.name}` : name;
return { ...field, name: computedName, key: `${name}-${index}`, hideLabel: true };
return { ...field, name: computedName, key: `${name}-${index}` };
});

const isRemoveDisabled = length <= minItems;

return (
<React.Fragment>
<Grid>
<GridItem sm={11}>
<hr className="ddf-final-form-hr" />
</GridItem>
</Grid>
<Grid>
<GridItem sm={11}>
{editedFields.map((field, index) => (
<Grid key={`${field.label}-${index}`} className="ddf-final-form-array-grid">
{widths.label > 0 && (
<GridItem sm={widths.label} key={`${field.label}-${index}`}>
<label htmlFor={field.name}>
{field.label}
{field.isRequired && <span className="pf-c-form__label-required">*</span>}
</label>
</GridItem>
)}
<GridItem sm={widths.field}>{renderForm([field])}</GridItem>
</Grid>
))}
</GridItem>
<GridItem sm={1}>
{length > minItems && (
<Bullseye>
<CloseIcon onClick={() => remove(fieldIndex)} className="ddf-final-form-group-remove-icon" />
</Bullseye>
)}
{length <= minItems && (
<Bullseye>
<CloseIcon className="ddf-final-form-group-remove-icon disabled" />
</Bullseye>
)}
</GridItem>
</Grid>
<Flex>
<FlexItem className="pf-c-form" grow={{ default: 'flex_1' }}>
{editedFields.map((field) => renderForm([field]))}
</FlexItem>
<FlexItem>
{editedFields[0].label && <Spacer />}
<Button
variant="plain"
aria-label={buttonLabels.remove}
disabled={isRemoveDisabled}
{...(!isRemoveDisabled && { onClick: () => remove(fieldIndex) })}
>
<TrashIcon />
</Button>
</FlexItem>
</Flex>
{!isLast && editedFields.length > 1 && <hr className="ddf-final-form-hr" />}
</React.Fragment>
);
},
Expand All @@ -73,6 +55,10 @@ ArrayItem.propTypes = {
remove: PropTypes.func.isRequired,
length: PropTypes.number,
minItems: PropTypes.number,
buttonLabels: PropTypes.shape({
remove: PropTypes.node,
}),
isLast: PropTypes.bool,
};

const DynamicArray = ({ ...props }) => {
Expand All @@ -86,22 +72,49 @@ const DynamicArray = ({ ...props }) => {
minItems,
maxItems,
noItemsMessage,
buttonLabels,
...rest
} = useFieldApi(props);
const { dirty, submitFailed, error, submitError } = meta;
const isError = (dirty || submitFailed) && (error || submitError) && (typeof error === 'string' || typeof submitError === 'string');

const combinedButtonLabels = {
add: 'Add item',
removeAll: 'Delete all',
remove: 'Remove',
...buttonLabels,
};

return (
<FieldArray key={rest.input.name} name={rest.input.name} validate={arrayValidator}>
{({ fields: { map, value = [], push, remove } }) => (
<Fragment>
{label && <GridItem sm={12}>{label}</GridItem>}
{description && <GridItem sm={12}>{description}</GridItem>}
{value.length <= 0 && (
<Bullseye>
<GridItem sm={12}>{noItemsMessage}</GridItem>
</Bullseye>
)}
{({ fields: { map, value = [], push, remove, removeBatch } }) => (
<FormFieldGroup
header={
<FormFieldGroupHeader
titleText={{ text: label, id: props.name }}
titleDescription={description}
actions={
<React.Fragment>
<Button
variant="link"
isDisabled={value.length === 0}
{...(value.length !== 0 && { onClick: () => removeBatch(value.map((_, index) => index)) })}
>
{combinedButtonLabels.removeAll}
</Button>
<Button
variant="secondary"
isDisabled={value.length >= maxItems}
{...(!(value.length >= maxItems) && { onClick: () => push(defaultItem) })}
>
{combinedButtonLabels.add}
</Button>
</React.Fragment>
}
/>
}
>
{value.length <= 0 && <Bullseye>{noItemsMessage}</Bullseye>}
{map((name, index) => (
<ArrayItem
key={`${name}-${index}`}
Expand All @@ -111,6 +124,8 @@ const DynamicArray = ({ ...props }) => {
remove={remove}
length={value.length}
minItems={minItems}
buttonLabels={combinedButtonLabels}
isLast={value.length === index + 1}
/>
))}
<Grid>
Expand All @@ -121,33 +136,27 @@ const DynamicArray = ({ ...props }) => {
</FormHelperText>
)}
</GridItem>
<GridItem sm={1} className="final-form-array-add-container">
{value.length < maxItems && (
<Bullseye>
<AddCircleOIcon onClick={() => push(defaultItem)} className="ddf-final-form-group-add-icon" />
</Bullseye>
)}
{value.length >= maxItems && (
<Bullseye>
<AddCircleOIcon className="ddf-final-form-group-add-icon disabled" />
</Bullseye>
)}
</GridItem>
</Grid>
</Fragment>
</FormFieldGroup>
)}
</FieldArray>
);
};

DynamicArray.propTypes = {
name: PropTypes.string,
label: PropTypes.node,
description: PropTypes.node,
fields: PropTypes.arrayOf(PropTypes.object).isRequired,
defaultItem: PropTypes.any,
minItems: PropTypes.number,
maxItems: PropTypes.number,
noItemsMessage: PropTypes.node,
buttonLabels: PropTypes.shape({
add: PropTypes.node,
remove: PropTypes.node,
removeAll: PropTypes.node,
}),
};

DynamicArray.defaultProps = {
Expand Down
42 changes: 8 additions & 34 deletions packages/pf4-component-mapper/src/field-array/final-form-array.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,9 @@
.ddf-final-form-group-remove-icon {
color: var(--pf-global--icon--Color--light);
height: 70%;
}
.ddf-final-form-group-remove-icon:hover:not(.disabled) {
color: var(--pf-global--icon--Color--dark);
cursor: pointer;
}
.ddf-final-form-group-remove-icon.disabled {
opacity: 0.5;
}
.final-form-array-add-container {
min-height: 36px !important;
}
.ddf-final-form-group-add-icon {
color: var(--pf-global--icon--Color--light);
min-height: 24px;
min-width: 24px;
}
.ddf-final-form-group-add-icon:hover:not(.disabled) {
color: var(--pf-global--icon--Color--dark);
cursor: pointer;
}
.ddf-final-form-group-add-icon.disabled {
opacity: 0.5;
}
.ddf-final-form-group-label {
margin: auto 0 auto var(--pf-global--spacer--md);
}
.ddf-final-form-hr {
color: var(global_BorderColor_100);
}
.ddf-final-form-array-grid:not(:last-child) {
margin-bottom: var(--pf-global--spacer--md);
}
color: var(--pf-global_BorderColor_100);
border-bottom-width: 0;
}
.ddf-final-form-spacer{
display: inline-block;
min-width: 100%;
min-height: 32px;
}
Loading