Labels editing and validation #3426
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,223 +1,170 @@ | ||
| import React, { useState } from 'react'; | ||
| import { Label, LabelGroup, Alert, AlertVariant } from '@patternfly/react-core'; | ||
| import DashboardDescriptionListGroup from './DashboardDescriptionListGroup'; | ||
|
|
||
| interface EditableLabelsProps { | ||
| labels: string[]; | ||
| onLabelsChange: (labels: string[]) => Promise<void>; | ||
| isArchive?: boolean; | ||
| allExistingKeys?: string[]; | ||
| title?: string; | ||
| contentWhenEmpty?: string; | ||
| } | ||
|
|
||
| export const EditableLabelsDescriptionListGroup: React.FC<EditableLabelsProps> = ({ | ||
| title = 'Labels', | ||
| contentWhenEmpty = 'No labels', | ||
| labels, | ||
| onLabelsChange, | ||
| isArchive, | ||
| allExistingKeys = labels, | ||
| }) => { | ||
| const [isEditing, setIsEditing] = useState(false); | ||
| const [isSavingEdits, setIsSavingEdits] = useState(false); | ||
| const [unsavedLabels, setUnsavedLabels] = useState(labels); | ||
| const [labelErrors, setLabelErrors] = useState<{ [key: string]: string }>({}); | ||
|
|
||
| const reservedKeys = [ | ||
| ...allExistingKeys.filter((key) => !labels.includes(key)), | ||
| ...unsavedLabels, | ||
| ]; | ||
|
|
||
| const validateLabel = (text: string): string | null => { | ||
| if (reservedKeys.includes(text)) { | ||
| return `"${text}" already exists. Use a unique name that doesn't match any existing key or property`; | ||
| } | ||
| if (text.length > 63) { | ||
| return "Label text can't exceed 63 characters"; | ||
| } | ||
| return null; | ||
| }; | ||
|
|
||
| const removeUnsavedLabel = (text: string) => { | ||
| if (isSavingEdits) { | ||
| return; | ||
| } | ||
| setUnsavedLabels(unsavedLabels.filter((label) => label !== text)); | ||
| }; | ||
|
|
||
| const handleEditComplete = (_event: MouseEvent | KeyboardEvent, newText: string) => { | ||
| const error = validateLabel(newText); | ||
| if (error) { | ||
| setLabelErrors((prev) => ({ ...prev, [newText]: error })); | ||
| } else { | ||
| setUnsavedLabels((prev) => [...prev, newText]); | ||
| setLabelErrors({}); | ||
| } | ||
| }; | ||
|
|
||
| return ( | ||
| <DashboardDescriptionListGroup | ||
| data-testid="editable-labels-group" | ||
| title={title} | ||
| isEmpty={labels.length === 0} | ||
| contentWhenEmpty={contentWhenEmpty} | ||
| isEditable={!isArchive} | ||
| isEditing={isEditing} | ||
| isSavingEdits={isSavingEdits} | ||
| isSaveDisabled={Object.keys(labelErrors).length > 0} | ||
| contentWhenEditing={ | ||
| <> | ||
| <LabelGroup | ||
| data-testid="editable-label-group" | ||
| isEditable={!isSavingEdits} | ||
|
There was a problem hiding this comment. I don't see this testid used anywhere. |
||
| numLabels={10} | ||
| expandedText="Show Less" | ||
| collapsedText="Show More" | ||
| addLabelControl={ | ||
|
There was a problem hiding this comment. Ooooone last thing - we should set |
||
| !isSavingEdits && ( | ||
| <Label | ||
| data-testid="add-label-button" | ||
| color="blue" | ||
| variant="outline" | ||
| isEditable | ||
| editableProps={{ | ||
| 'aria-label': 'Add label', | ||
| defaultValue: '', | ||
| 'data-testid': 'add-label-input', | ||
| }} | ||
| onEditComplete={(_event, newText) => { | ||
|
There was a problem hiding this comment. The way I understand the mockup, I don't think we want the "Add label" button to be an editable label itself. It can just be a button like before, but instead of its There was a problem hiding this comment. +1 to @mturley. |
||
| const error = validateLabel(newText); | ||
| if (error) { | ||
| setLabelErrors((prev) => ({ ...prev, [newText]: error })); | ||
| } else { | ||
| setUnsavedLabels((prev) => [...prev, newText]); | ||
| const newErrors = { ...labelErrors }; | ||
| delete newErrors[newText]; | ||
| setLabelErrors(newErrors); | ||
| } | ||
| }} | ||
| > | ||
| Add label | ||
| </Label> | ||
| ) | ||
| } | ||
| > | ||
| {unsavedLabels.map((label) => ( | ||
| <Label | ||
| data-testid={`editable-label-${label}`} | ||
| key={`${label}-${labelErrors[label] ? 'error' : 'normal'}`} | ||
| color={labelErrors[label] ? 'red' : 'blue'} | ||
| isEditable={!isSavingEdits} | ||
| onClose={() => removeUnsavedLabel(label)} | ||
| closeBtnProps={{ | ||
| isDisabled: isSavingEdits, | ||
| 'data-testid': `remove-label-${label}`, | ||
| }} | ||
| onEditComplete={(_event, newText) => handleEditComplete(_event, newText)} | ||
| editableProps={{ | ||
| defaultValue: '', | ||
| 'aria-label': 'Edit label', | ||
| 'data-testid': `edit-label-input-${label}`, | ||
| }} | ||
| > | ||
| {label} | ||
| </Label> | ||
| ))} | ||
| </LabelGroup> | ||
| {Object.keys(labelErrors).length > 0 && ( | ||
| <Alert | ||
| data-testid="label-error-alert" | ||
| variant={AlertVariant.danger} | ||
| isInline | ||
| title={Object.values(labelErrors)[0]} | ||
| aria-live="polite" | ||
| /> | ||
| )} | ||
ppadti marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| </> | ||
| } | ||
| onEditClick={() => { | ||
| setUnsavedLabels(labels); | ||
| setLabelErrors({}); | ||
| setIsEditing(true); | ||
| }} | ||
| onSaveEditsClick={async () => { | ||
| if (Object.keys(labelErrors).length > 0) { | ||
| return; | ||
| } | ||
| setIsSavingEdits(true); | ||
| try { | ||
| await onLabelsChange(unsavedLabels); | ||
| } finally { | ||
| setIsSavingEdits(false); | ||
| setIsEditing(false); | ||
| } | ||
| }} | ||
| onDiscardEditsClick={() => { | ||
| setUnsavedLabels(labels); | ||
| setIsEditing(false); | ||
| }} | ||
| > | ||
| <LabelGroup data-testid="display-label-group"> | ||
| {labels.map((label) => ( | ||
| <Label key={label} color="blue" data-testid="label"> | ||
| {label} | ||
| </Label> | ||
| ))} | ||
| </LabelGroup> | ||
| </DashboardDescriptionListGroup> | ||
| ); | ||
| }; | ||
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.
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.
Is this test-id necessary? I don't see this test-id used anywhere.