@cdx-ui/primitives 0.0.1-alpha.5 → 0.0.1-alpha.6

package/src/checkbox/createCheckboxRoot.tsx

@@ -0,0 +1,100 @@
+import { forwardRef } from 'react';
+import { composeEventHandlers } from '@cdx-ui/utils';
+import { useFocus } from '@react-native-aria/focus';
+import { usePress } from '@react-native-aria/interactions';
+import { dataAttributes } from '../utils/dataAttributes';
+import { CheckboxProvider } from './context';
+import type { ICheckboxProps } from './types';
+import { useCheckboxRoot } from './useCheckboxRoot';
+
+export const createCheckboxRoot = <T,>(BaseCheckbox: React.ComponentType<T>) =>
+  forwardRef(
+    (
+      {
+        onPressIn,
+        onPressOut,
+        onHoverIn,
+        onHoverOut,
+        onFocus,
+        onBlur,
+        children,
+        ...props
+      }: ICheckboxProps,
+      ref?: React.Ref<T>,
+    ) => {
+      const {
+        isHovered: isHoveredProp,
+        isChecked: isCheckedProp,
+        isDisabled: isDisabledProp,
+        isInvalid: isInvalidProp,
+        isReadOnly: isReadOnlyProp,
+        isPressed: isPressedProp,
+        isFocused: isFocusedProp,
+        isIndeterminate: isIndeterminateProp,
+        isFocusVisible,
+      } = props;
+
+      const {
+        combinedProps,
+        isInvalid,
+        isReadOnly,
+        isIndeterminate,
+        groupItemInputProps,
+        isChecked,
+        isDisabled,
+        isHovered,
+        hoverProps,
+        mergedRef,
+      } = useCheckboxRoot(props, ref);
+
+      const { focusProps, isFocused } = useFocus();
+
+      const { pressProps, isPressed } = usePress({
+        isDisabled: isDisabled || isDisabledProp,
+      });
+
+      return (
+        <BaseCheckbox
+          disabled={isDisabled || isDisabledProp}
+          {...pressProps}
+          {...(combinedProps as T)}
+          {...groupItemInputProps}
+          ref={mergedRef}
+          role="checkbox"
+          onPressIn={composeEventHandlers(onPressIn, pressProps.onPressIn)}
+          onPressOut={composeEventHandlers(onPressOut, pressProps.onPressOut)}
+          onHoverIn={composeEventHandlers(onHoverIn, hoverProps.onHoverIn)}
+          onHoverOut={composeEventHandlers(onHoverOut, hoverProps.onHoverOut)}
+          onFocus={composeEventHandlers(composeEventHandlers(onFocus, focusProps.onFocus))}
+          onBlur={composeEventHandlers(composeEventHandlers(onBlur, focusProps.onBlur))}
+          {...dataAttributes({
+            checked: isChecked || isCheckedProp,
+            disabled: isDisabled || isDisabledProp,
+            hover: isHovered || isHoveredProp,
+            invalid: isInvalid || isInvalidProp,
+            readonly: isReadOnly || isReadOnlyProp,
+            active: isPressed,
+            focus: isFocused,
+            indeterminate: isIndeterminate || isIndeterminateProp,
+            focusVisible: isFocusVisible,
+          })}
+        >
+          <CheckboxProvider
+            value={{
+              isChecked: isChecked || isCheckedProp,
+              isDisabled: isDisabled || isDisabledProp,
+              isHovered: isHovered || isHoveredProp,
+              isInvalid: isInvalid || isInvalidProp,
+              isReadOnly: isReadOnly || isReadOnlyProp,
+              isPressed: isPressed || isPressedProp,
+              isFocused: isFocused || isFocusedProp,
+              isIndeterminate: isIndeterminate || isIndeterminateProp,
+              isFocusVisible,
+            }}
+          >
+            {children}
+          </CheckboxProvider>
+        </BaseCheckbox>
+      );
+    },
+  );

package/src/checkbox/createCheckboxRoot.web.tsx

@@ -0,0 +1,77 @@
+import { forwardRef } from 'react';
+import { VisuallyHidden } from '@react-aria/visually-hidden';
+import { useFocusRing } from '@react-native-aria/focus';
+import { dataAttributes } from '../utils/dataAttributes';
+import { CheckboxProvider } from './context';
+import type { ICheckboxProps } from './types';
+import { useCheckboxRoot } from './useCheckboxRoot';
+
+export const createCheckboxRoot = <T,>(BaseCheckbox: React.ComponentType<T>) =>
+  forwardRef(({ children, ...props }: ICheckboxProps, ref?: React.Ref<T>) => {
+    const {
+      isHovered: isHoveredProp,
+      isFocusVisible: isFocusVisibleProp,
+      isChecked: isCheckedProp,
+      isDisabled: isDisabledProp,
+      isInvalid: isInvalidProp,
+      isReadOnly: isReadOnlyProp,
+      isIndeterminate: isIndeterminateProp,
+      isFocused,
+      isPressed,
+    } = props;
+
+    const {
+      combinedProps,
+      isInvalid,
+      isReadOnly,
+      isIndeterminate,
+      groupItemInputProps,
+      isChecked,
+      isDisabled,
+      isHovered,
+      mergedRef,
+      inputRef,
+    } = useCheckboxRoot(props, ref, { useInputRefForAria: true });
+
+    const { focusProps, isFocusVisible } = useFocusRing();
+
+    return (
+      <BaseCheckbox
+        {...(combinedProps as T)}
+        ref={mergedRef}
+        role="label"
+        // eslint-disable-next-line react-native-a11y/has-valid-accessibility-role
+        accessibilityRole="label"
+        {...dataAttributes({
+          checked: isChecked || isCheckedProp,
+          disabled: isDisabled || isDisabledProp,
+          hover: isHovered || isHoveredProp,
+          invalid: isInvalid || isInvalidProp,
+          readonly: isReadOnly || isReadOnlyProp,
+          active: isPressed,
+          focus: isFocused,
+          indeterminate: isIndeterminate || isIndeterminateProp,
+          focusVisible: isFocusVisible,
+        })}
+      >
+        <CheckboxProvider
+          value={{
+            isChecked: isChecked || isCheckedProp,
+            isDisabled: isDisabled || isDisabledProp,
+            isFocusVisible: isFocusVisible || isFocusVisibleProp,
+            isHovered: isHovered || isHoveredProp,
+            isInvalid: isInvalid || isInvalidProp,
+            isReadOnly: isReadOnly || isReadOnlyProp,
+            isIndeterminate: isIndeterminate || isIndeterminateProp,
+            isPressed,
+            isFocused,
+          }}
+        >
+          <VisuallyHidden>
+            <input {...groupItemInputProps} {...focusProps} ref={inputRef} />
+          </VisuallyHidden>
+          {children}
+        </CheckboxProvider>
+      </BaseCheckbox>
+    );
+  });

package/src/checkbox/index.ts

@@ -0,0 +1,43 @@
+import { createCheckboxGroup } from './createCheckboxGroup';
+import { createCheckboxIcon } from './createCheckboxIcon';
+import { createCheckboxIndicator } from './createCheckboxIndicator';
+import { createCheckboxLabel } from './createCheckboxLabel';
+import { createCheckboxRoot } from './createCheckboxRoot';
+import type { ICheckboxComponentType } from './types';
+
+export type {
+  ICheckboxComponentType,
+  ICheckboxGroupProps,
+  ICheckboxIconProps,
+  ICheckboxIndicatorProps,
+  ICheckboxLabelProps,
+  ICheckboxProps,
+} from './types';
+
+export const createCheckbox = <Root, Indicator, Icon, Label, Group>({
+  Root,
+  Indicator,
+  Icon,
+  Label,
+  Group,
+}: {
+  Root: React.ComponentType<Root>;
+  Indicator: React.ComponentType<Indicator>;
+  Icon: React.ComponentType<Icon>;
+  Label: React.ComponentType<Label>;
+  Group: React.ComponentType<Group>;
+}) => {
+  const Checkbox = createCheckboxRoot(Root) as any;
+  Checkbox.Indicator = createCheckboxIndicator(Indicator);
+  Checkbox.Icon = createCheckboxIcon(Icon);
+  Checkbox.Label = createCheckboxLabel(Label);
+  Checkbox.Group = createCheckboxGroup(Group);
+
+  Checkbox.displayName = 'Checkbox';
+  Checkbox.Indicator.displayName = 'Checkbox.Indicator';
+  Checkbox.Icon.displayName = 'Checkbox.Icon';
+  Checkbox.Label.displayName = 'Checkbox.Label';
+  Checkbox.Group.displayName = 'Checkbox.Group';
+
+  return Checkbox as ICheckboxComponentType<Root, Indicator, Icon, Label, Group>;
+};

package/src/checkbox/types.ts

@@ -0,0 +1,74 @@
+import type { PressableProps } from 'react-native';
+export interface InterfaceCheckbox extends PressableProps {
+  value: string;
+  onChange?: (isSelected: boolean) => void;
+  children?: React.ReactNode;
+  defaultIsChecked?: boolean;
+  isChecked?: boolean;
+  isDisabled?: boolean;
+  isInvalid?: boolean;
+  isReadOnly?: boolean;
+  isHovered?: boolean;
+  isFocused?: boolean;
+  isPressed?: boolean;
+  isRequired?: boolean;
+  isIndeterminate?: boolean;
+  isFocusVisible?: boolean;
+}
+
+export interface ICheckboxGroupProps {
+  value: string[];
+  onChange?: (values: string[]) => void;
+  children?: React.ReactNode;
+  isDisabled?: boolean;
+  isInvalid?: boolean;
+  isReadOnly?: boolean;
+  isRequired?: boolean;
+  'aria-label'?: string;
+}
+
+export type ICheckboxComponentType<Root, Indicator, Icon, Label, Group> =
+  React.ForwardRefExoticComponent<
+    React.RefAttributes<Root> & React.PropsWithoutRef<Root> & InterfaceCheckbox
+  > & {
+    Indicator: React.ForwardRefExoticComponent<
+      React.RefAttributes<Indicator> & React.PropsWithoutRef<Indicator> & ICheckboxIndicatorProps
+    >;
+    Icon: React.ForwardRefExoticComponent<
+      React.RefAttributes<Icon> & React.PropsWithoutRef<Icon> & ICheckboxIconProps
+    >;
+    Label: React.ForwardRefExoticComponent<
+      React.RefAttributes<Label> & React.PropsWithoutRef<Label> & ICheckboxLabelProps
+    >;
+    Group: React.ForwardRefExoticComponent<
+      React.RefAttributes<Group> & React.PropsWithoutRef<Group> & ICheckboxGroupProps
+    >;
+  };
+
+export interface ICheckboxIndicatorProps {
+  children?: React.ReactNode;
+}
+
+export interface ICheckboxIconProps {
+  children?: React.ReactNode;
+  /** Render the icon even when unchecked */
+  forceMount?: boolean;
+}
+
+export interface ICheckboxLabelProps {
+  children?: React.ReactNode;
+}
+
+export type ICheckboxProps = InterfaceCheckbox;
+
+export interface ICheckboxContextValue {
+  isChecked?: boolean;
+  isDisabled?: boolean;
+  isHovered?: boolean;
+  isInvalid?: boolean;
+  isReadOnly?: boolean;
+  isPressed?: boolean;
+  isFocused?: boolean;
+  isIndeterminate?: boolean;
+  isFocusVisible?: boolean;
+}

package/src/checkbox/useCheckboxRoot.ts

@@ -0,0 +1,85 @@
+import { useContext, useRef } from 'react';
+import { mergeRefs, useFormControlContext } from '@cdx-ui/utils';
+import { useCheckbox } from '@react-native-aria/checkbox';
+import { useHover } from '@react-native-aria/interactions';
+import { useToggleState } from '@react-stately/toggle';
+import { CheckboxGroupContext } from './context';
+import type { ICheckboxProps } from './types';
+
+interface UseCheckboxRootOptions {
+  useInputRefForAria?: boolean;
+}
+
+export function useCheckboxRoot(
+  props: ICheckboxProps,
+  ref?: React.Ref<unknown>,
+  { useInputRefForAria = false }: UseCheckboxRootOptions = {},
+) {
+  const formControlContext = useFormControlContext();
+
+  const { isInvalid, isReadOnly, isIndeterminate, ...combinedProps } = {
+    ...formControlContext,
+    ...props,
+  };
+
+  const checkboxGroupContext = useContext(CheckboxGroupContext);
+
+  const state = useToggleState({
+    ...combinedProps,
+    defaultSelected: props.defaultIsChecked,
+    isSelected: props.isChecked,
+  });
+
+  const rootRef = useRef(null);
+  const inputRef = useRef<HTMLInputElement | null>(null);
+  const mergedRootRef = mergeRefs(ref as any, rootRef as any);
+  const ariaLabel = combinedProps['aria-label'] || combinedProps.value || 'Checkbox';
+
+  const groupToggleState = useToggleState(
+    checkboxGroupContext
+      ? {
+          isReadOnly: isReadOnly || checkboxGroupContext.state.isReadOnly,
+          isSelected: checkboxGroupContext.state.isSelected(combinedProps.value),
+          onChange(isSelected: boolean) {
+            if (isSelected) {
+              checkboxGroupContext.state.addValue(combinedProps.value);
+            } else {
+              checkboxGroupContext.state.removeValue(combinedProps.value);
+            }
+            combinedProps.onChange?.(isSelected);
+          },
+        }
+      : { isSelected: false },
+  );
+
+  const { inputProps: groupItemInputProps } = useCheckbox(
+    {
+      ...combinedProps,
+      'aria-label': ariaLabel,
+      ...(checkboxGroupContext && {
+        isReadOnly: isReadOnly || checkboxGroupContext.state.isReadOnly,
+        isDisabled: combinedProps.isDisabled || checkboxGroupContext.state.isDisabled,
+      }),
+    } as any,
+    checkboxGroupContext ? groupToggleState : state,
+    (useInputRefForAria ? inputRef : rootRef) as any,
+  );
+
+  const { checked: isChecked, disabled: isDisabled } = groupItemInputProps;
+
+  const { hoverProps, isHovered } = useHover({}, rootRef);
+
+  return {
+    combinedProps,
+    isInvalid,
+    isReadOnly,
+    isIndeterminate,
+    groupItemInputProps,
+    isChecked,
+    isDisabled,
+    isHovered,
+    hoverProps,
+    mergedRef: mergedRootRef,
+    inputRef,
+  };
+}

package/src/index.ts

@@ -1,4 +1,6 @@
 export * from './button';
+export * from './checkbox';
 export * from './input';
+export { type EdgeInsets, OverlayInsetsProvider } from './overlay';
 export * from './select';
-export { OverlayInsetsProvider, type EdgeInsets } from './overlay';
+export type { InteractionState } from './types';

package/src/select/types.ts

@@ -1,16 +1,8 @@
 import type { PropsWithoutRef, ReactNode, RefAttributes, RefObject } from 'react';
 import type { PressableProps, ViewProps } from 'react-native';
 import type { EntryOrExitLayoutType } from 'react-native-reanimated';
-
-// TODO: Consolidate with button/types.ts
-
-export interface InteractionState {
-  hover: boolean;
-  focus: boolean;
-  active: boolean;
-  disabled: boolean;
-  focusVisible: boolean;
-}
+import type { InteractionState } from '../types';
+export type { InteractionState };
 
 export interface SelectItemInteractionState extends InteractionState {
   highlighted: boolean;

package/src/types.ts

@@ -0,0 +1,7 @@
+export interface InteractionState {
+  hover: boolean;
+  focus: boolean;
+  active: boolean;
+  disabled: boolean;
+  focusVisible: boolean;
+}