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.

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

refactor: Adjust text resource input component for input table #14151

Merged
merged 5 commits into from
Nov 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { ForwardedRef } from 'react';
import React from 'react';
import type { StudioTextResourceInputProps } from './StudioTextResourceInput';
import { StudioTextResourceInput } from './StudioTextResourceInput';
Expand All @@ -9,6 +10,9 @@ import { textResourcesMock } from '../../test-data/textResourcesMock';
import type { UserEvent } from '@testing-library/user-event';
import { userEvent } from '@testing-library/user-event';
import { getTextResourceById } from './utils';
import { testRefForwarding } from '../../test-utils/testRefForwarding';
import { testRootClassNameAppending } from '../../test-utils/testRootClassNameAppending';
import { testCustomAttributes } from '../../test-utils/testCustomAttributes';

// Test data:
const textResources: TextResource[] = textResourcesMock;
Expand Down Expand Up @@ -92,10 +96,28 @@ describe('StudioTextResourceInput', () => {
await switchToSearchMode(user);
expect(screen.getByText(currentId)).toBeInTheDocument();
});

it('Forwards the ref if given', () => {
testRefForwarding<HTMLInputElement>((ref) => renderTextResourceInput({}, ref), getValueField);
});

it('Appends the given class name to the root class', () => {
testRootClassNameAppending((className) => renderTextResourceInput({ className }));
});

it('Applies additional props to the input element', () => {
testCustomAttributes<HTMLInputElement, StudioTextResourceInputProps>(
renderTextResourceInput,
getValueField,
);
});
});

function renderTextResourceInput(props: Partial<StudioTextResourceInputProps> = {}): RenderResult {
return render(<StudioTextResourceInput {...defaultProps} {...props} />);
function renderTextResourceInput(
props: Partial<StudioTextResourceInputProps> = {},
ref?: ForwardedRef<HTMLInputElement>,
): RenderResult {
return render(<StudioTextResourceInput {...defaultProps} {...props} ref={ref} />);
}

function getValueField(): HTMLInputElement {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,156 +1,214 @@
import type { ChangeEvent, ReactElement } from 'react';
import React, { useState } from 'react';
import type { ChangeEvent, HTMLAttributes, ReactElement } from 'react';
import React, { forwardRef, useState } from 'react';
import type { TextResource } from '../../types/TextResource';
import { StudioTextResourcePicker } from '../StudioTextResourcePicker';
import { StudioCodeFragment } from '../StudioCodeFragment';
import { ToggleGroup } from '@digdir/designsystemet-react';
import { PencilIcon, MagnifyingGlassIcon } from '@studio/icons';
import classes from './StudioTextResourceInput.module.css';
import type { StudioTextfieldProps } from '../StudioTextfield';
import { StudioTextfield } from '../StudioTextfield';
import { changeTextResourceInList, editTextResourceValue, getTextResourceById } from './utils';
import { usePropState } from '@studio/hooks';
import type { TextResourceInputTexts } from './types/TextResourceInputTexts';
import cn from 'classnames';

export type StudioTextResourceInputProps = {
export type StudioTextResourceInputProps = TextResourceInputPropsBase &
HTMLAttributes<HTMLInputElement>;

type TextResourceInputPropsBase = {
standeren marked this conversation as resolved.
Show resolved Hide resolved
currentId: string;
currentIdClass?: string;
inputClass?: string;
onChangeCurrentId: (id: string) => void;
onChangeTextResource: (textResource: TextResource) => void;
textResources: TextResource[];
texts: TextResourceInputTexts;
toggleClass?: string;
};

export function StudioTextResourceInput({
currentId: givenCurrentId,
onChangeTextResource,
onChangeCurrentId,
textResources: givenTextResources,
texts,
}: StudioTextResourceInputProps): ReactElement {
const [inputMode, setInputMode] = useState<InputMode>(InputMode.EditValue);
const [currentId, setCurrentId] = usePropState<string>(givenCurrentId);
const [textResources, setTextResources] = usePropState<TextResource[]>(givenTextResources);

const handleChangeCurrentId = (id: string) => {
setCurrentId(id);
onChangeCurrentId(id);
};

const handleTextResourceChange = (newTextResource: TextResource) => {
const newList = changeTextResourceInList(textResources, newTextResource);
setTextResources(newList);
onChangeTextResource(newTextResource);
};
export const StudioTextResourceInput = forwardRef<HTMLInputElement, StudioTextResourceInputProps>(
(
{
className: givenClass,
currentId: givenCurrentId,
currentIdClass,
inputClass,
onChangeTextResource,
onChangeCurrentId,
onKeyDown,
textResources: givenTextResources,
texts,
toggleClass,
...rest
},
ref,
): ReactElement => {
const [mode, setMode] = useState<Mode>(Mode.EditValue);
const [currentId, setCurrentId] = usePropState<string>(givenCurrentId);
const [textResources, setTextResources] = usePropState<TextResource[]>(givenTextResources);

const handleChangeCurrentId = (id: string): void => {
setCurrentId(id);
onChangeCurrentId(id);
};

const handleTextResourceChange = (newTextResource: TextResource): void => {
const newList = changeTextResourceInList(textResources, newTextResource);
setTextResources(newList);
onChangeTextResource(newTextResource);
};

const rootClass = cn(givenClass, classes.container);

return (
<div className={rootClass}>
<InputBox
currentId={currentId}
inputClass={inputClass}
mode={mode}
onChangeCurrentId={handleChangeCurrentId}
onChangeTextResource={handleTextResourceChange}
onKeyDown={onKeyDown}
ref={ref}
textResources={textResources}
texts={texts}
{...rest}
/>
<ModeToggle className={toggleClass} inputMode={mode} onToggle={setMode} texts={texts} />
<CurrentId className={currentIdClass} currentId={currentId} label={texts.idLabel} />
</div>
);
},
);

return (
<div className={classes.container}>
<InputBox
currentId={currentId}
inputMode={inputMode}
onChangeCurrentId={handleChangeCurrentId}
onChangeTextResource={handleTextResourceChange}
textResources={textResources}
texts={texts}
/>
<InputModeToggle inputMode={inputMode} onToggle={setInputMode} texts={texts} />
<CurrentId currentId={currentId} label={texts.idLabel} />
</div>
);
}
StudioTextResourceInput.displayName = 'StudioTextResourceInput';

enum InputMode {
enum Mode {
EditValue = 'editValue',
Search = 'search',
}

type InputBoxProps = StudioTextResourceInputProps & {
inputMode: InputMode;
mode: Mode;
};

function InputBox({
currentId,
inputMode,
onChangeCurrentId,
onChangeTextResource,
textResources,
texts,
}: InputBoxProps): ReactElement {
const currentTextResource = getTextResourceById(textResources, currentId);

switch (inputMode) {
case InputMode.EditValue:
return (
<ValueField
label={texts.valueLabel}
onChange={onChangeTextResource}
textResource={currentTextResource}
/>
);
case InputMode.Search:
return (
<StudioTextResourcePicker
className={classes.inputbox}
emptyListText={texts.emptyResourceList}
label={texts.textResourcePickerLabel}
onValueChange={onChangeCurrentId}
textResources={textResources}
value={currentId}
/>
);
}
}

type ValueFieldProps = {
label: string;
const InputBox = forwardRef<HTMLInputElement, InputBoxProps>(
(
{
currentId,
inputClass,
mode,
onChangeCurrentId,
onChangeTextResource,
onKeyDown,
textResources,
texts,
...rest
},
ref,
): ReactElement => {
const currentTextResource = getTextResourceById(textResources, currentId);
const className = cn(inputClass, classes.inputbox);

switch (mode) {
case Mode.EditValue:
return (
<ValueField
className={className}
label={texts.valueLabel}
onChangeTextResource={onChangeTextResource}
onKeyDown={onKeyDown}
ref={ref}
textResource={currentTextResource}
{...rest}
/>
);
case Mode.Search:
return (
<StudioTextResourcePicker
className={className}
emptyListText={texts.emptyResourceList}
label={texts.textResourcePickerLabel}
onValueChange={onChangeCurrentId}
onKeyDown={onKeyDown}
textResources={textResources}
ref={ref}
value={currentId}
{...rest}
/>
);
}
},
);

InputBox.displayName = 'InputBox';

type ValueFieldProps = StudioTextfieldProps & {
textResource: TextResource;
onChange: (textResource: TextResource) => void;
onChangeTextResource: (textResource: TextResource) => void;
};

function ValueField({ textResource, onChange, label }: ValueFieldProps): ReactElement {
const handleChange = (event: ChangeEvent<HTMLInputElement>) => {
const { value } = event.target;
const newTextResource = editTextResourceValue(textResource, value);
onChange(newTextResource);
};
const ValueField = forwardRef<HTMLInputElement, ValueFieldProps>(
({ textResource, onChange, onChangeTextResource, ...rest }, ref): ReactElement => {
const handleChange = (event: ChangeEvent<HTMLInputElement>): void => {
const { value } = event.target;
const newTextResource = editTextResourceValue(textResource, value);
onChangeTextResource(newTextResource);
onChange?.(event);
};

return (
<StudioTextfield
hideLabel
onChange={handleChange}
ref={ref}
size='sm'
value={textResource.value}
{...rest}
/>
);
},
);

return (
<StudioTextfield
label={label}
hideLabel
size='sm'
value={textResource.value}
onChange={handleChange}
className={classes.inputbox}
/>
);
}
ValueField.displayName = 'ValueField';

type InputModeToggleProps = {
inputMode: InputMode;
onToggle: (mode: InputMode) => void;
className?: string;
inputMode: Mode;
onToggle: (mode: Mode) => void;
texts: TextResourceInputTexts;
};

function InputModeToggle({ inputMode, onToggle, texts }: InputModeToggleProps): ReactElement {
function ModeToggle({
className: givenClass,
inputMode,
onToggle,
texts,
}: InputModeToggleProps): ReactElement {
const className = cn(givenClass, classes.toggle);
return (
<ToggleGroup onChange={onToggle} value={inputMode} size='sm' className={classes.toggle}>
<ToggleGroup.Item icon value={InputMode.EditValue} title={texts.editValue}>
<ToggleGroup onChange={onToggle} value={inputMode} size='sm' className={className}>
<ToggleGroup.Item icon value={Mode.EditValue} title={texts.editValue}>
<PencilIcon />
</ToggleGroup.Item>
<ToggleGroup.Item icon value={InputMode.Search} title={texts.search}>
<ToggleGroup.Item icon value={Mode.Search} title={texts.search}>
<MagnifyingGlassIcon />
</ToggleGroup.Item>
</ToggleGroup>
);
}

type CurrentIdProps = {
className?: string;
currentId: string;
label: string;
};

function CurrentId({ currentId, label }: CurrentIdProps): ReactElement {
function CurrentId({ className: givenClass, currentId, label }: CurrentIdProps): ReactElement {
const className = cn(givenClass, classes.id);
return (
<div className={classes.id}>
<div className={className}>
{label}
<StudioCodeFragment>{currentId}</StudioCodeFragment>
</div>
Expand Down