Skip to content

fix: patch label of textfield when it's not a string #2851

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.

Sign up for GitHub

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

Merged
Keith-CY merged 1 commit into from
Sep 27, 2023
Merged

fix: patch label of textfield when it's not a string #2851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 10 additions & 8 deletions packages/neuron-ui/src/widgets/TextField/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const TextField = React.forwardRef(
...rest
}: {
field: string
label?: string
label?: string | React.ReactNode

@WhiteMinds WhiteMinds Sep 26, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it could be implemented as label?: string | { node: ReactNode; text: string }

@Keith-CY Keith-CY Sep 27, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps it could be implemented as label?: string | { node: ReactNode; text: string }

I think label should be strictly limited to string, so the definition will be recovered to string, and if a pre-component is necessary, an independent field as prefix/suffix/preTab/postTab can be added

value?: string
hint?: string
error?: string
Expand Down Expand Up @@ -58,6 +58,8 @@ const TextField = React.forwardRef(
const changePasswordHide = useCallback(() => {
setIsPasswordHidden(v => !v)
}, [setIsPasswordHidden])
// FIXME: label should be limited to a string because it has its own semantic meaning
const labelStr = typeof label === 'string' ? label : field
return (
<div
className={`${styles.textField} ${stack ? styles.stack : ''} ${className}`}
Expand All @@ -66,7 +68,7 @@ const TextField = React.forwardRef(
ref={ref}
>
{label ? (
<label htmlFor={field} aria-label={label} title={label}>
<label htmlFor={field} aria-label={labelStr} title={labelStr}>
{label}
</label>
) : null}
Expand All @@ -85,9 +87,9 @@ const TextField = React.forwardRef(
rows={rows}
value={value}
placeholder={placeholder}
title={label}
name={label}
aria-label={label}
title={labelStr}
name={labelStr}
aria-label={labelStr}
onChange={onChange}
onClick={onClick}
readOnly={readOnly}
Expand All @@ -101,9 +103,9 @@ const TextField = React.forwardRef(
type={!isPasswordHidden && type === 'password' ? 'text' : type}
value={value}
placeholder={placeholder}
title={label}
name={label}
aria-label={label}
title={labelStr}
name={labelStr}
aria-label={labelStr}
onChange={onChange}
onClick={onClick}
readOnly={readOnly}
Expand Down