refactor: file picker component #1072
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,129 +1,169 @@ | ||
| import classNames from 'classnames'; | ||
| import _ from 'lodash'; | ||
| import PropTypes from 'prop-types'; | ||
| import React, { useState, useRef } from 'react'; | ||
| import Button from 'react-bootstrap/lib/Button'; | ||
| import './styles.scss'; | ||
|
|
||
| const baseClass = 'aui--filepicker-component'; | ||
|
|
||
| const FilePickerComponent = ({ | ||
| disabled, | ||
| dts, | ||
| filter, | ||
| isHighlighted, | ||
| label, | ||
| onRemove, | ||
| onSelect, | ||
| onClick, | ||
| onChange, | ||
| value, | ||
| placeholder, | ||
| }) => { | ||
| const [isFileSelected, setIsFileSelected] = useState(false); | ||
| const [fileName, setFileName] = useState(''); | ||
| const fileInput = useRef(); | ||
|
|
||
| const selectFile = event => { | ||
| if (!isFileSelected) { | ||
| const file = event.target.files[0]; | ||
| setIsFileSelected(true); | ||
| if (_.isFunction(onChange)) { | ||
| onChange(file.name); | ||
| } | ||
| setFileName(file.name); | ||
|
|
||
| onSelect(file); | ||
| } | ||
| }; | ||
|
|
||
| const onUploadBtnClick = () => { | ||
| fileInput.current.click(); | ||
| }; | ||
|
|
||
| const removeFile = () => { | ||
| if (isFileSelected || !_.isEmpty(value)) { | ||
| fileInput.current.value = null; | ||
| setIsFileSelected(false); | ||
| if (_.isFunction(onChange)) { | ||
| onChange(''); | ||
| } | ||
| setFileName(''); | ||
|
|
||
| if (_.isFunction(onRemove)) { | ||
| onRemove(); | ||
|
Comment on lines
+48
to
+54
There was a problem hiding this comment. Not quite sure about this. Triggering multiple handlers here seems to be a little bit confusing to me. the usage should be either // handle remove with onChange('')
handleChange = (value) => {
if(value==='') {/* handle remove */}
}or // setValue('') with onRemove()
handleRemove = () => setValue('') |
||
| } | ||
| } | ||
| }; | ||
|
|
||
| const clickFile = () => { | ||
| if (_.isFunction(onClick)) { | ||
| onClick(); | ||
| } | ||
| }; | ||
|
|
||
| if (value && !onChange) | ||
| console.warn( | ||
| 'Failed prop type: You have provided a `value` prop to FilePicker Component without an `onChange` handler. This will render a read-only field.' | ||
| ); | ||
|
|
||
| const hasFileName = _.isString(value) ? value !== '' : isFileSelected; | ||
|
|
||
| return ( | ||
| <div | ||
| className={classNames({ [`${baseClass}-highlight`]: isHighlighted }, baseClass, 'input-group')} | ||
| data-test-selector={dts} | ||
| data-testid="file-picker-wrapper" | ||
| > | ||
| <input | ||
| data-testid="file-picker-form-control" | ||
| className={classNames('form-control', { clickable: _.isFunction(onClick) })} | ||
| type="text" | ||
| readOnly | ||
| placeholder={placeholder} | ||
| value={value || fileName} | ||
| title={value || fileName} | ||
| onClick={clickFile} | ||
| /> | ||
|
There was a problem hiding this comment. @superpower1 @minhe86 can you put There was a problem hiding this comment. something like There was a problem hiding this comment. I will put dts to the wrapper div instead |
||
| <div className="input-group-btn"> | ||
| {hasFileName ? ( | ||
| <Button data-testid="file-picker-remove-button" className="remove-file" onClick={removeFile}> | ||
| × | ||
| </Button> | ||
| ) : null} | ||
| <Button | ||
| data-testid="file-picker-input-button" | ||
| className="btn-inverse select-file" | ||
| onClick={onUploadBtnClick} | ||
| disabled={disabled || hasFileName} | ||
| > | ||
| <span data-testid="file-picker-input-button-label">{label}</span> | ||
| <input | ||
| data-testid="file-picker-input-button-input" | ||
| className="file-input" | ||
| ref={fileInput} | ||
| type="file" | ||
| onChange={selectFile} | ||
| accept={filter} | ||
| /> | ||
| </Button> | ||
| </div> | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| FilePickerComponent.propTypes = { | ||
| /** | ||
| * determines if the filePicker is disabled | ||
| */ | ||
| disabled: PropTypes.bool, | ||
| /** | ||
| * data-test-selector of the filePicker | ||
| */ | ||
| dts: PropTypes.string, | ||
| /** | ||
| * determines what file types the user can pick from the file input dialog box | ||
| */ | ||
| filter: PropTypes.string, | ||
| /** | ||
| * determines if the filePicker is highlighted or not | ||
| */ | ||
| isHighlighted: PropTypes.bool, | ||
| /** | ||
| * label on button | ||
| */ | ||
| label: PropTypes.string, | ||
| /** | ||
| * function called when onRemove event is fired | ||
| */ | ||
| onRemove: PropTypes.func, | ||
| /** | ||
| * function called when onSelect event is fired | ||
| */ | ||
| onSelect: PropTypes.func.isRequired, | ||
| /** | ||
| * function called when user click the file name | ||
| */ | ||
| onClick: PropTypes.func, | ||
| /** | ||
| * function called when the file name changes | ||
| */ | ||
| onChange: PropTypes.func, | ||
|
There was a problem hiding this comment. I can't exactly recollect the discussion, however, didn't we decide to cut down the handler functions. There was a problem hiding this comment. I think we were planning to retain the |
||
| /** | ||
| * file name on input | ||
| */ | ||
| value: PropTypes.string, | ||
| /** | ||
| * determines the placeholder when no date is selected | ||
| */ | ||
| placeholder: PropTypes.string, | ||
| }; | ||
|
|
||
| FilePickerComponent.defaultProps = { | ||
| isHighlighted: false, | ||
| label: 'Select', | ||
| placeholder: 'No file selected', | ||
| disabled: false, | ||
| }; | ||
|
|
||
| export default FilePickerComponent; | ||
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.
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.
I think we should probably provide the actual file for the
onChangeinstead of just the name and allow the external component to put the file's name into the value. In those scenarios they would also not need to useonSelectsince they have the power to do whatever and they also have the file itself to manage rather than it being hidden in the component.