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.

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

Jump to bottom

Use <label> HTML element when possible #7609

Merged
merged 4 commits into from
Oct 13, 2024
Merged

Use <label> HTML element when possible #7609

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b0225d
fix: use a true label element for the input label
Devessier Oct 11, 2024
eeb0155
fix: use useId hook instead of a uuid v4 for the id of an input element
Devessier Oct 11, 2024
7e42c73
refactor: provide a function setter to the setIsOn function to stop d…
Devessier Oct 11, 2024
67fbb38
Merge branch 'main' into use-label-html-element
charlesBochet Oct 13, 2024
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
9 changes: 6 additions & 3 deletions packages/twenty-chrome-extension/src/options/modules/ui/input/components/TextInput.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React from 'react';
import styled from '@emotion/styled';
import React, { useId } from 'react';

interface TextInputProps {
label?: string;
Expand All @@ -18,7 +18,7 @@ const StyledContainer = styled.div<{ fullWidth?: boolean }>`
margin-bottom: ${({ theme }) => theme.spacing(4)};
`;

const StyledLabel = styled.span`
const StyledLabel = styled.label`
color: ${({ theme }) => theme.font.color.light};
font-size: ${({ theme }) => theme.font.size.xs};
font-weight: ${({ theme }) => theme.font.weight.semiBold};
Expand Down Expand Up @@ -65,12 +65,15 @@ const TextInput: React.FC<TextInputProps> = ({
placeholder,
icon,
}) => {
const inputId = useId();

Copy link
Member

Choose a reason for hiding this comment

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

nice I didn't know about this one!

Copy link
Member

@charlesBochet charlesBochet Oct 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

This should be our default way to generated Ids in the frontend (when we don't need uuids). What do you think @lucasbordeau?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The useId hook remains a React hook and must follow the hooks' rules. It can't be called in response to an event. The useId hook is excellent for generating identifiers scoped to a React component, like HTML IDs.

Copy link
Contributor

Choose a reason for hiding this comment

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

I won't say that it should be the default way for all ids but for HTML ids it's most indicated.

return (
<StyledContainer fullWidth={fullWidth}>
{label && <StyledLabel>{label}</StyledLabel>}
{label && <StyledLabel htmlFor={inputId}>{label}</StyledLabel>}
<StyledInputContainer>
{icon && <StyledIcon>{icon}</StyledIcon>}
<StyledInput
id={inputId}
type="text"
value={value}
onChange={(e) => onChange(e.target.value)}
Expand Down
3 changes: 1 addition & 2 deletions packages/twenty-front/src/modules/ui/input/components/Checkbox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import styled from '@emotion/styled';
import * as React from 'react';
import { IconCheck, IconMinus } from 'twenty-ui';
import { v4 } from 'uuid';

export enum CheckboxVariant {
Primary = 'primary',
Expand Down Expand Up @@ -165,7 +164,7 @@ export const Checkbox = ({
setIsInternalChecked(event.target.checked ?? false);
};

const checkboxId = 'checkbox' + v4();
const checkboxId = React.useId();
Copy link
Member

Choose a reason for hiding this comment

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

import from react?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The whole component imports hooks from the React global export, so I did the same.


return (
<StyledInputContainer
Expand Down
3 changes: 1 addition & 2 deletions packages/twenty-front/src/modules/ui/input/components/Radio.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import { motion } from 'framer-motion';
import * as React from 'react';
import { RGBA } from 'twenty-ui';

import { v4 } from 'uuid';
import { RadioGroup } from './RadioGroup';

export enum RadioSize {
Expand Down Expand Up @@ -134,7 +133,7 @@ export const Radio = ({
onCheckedChange?.(event.target.checked);
};

const optionId = v4();
const optionId = React.useId();

return (
<StyledContainer className={className} labelPosition={labelPosition}>
Expand Down
12 changes: 10 additions & 2 deletions packages/twenty-front/src/modules/ui/input/components/TextInputV2.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
ForwardedRef,
InputHTMLAttributes,
forwardRef,
useId,
useRef,
useState,
} from 'react';
Expand All @@ -21,7 +22,7 @@ const StyledContainer = styled.div<
width: ${({ fullWidth }) => (fullWidth ? `100%` : 'auto')};
`;

const StyledLabel = styled.span`
const StyledLabel = styled.label`
color: ${({ theme }) => theme.font.color.light};
font-size: ${({ theme }) => theme.font.size.xs};
font-weight: ${({ theme }) => theme.font.weight.semiBold};
Expand Down Expand Up @@ -169,9 +170,15 @@ const TextInputV2Component = (
setPasswordVisible(!passwordVisible);
};

const inputId = useId();

return (
<StyledContainer className={className} fullWidth={fullWidth ?? false}>
{label && <StyledLabel>{label + (required ? '*' : '')}</StyledLabel>}
{label && (
<StyledLabel htmlFor={inputId}>
{label + (required ? '*' : '')}
</StyledLabel>
)}
<StyledInputContainer>
{!!LeftIcon && (
<StyledLeftIconContainer>
Expand All @@ -181,6 +188,7 @@ const TextInputV2Component = (
</StyledLeftIconContainer>
)}
<StyledInput
id={inputId}
data-testid={dataTestId}
autoComplete={autoComplete || 'off'}
ref={combinedRef}
Expand Down
13 changes: 8 additions & 5 deletions packages/twenty-front/src/modules/ui/input/components/Toggle.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,14 @@ export const Toggle = ({
};

useEffect(() => {
if (value !== isOn) {
setIsOn(value ?? false);
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [value]);
setIsOn((isOn) => {
if (value !== isOn) {
return value ?? false;
}

return isOn;
});
}, [value, setIsOn]);

return (
<StyledContainer
Expand Down
Loading