Skip to content

[field controls] Respect validationMode #1053

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
merged 13 commits into from
Feb 5, 2025
Merged

[field controls] Respect validationMode #1053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9d7e6e4
[field controls] Respect validationMode
atomiks Dec 12, 2024
e101083
Remove unrelated changes
atomiks Dec 12, 2024
7d8b32e
Merge branch 'master' into fix/field-validationMode
atomiks Jan 21, 2025
fbbb2b6
Lint
atomiks Jan 21, 2025
ba639e0
Merge branch 'master' into fix/field-validationMode
atomiks Jan 23, 2025
8a0176d
Lint
atomiks Jan 23, 2025
c3069b6
Lint
atomiks Jan 23, 2025
9b99cca
Tests
atomiks Jan 23, 2025
014f593
Handle CheckboxGroup
atomiks Jan 24, 2025
1a7fd6b
Lint
atomiks Jan 24, 2025
9681061
Merge branch 'master' into fix/field-validationMode
atomiks Feb 4, 2025
9ff0731
Merge branch 'master' into fix/field-validationMode
atomiks Feb 5, 2025
23438c2
Wait for validity
atomiks Feb 5, 2025
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
3 changes: 3 additions & 0 deletions packages/react/src/checkbox-group/CheckboxGroup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { CheckboxGroupContext } from './CheckboxGroupContext';
import type { FieldRoot } from '../field/root/FieldRoot';
Copy link
Member

Choose a reason for hiding this comment

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

Don't think it's directly related to this PR, but I couldn't make a required checkbox group because required is a prop on individual checkboxes but not on CheckboxGroup:

// a combination of the CheckboxGroup and Field demos
export default function FieldCheckbox() {
  return (
    <Field.Root>
      <Field.Label>Pick one or more</Field.Label>

      <CheckboxGroup defaultValue={[]}>
        <label>
          <Checkbox.Root name="fuji-apple">
            <Checkbox.Indicator>
              <CheckIcon />
            </Checkbox.Indicator>
          </Checkbox.Root>
          Fuji
        </label>

        <label>
          <Checkbox.Root name="gala-apple">
            <Checkbox.Indicator>
              <CheckIcon />
            </Checkbox.Indicator>
          </Checkbox.Root>
          Gala
        </label>

        <label>
          <Checkbox.Root
            name="granny-smith-apple"
          >
            <Checkbox.Indicator>
              <CheckIcon />
            </Checkbox.Indicator>
          </Checkbox.Root>
          Granny Smith
        </label>
      </CheckboxGroup>

      <Field.Error match="valueMissing">
        You must pick at least one
      </Field.Error>
    </Field.Root>
  );
}

import { useFieldRootContext } from '../field/root/FieldRootContext';
import type { BaseUIComponentProps } from '../utils/types';
import { fieldValidityMapping } from '../field/utils/constants';

/**
* Provides a shared state to a series of checkboxes.
Expand Down Expand Up @@ -54,6 +55,7 @@ const CheckboxGroup = React.forwardRef(function CheckboxGroup(
state,
ref: forwardedRef,
extraProps: otherProps,
customStyleHookMapping: fieldValidityMapping,
});

const contextValue: CheckboxGroupContext = React.useMemo(
Expand Down Expand Up @@ -82,6 +84,7 @@ namespace CheckboxGroup {
*/
disabled: boolean;
}

export interface Props extends BaseUIComponentProps<'div', State> {
/**
* Names of the checkboxes in the group that should be ticked.
Expand Down
2 changes: 2 additions & 0 deletions packages/react/src/checkbox/indicator/CheckboxIndicator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { type TransitionStatus, useTransitionStatus } from '../../utils/useTrans
import { useForkRef } from '../../utils/useForkRef';
import type { CustomStyleHookMapping } from '../../utils/getStyleHookProps';
import { transitionStatusMapping } from '../../utils/styleHookMapping';
import { fieldValidityMapping } from '../../field/utils/constants';

/**
* Indicates whether the checkbox is ticked.
Expand Down Expand Up @@ -57,6 +58,7 @@ const CheckboxIndicator = React.forwardRef(function CheckboxIndicator(
() => ({
...baseStyleHookMapping,
...transitionStatusMapping,
...fieldValidityMapping,
}),
[baseStyleHookMapping],
);
Expand Down
39 changes: 32 additions & 7 deletions packages/react/src/checkbox/root/useCheckboxRoot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,16 @@ export function useCheckboxRoot(params: UseCheckboxRoot.Parameters): UseCheckbox
state: 'checked',
});

const { labelId, setControlId, setTouched, setDirty, validityData, setFilled, setFocused } =
useFieldRootContext();
const {
labelId,
setControlId,
setTouched,
setDirty,
validityData,
setFilled,
setFocused,
validationMode,
} = useFieldRootContext();

const buttonRef = React.useRef<HTMLButtonElement>(null);

Expand Down Expand Up @@ -103,7 +111,10 @@ export function useCheckboxRoot(params: UseCheckboxRoot.Parameters): UseCheckbox

setTouched(true);
setFocused(false);
commitValidation(element.checked);

if (validationMode === 'onBlur') {
commitValidation(groupContext ? groupValue : element.checked);
}
},
onClick(event) {
if (event.defaultPrevented || readOnly) {
Expand All @@ -125,7 +136,10 @@ export function useCheckboxRoot(params: UseCheckboxRoot.Parameters): UseCheckbox
labelId,
setFocused,
setTouched,
validationMode,
commitValidation,
groupContext,
groupValue,
],
);

Expand Down Expand Up @@ -153,20 +167,29 @@ export function useCheckboxRoot(params: UseCheckboxRoot.Parameters): UseCheckbox

const nextChecked = event.target.checked;

if (!groupContext) {
setFilled(nextChecked);
}

setDirty(nextChecked !== validityData.initialValue);
setCheckedState(nextChecked);
onCheckedChange?.(nextChecked, event.nativeEvent);

if (!groupContext) {
setFilled(nextChecked);

if (validationMode === 'onChange') {
commitValidation(nextChecked);
}
}

if (name && groupValue && setGroupValue) {
const nextGroupValue = nextChecked
? [...groupValue, name]
: groupValue.filter((item) => item !== name);

setGroupValue(nextGroupValue, event.nativeEvent);
setFilled(nextGroupValue.length > 0);

if (validationMode === 'onChange') {
commitValidation(nextGroupValue);
}
}
},
}),
Expand All @@ -184,8 +207,10 @@ export function useCheckboxRoot(params: UseCheckboxRoot.Parameters): UseCheckbox
validityData.initialValue,
setCheckedState,
onCheckedChange,
validationMode,
groupValue,
setGroupValue,
commitValidation,
setFilled,
],
);
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/field/control/FieldControl.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { useComponentRenderer } from '../../utils/useComponentRenderer';
import { useFieldControl } from './useFieldControl';
import { FieldRoot } from '../root/FieldRoot';
import { useFieldRootContext } from '../root/FieldRootContext';
import { STYLE_HOOK_MAPPING } from '../utils/constants';
import { fieldValidityMapping } from '../utils/constants';
import { BaseUIComponentProps } from '../../utils/types';

/**
Expand Down Expand Up @@ -60,7 +60,7 @@ const FieldControl = React.forwardRef(function FieldControl(
className,
state,
extraProps: otherProps,
customStyleHookMapping: STYLE_HOOK_MAPPING,
customStyleHookMapping: fieldValidityMapping,
});

return renderElement();
Expand Down
18 changes: 15 additions & 3 deletions packages/react/src/field/control/useFieldControl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,16 @@ import { useEventCallback } from '../../utils/useEventCallback';
export function useFieldControl(params: useFieldControl.Parameters) {
const { id: idProp, name, value: valueProp, defaultValue, onValueChange, disabled } = params;

const { setControlId, labelId, setTouched, setDirty, validityData, setFocused, setFilled } =
useFieldRootContext();
const {
setControlId,
labelId,
setTouched,
setDirty,
validityData,
setFocused,
setFilled,
validationMode,
} = useFieldRootContext();

const { errors, onClearErrors } = useFormContext();

Expand Down Expand Up @@ -87,7 +95,10 @@ export function useFieldControl(params: useFieldControl.Parameters) {
onBlur(event) {
setTouched(true);
setFocused(false);
commitValidation(event.currentTarget.value);

if (validationMode === 'onBlur') {
commitValidation(event.currentTarget.value);
}
},
onKeyDown(event) {
if (event.currentTarget.tagName === 'INPUT' && event.key === 'Enter') {
Expand All @@ -113,6 +124,7 @@ export function useFieldControl(params: useFieldControl.Parameters) {
onClearErrors,
setFocused,
setTouched,
validationMode,
commitValidation,
],
);
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/field/description/FieldDescription.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { useComponentRenderer } from '../../utils/useComponentRenderer';
import { FieldRoot } from '../root/FieldRoot';
import { useFieldRootContext } from '../root/FieldRootContext';
import { useFieldDescription } from './useFieldDescription';
import { STYLE_HOOK_MAPPING } from '../utils/constants';
import { fieldValidityMapping } from '../utils/constants';
import type { BaseUIComponentProps } from '../../utils/types';

/**
Expand All @@ -31,7 +31,7 @@ const FieldDescription = React.forwardRef(function FieldDescription(
className,
state,
extraProps: otherProps,
customStyleHookMapping: STYLE_HOOK_MAPPING,
customStyleHookMapping: fieldValidityMapping,
});

return renderElement();
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/field/error/FieldError.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { useComponentRenderer } from '../../utils/useComponentRenderer';
import { FieldRoot } from '../root/FieldRoot';
import { useFieldRootContext } from '../root/FieldRootContext';
import { useFieldError } from './useFieldError';
import { STYLE_HOOK_MAPPING } from '../utils/constants';
import { fieldValidityMapping } from '../utils/constants';
import { useFormContext } from '../../form/FormContext';
import type { BaseUIComponentProps } from '../../utils/types';

Expand Down Expand Up @@ -45,7 +45,7 @@ const FieldError = React.forwardRef(function FieldError(
className,
state,
extraProps: otherProps,
customStyleHookMapping: STYLE_HOOK_MAPPING,
customStyleHookMapping: fieldValidityMapping,
});

if (!rendered) {
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/field/label/FieldLabel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { useComponentRenderer } from '../../utils/useComponentRenderer';
import { FieldRoot } from '../root/FieldRoot';
import { useFieldRootContext } from '../root/FieldRootContext';
import { useFieldLabel } from './useFieldLabel';
import { STYLE_HOOK_MAPPING } from '../utils/constants';
import { fieldValidityMapping } from '../utils/constants';
import { useBaseUiId } from '../../utils/useBaseUiId';
import { useEnhancedEffect } from '../../utils/useEnhancedEffect';
import type { BaseUIComponentProps } from '../../utils/types';
Expand Down Expand Up @@ -42,7 +42,7 @@ const FieldLabel = React.forwardRef(function FieldLabel(
className,
state,
extraProps: otherProps,
customStyleHookMapping: STYLE_HOOK_MAPPING,
customStyleHookMapping: fieldValidityMapping,
});

return renderElement();
Expand Down
Loading