@ark-ui/react/dist/components/checkbox/use-checkbox.js

A collection of unstyled, accessible UI components for React, utilizing state machines for seamless interaction.

'use client';
import * as checkbox from '@zag-js/checkbox';
import { mergeProps, useMachine, normalizeProps } from '@zag-js/react';
import { useMemo, useId } from 'react';
import { useEnvironmentContext } from '../../providers/environment/use-environment-context.js';
import { useLocaleContext } from '../../providers/locale/use-locale-context.js';
import { useFieldContext } from '../field/use-field-context.js';
import { useCheckboxGroupContext } from './use-checkbox-group-context.js';

const useCheckbox = (ownProps = {}) => {
  const checkboxGroup = useCheckboxGroupContext();
  const field = useFieldContext();
  const props = useMemo(() => {
    return mergeProps(ownProps, checkboxGroup?.getItemProps({ value: ownProps.value }) ?? {});
  }, [ownProps, checkboxGroup]);
  const id = useId();
  const { getRootNode } = useEnvironmentContext();
  const { dir } = useLocaleContext();
  const machineProps = {
    id,
    ids: {
      label: field?.ids.label,
      hiddenInput: field?.ids.control
    },
    dir,
    disabled: field?.disabled,
    readOnly: field?.readOnly,
    invalid: field?.invalid,
    required: field?.required,
    getRootNode,
    ...props
  };
  const service = useMachine(checkbox.machine, machineProps);
  return checkbox.connect(service, normalizeProps);
};

export { useCheckbox };