TextInput: refresh adornment API #770
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
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,7 +1,7 @@ | ||
| import React, { useCallback } from 'react' | ||
| import PropTypes from 'prop-types' | ||
| import { useTheme } from '../../theme' | ||
| import { warn, warnOnce } from '../../utils' | ||
| import { textStyle, GU, RADIUS } from '../../style' | ||
|
|
||
| // Simple text input | ||
|
|
@@ -84,24 +84,80 @@ TextInput.defaultProps = { | |
| type: 'text', | ||
| } | ||
|
|
||
| const Adornment = React.memo(({ adornment, position, padding }) => { | ||
| const theme = useTheme() | ||
| return ( | ||
| <div | ||
| css={` | ||
| position: absolute; | ||
| top: 0; | ||
| bottom: 0; | ||
| height: 100%; | ||
| ${position === 'end' ? 'right' : 'left'}: ${padding}px; | ||
Evalir marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| display: flex; | ||
| align-items: center; | ||
| justify-content: center; | ||
| color: ${theme.surfaceContentSecondary}; | ||
| `} | ||
| > | ||
| {adornment} | ||
| </div> | ||
| ) | ||
| }) | ||
|
|
||
| Adornment.propTypes = { | ||
| adornment: PropTypes.node, | ||
| position: PropTypes.oneOf(['start', 'end']), | ||
| padding: PropTypes.number, | ||
| } | ||
|
|
||
| Adornment.defaultProps = { | ||
| padding: 4, | ||
| } | ||
|
|
||
| // Text input wrapped to allow adornments | ||
| const WrapperTextInput = React.forwardRef( | ||
| ({ adornment, adornmentPosition, adornmentSettings, ...props }, ref) => { | ||
| if (adornmentPosition) { | ||
| warn( | ||
| 'TextInput: The "adornmentPosition" prop is deprecated. Please use the "adornment" prop instead.' | ||
| ) | ||
| } | ||
| if (adornmentSettings) { | ||
| warn( | ||
| 'TextInput: The "adornmentSettings" props is deprecated. Please use the "adornment" prop instead.' | ||
| ) | ||
| } | ||
|
|
||
| if (!adornment) { | ||
| return <TextInput ref={ref} {...props} /> | ||
| } | ||
|
|
||
| let adornmentConfig = adornment | ||
|
|
||
| const usingDeprecatedAPI = | ||
| React.isValidElement(adornment) || | ||
| typeof adornment === 'string' || | ||
| (typeof adornment === 'object' && adornment.constructor === Array) | ||
|
|
||
| if (usingDeprecatedAPI) { | ||
| const { adornmentPosition = 'start', adornmentSettings = {} } = props | ||
| adornmentConfig = { | ||
| [adornmentPosition]: adornment, | ||
| [`${adornmentPosition}Padding`]: adornmentSettings.padding, | ||
| [`${adornmentPosition}Width`]: adornmentSettings.width, | ||
| } | ||
| } | ||
|
|
||
| const { | ||
| start, | ||
| startPadding, | ||
| startWidth = 36, | ||
| end, | ||
| endPadding, | ||
| endWidth = 36, | ||
| } = adornmentConfig | ||
|
|
||
| return ( | ||
| <div | ||
| css={` | ||
|
|
@@ -113,37 +169,43 @@ const WrapperTextInput = React.forwardRef( | |
| <TextInput | ||
| ref={ref} | ||
| css={` | ||
| ${start && `padding-left: ${startWidth}`} | ||
| ${end && `padding-right: ${endWidth}`} | ||
| `} | ||
| {...props} | ||
| /> | ||
| {start && ( | ||
| <Adornment | ||
| adornment={start} | ||
| padding={startPadding} | ||
| position="start" | ||
| /> | ||
| )} | ||
| {end && ( | ||
| <Adornment adornment={end} padding={endPadding} position="end" /> | ||
| )} | ||
| </div> | ||
| ) | ||
| } | ||
| ) | ||
|
|
||
| WrapperTextInput.propTypes = { | ||
| ...TextInput.propTypes, | ||
| adornment: PropTypes.oneOf([ | ||
| PropTypes.shape({ | ||
| start: PropTypes.node, | ||
| startWidth: PropTypes.number, | ||
| startPadding: PropTypes.number, | ||
| end: PropTypes.node, | ||
| endWidth: PropTypes.number, | ||
| endPadding: PropTypes.number, | ||
| }), | ||
|
|
||
| // deprecated | ||
| PropTypes.node, | ||
| ]), | ||
|
|
||
| // deprecated | ||
| adornmentPosition: PropTypes.oneOf(['start', 'end']), | ||
| adornmentSettings: PropTypes.shape({ | ||
| width: PropTypes.number, | ||
Evalir marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
@@ -154,8 +216,6 @@ WrapperTextInput.propTypes = { | |
| WrapperTextInput.defaultProps = { | ||
| ...TextInput.defaultProps, | ||
| adornment: null, | ||
|
There was a problem hiding this comment. I'm not sure, but should we add There was a problem hiding this comment. Sadly, React doesn't seem to have There was a problem hiding this comment. Prop types interpret To combine a value with a type, the trick is to use PropTypes.oneOfType([
PropTypes.oneOf([null]),
PropTypes.number,
])This is what we are doing for the aragonUI’s |
||
| } | ||
|
|
||
| // <input type=number> (only for compat) | ||
|
There was a problem hiding this comment. Could we also update this component's documentation with the new changes? We can remove (or mark) the deprecated props :). |
||
|
|
||
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
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.
For these older examples, perhaps we can either remove them or update them to use the new API?