Skip to content

Commit

Permalink
fix: Make the entire advanced mode toggle container clickable (#7761)
Browse files Browse the repository at this point in the history
In this PR:

- Use a real `<input type="checkbox" />` element in the `<Toggle />`
component
- Create an `accessibility` module in the `twenty-ui` package
- Export the `VISIBILITY_HIDDEN` CSS object to hide visually any element
- Export a `<VisibilityHidden />` component from the `twenty-ui` package
to add visually hidden textual information easily
- Export a `<VisibilityHiddenInput />` component to create custom form
control components easily
- Use a `<label>` element for the "Advanced:" text; it will naturally
toggle the advanced settings

Fixes #7756

---------

Co-authored-by: Devessier <baptiste@devessier.fr>
  • Loading branch information
Vardhaman619 and Devessier authored Oct 21, 2024
1 parent 1a0b387 commit 1466d44
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 35 deletions.
57 changes: 24 additions & 33 deletions packages/twenty-front/src/modules/ui/input/components/Toggle.tsx
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
import styled from '@emotion/styled';
import { motion } from 'framer-motion';
import { useEffect, useState } from 'react';

import { isDefined } from '~/utils/isDefined';
import { VisibilityHiddenInput } from 'twenty-ui';

export type ToggleSize = 'small' | 'medium';

type ContainerProps = {
isOn: boolean;
color?: string;
toggleSize: ToggleSize;
disabled?: boolean;
'data-disabled'?: boolean;
};

const StyledContainer = styled.div<ContainerProps>`
const StyledContainer = styled.label<ContainerProps>`
align-items: center;
background-color: ${({ theme, isOn, color }) =>
isOn ? (color ?? theme.color.blue) : theme.background.transparent.medium};
Expand All @@ -23,20 +21,23 @@ const StyledContainer = styled.div<ContainerProps>`
height: ${({ toggleSize }) => (toggleSize === 'small' ? 16 : 20)}px;
transition: background-color 0.3s ease;
width: ${({ toggleSize }) => (toggleSize === 'small' ? 24 : 32)}px;
opacity: ${({ disabled }) => (disabled ? 0.5 : 1)};
pointer-events: ${({ disabled }) => (disabled ? 'none' : 'auto')};
opacity: ${({ 'data-disabled': disabled }) => (disabled ? 0.5 : 1)};
pointer-events: ${({ 'data-disabled': disabled }) =>
disabled ? 'none' : 'auto'};
`;

const StyledCircle = styled(motion.div)<{
const StyledCircle = styled(motion.span)<{
size: ToggleSize;
}>`
display: block;
background-color: ${({ theme }) => theme.background.primary};
border-radius: 50%;
height: ${({ size }) => (size === 'small' ? 12 : 16)}px;
width: ${({ size }) => (size === 'small' ? 12 : 16)}px;
`;

export type ToggleProps = {
id?: string;
value?: boolean;
onChange?: (value: boolean) => void;
color?: string;
Expand All @@ -46,49 +47,39 @@ export type ToggleProps = {
};

export const Toggle = ({
value,
id,
value = false,
onChange,
color,
toggleSize = 'medium',
className,
disabled,
}: ToggleProps) => {
const [isOn, setIsOn] = useState(value ?? false);

const circleVariants = {
on: { x: toggleSize === 'small' ? 10 : 14 },
off: { x: 2 },
};

const handleChange = () => {
setIsOn(!isOn);

if (isDefined(onChange)) {
onChange(!isOn);
}
};

useEffect(() => {
setIsOn((isOn) => {
if (value !== isOn) {
return value ?? false;
}

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

return (
<StyledContainer
onClick={handleChange}
isOn={isOn}
isOn={value}
color={color}
toggleSize={toggleSize}
className={className}
disabled={disabled}
data-disabled={disabled}
>
<VisibilityHiddenInput
id={id}
type="checkbox"
checked={value}
disabled={disabled}
onChange={(event) => {
onChange?.(event.target.checked);
}}
/>

<StyledCircle
animate={isOn ? 'on' : 'off'}
animate={value ? 'on' : 'off'}
variants={circleVariants}
size={toggleSize}
/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Toggle } from '@/ui/input/components/Toggle';
import { isAdvancedModeEnabledState } from '@/ui/navigation/navigation-drawer/states/isAdvancedModeEnabledState';
import styled from '@emotion/styled';
import { useId } from 'react';
import { useRecoilState } from 'recoil';
import { IconTool, MAIN_COLORS } from 'twenty-ui';

Expand All @@ -12,7 +13,7 @@ const StyledContainer = styled.div`
position: relative;
`;

const StyledText = styled.span`
const StyledLabel = styled.label`
color: ${({ theme }) => theme.font.color.secondary};
font-size: ${({ theme }) => theme.font.size.sm};
font-weight: ${({ theme }) => theme.font.weight.medium};
Expand Down Expand Up @@ -41,6 +42,7 @@ export const AdvancedSettingsToggle = () => {
const [isAdvancedModeEnabled, setIsAdvancedModeEnabled] = useRecoilState(
isAdvancedModeEnabledState,
);
const inputId = useId();

const onChange = (newValue: boolean) => {
setIsAdvancedModeEnabled(newValue);
Expand All @@ -52,8 +54,10 @@ export const AdvancedSettingsToggle = () => {
<StyledIconTool size={12} color={MAIN_COLORS.yellow} />
</StyledIconContainer>
<StyledToggleContainer>
<StyledText>Advanced:</StyledText>
<StyledLabel htmlFor={inputId}>Advanced:</StyledLabel>

<Toggle
id={inputId}
onChange={onChange}
color={MAIN_COLORS.yellow}
value={isAdvancedModeEnabled}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import styled from '@emotion/styled';
import { VISIBILITY_HIDDEN } from '@ui/accessibility/utils/visibility-hidden';

const StyledSpan = styled.span`
${VISIBILITY_HIDDEN}
`;

export const VisibilityHidden = ({
children,
}: {
children: React.ReactNode;
}) => {
return <StyledSpan>{children}</StyledSpan>;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import styled from '@emotion/styled';
import { VISIBILITY_HIDDEN } from '@ui/accessibility/utils/visibility-hidden';

// eslint-disable-next-line @nx/workspace-styled-components-prefixed-with-styled
export const VisibilityHiddenInput = styled.input`
${VISIBILITY_HIDDEN}
`;
3 changes: 3 additions & 0 deletions packages/twenty-ui/src/accessibility/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export * from './components/VisibilityHidden';
export * from './components/VisibilityHiddenInput';
export * from './utils/visibility-hidden';
13 changes: 13 additions & 0 deletions packages/twenty-ui/src/accessibility/utils/visibility-hidden.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { css } from '@emotion/react';

export const VISIBILITY_HIDDEN = css`
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
white-space: nowrap;
border-width: 0;
`;
1 change: 1 addition & 0 deletions packages/twenty-ui/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './accessibility';
export * from './components';
export * from './display';
export * from './layout';
Expand Down

0 comments on commit 1466d44

Please sign in to comment.