Skip to content

feat: add optional change/selected text to FileInput #3116

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
3 changes: 3 additions & 0 deletions src/components/forms/FileInput/FileInput.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ export const AcceptImages = (): JSX.Element => (
name="file-input-wildcard"
accept="image/*"
aria-describedby="file-input-wildcard-hint"
previewSingleSelectedFileText="Selected photo"
previewMultipleSelectedFileText="Photos selected"
changeSelectedFileText="Change photo"
multiple
/>
</FormGroup>
Expand Down
17 changes: 17 additions & 0 deletions src/components/forms/FileInput/FileInput.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,23 @@ describe('FileInput component', () => {
expect(previewHeading).toHaveTextContent('Selected file Change file')
})

it('renders a custom header text when a single file is chosen', async () => {
const { getByTestId } = render(
<FileInput
{...testProps}
previewSingleSelectedFileText="Selected photo"
previewMultipleSelectedFileText="Photos selected"
changeSelectedFileText="Change photo"
/>
)
const inputEl = getByTestId('file-input-input')
await userEvent.upload(inputEl, TEST_PNG_FILE)
expect(getByTestId('file-input-preview')).toBeInTheDocument()
expect(getByTestId('file-input-instructions')).toHaveClass('display-none')
const previewHeading = getByTestId('file-input-preview-heading')
expect(previewHeading).toHaveTextContent('Selected photo Change photo')
})

it('renders a preview for each file and header text when multiple files are chosen', async () => {
const { getByTestId, getAllByTestId } = render(
<FileInput {...testProps} multiple={true} />
Expand Down
19 changes: 16 additions & 3 deletions src/components/forms/FileInput/FileInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ export type FileInputProps = {
dragText?: string
chooseText?: string
errorText?: string
previewSingleSelectedFileText?: string
previewMultipleSelectedFileText?: string
changeSelectedFileText?: string
disabled?: boolean
multiple?: boolean
accept?: string
Expand All @@ -40,6 +43,9 @@ export const FileInputForwardRef: React.ForwardRefRenderFunction<
dragText,
chooseText,
errorText,
previewSingleSelectedFileText,
previewMultipleSelectedFileText,
changeSelectedFileText,
disabled,
multiple,
className,
Expand Down Expand Up @@ -94,6 +100,9 @@ export const FileInputForwardRef: React.ForwardRefRenderFunction<
: 'Drag file here or '
const defaultChooseText = 'choose from folder'
const defaultErrorText = 'This is not a valid file type.'
const defaultSingleSelectedFileText = 'Selected file'
const defaultMultipleSelectedFileText = ' files selected'
const defaultChangeSelectedFileText = 'Change file'

const filePreviews = []
if (files) {
Expand All @@ -116,8 +125,10 @@ export const FileInputForwardRef: React.ForwardRefRenderFunction<

const previewHeaderText =
filePreviews.length > 1
? `${filePreviews.length} files selected`
: 'Selected file'
? previewMultipleSelectedFileText
? `${filePreviews.length} ${previewMultipleSelectedFileText}`
: `${filePreviews.length} ${defaultMultipleSelectedFileText}`
: previewSingleSelectedFileText || defaultSingleSelectedFileText

const preventInvalidFiles = (e: React.DragEvent): void => {
setShowError(false)
Expand Down Expand Up @@ -191,7 +202,9 @@ export const FileInputForwardRef: React.ForwardRefRenderFunction<
className="usa-file-input__preview-heading">
{previewHeaderText}{' '}
<span className="usa-file-input__choose">
Change file{filePreviews.length > 1 && 's'}
{changeSelectedFileText
? `${changeSelectedFileText}${filePreviews.length > 1 && 's'}`
: `${defaultChangeSelectedFileText}${filePreviews.length > 1 && 's'}`}
</span>
</div>
)}
Expand Down