@octanejs/aria 0.0.39 → 0.0.41

package/src/components/DateField.tsx

@@ -0,0 +1,580 @@
+/** @jsxImportSource octane */
+// Ported from adobe/react-spectrum@1c84a49a1faf50b571c84e00bcf9c60b22ddd03e (packages/react-aria-components/src/DateField.tsx).
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import {
+	AriaDateFieldProps,
+	useDateField,
+	useDateSegment,
+} from '../upstream-exports/react-aria/useDateField';
+import { AriaTimeFieldProps, useTimeField } from '../upstream-exports/react-aria/useTimeField';
+import {
+	ClassNameOrFunction,
+	ContextValue,
+	dom,
+	Provider,
+	RACValidation,
+	removeDataAttributes,
+	RenderProps,
+	SlotProps,
+	StyleRenderProps,
+	useContextProps,
+	useRenderProps,
+	useSlot,
+	useSlottedContext,
+} from './utils';
+import { createCalendar } from '@internationalized/date';
+import {
+	DateFieldState,
+	DateSegmentType,
+	DateValue,
+	DateSegment as IDateSegment,
+	useDateFieldState,
+} from '../upstream-exports/react-stately/useDateFieldState';
+import { FieldErrorContext } from './FieldError';
+import { filterDOMProps } from '../upstream-exports/react-aria/filterDOMProps';
+import { FormContext } from './Form';
+import { forwardRefType, GlobalDOMAttributes } from '@react-types/shared';
+import { Group, GroupContext } from './Group';
+import { HiddenDateInput } from './HiddenDateInput';
+import { HoverEvents } from '@react-types/shared';
+import { Input, InputContext } from './Input';
+import { LabelContext } from './Label';
+import { mergeProps } from '../upstream-exports/react-aria/mergeProps';
+import React, {
+	cloneElement,
+	createContext,
+	ForwardedRef,
+	forwardRef,
+	JSX,
+	ReactElement,
+	useContext,
+	useRef,
+} from '../compat/react';
+import { TextContext } from './Text';
+import {
+	TimeFieldState,
+	useTimeFieldState,
+} from '../upstream-exports/react-stately/useTimeFieldState';
+import { TimeValue } from '../upstream-exports/react-stately/useTimeFieldState';
+import { useFocusRing } from '../upstream-exports/react-aria/useFocusRing';
+import { useHover } from '../upstream-exports/react-aria/useHover';
+import { useLocale } from '../upstream-exports/react-aria/I18nProvider';
+import { useObjectRef } from '../upstream-exports/react-aria/useObjectRef';
+
+export interface DateFieldRenderProps {
+	/**
+	 * State of the date field.
+	 */
+	state: DateFieldState;
+	/**
+	 * Whether the date field is invalid.
+	 *
+	 * @selector [data-invalid]
+	 */
+	isInvalid: boolean;
+	/**
+	 * Whether the date field is disabled.
+	 *
+	 * @selector [data-disabled]
+	 */
+	isDisabled: boolean;
+	/**
+	 * Whether the date field is read only.
+	 *
+	 * @selector [data-readonly]
+	 */
+	isReadOnly: boolean;
+	/**
+	 * Whether the date field is required.
+	 *
+	 * @selector [data-required]
+	 */
+	isRequired: boolean;
+}
+export interface DateFieldProps<T extends DateValue>
+	extends
+		Omit<
+			AriaDateFieldProps<T>,
+			'label' | 'description' | 'errorMessage' | 'validationState' | 'validationBehavior'
+		>,
+		RACValidation,
+		RenderProps<DateFieldRenderProps>,
+		SlotProps,
+		GlobalDOMAttributes<HTMLDivElement> {
+	/**
+	 * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
+	 * element. A function may be provided to compute the class based on component state.
+	 *
+	 * @default 'react-aria-DateField'
+	 */
+	className?: ClassNameOrFunction<DateFieldRenderProps>;
+}
+export interface TimeFieldProps<T extends TimeValue>
+	extends
+		Omit<
+			AriaTimeFieldProps<T>,
+			'label' | 'description' | 'errorMessage' | 'validationState' | 'validationBehavior'
+		>,
+		RACValidation,
+		RenderProps<DateFieldRenderProps>,
+		SlotProps,
+		GlobalDOMAttributes<HTMLDivElement> {
+	/**
+	 * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
+	 * element. A function may be provided to compute the class based on component state.
+	 *
+	 * @default 'react-aria-TimeField'
+	 */
+	className?: ClassNameOrFunction<DateFieldRenderProps>;
+}
+
+export const DateFieldContext =
+	createContext<ContextValue<DateFieldProps<any>, HTMLDivElement>>(null);
+export const TimeFieldContext =
+	createContext<ContextValue<TimeFieldProps<any>, HTMLDivElement>>(null);
+export const DateFieldStateContext = createContext<DateFieldState | null>(null);
+export const TimeFieldStateContext = createContext<TimeFieldState | null>(null);
+
+/**
+ * A date field allows users to enter and edit date and time values using a keyboard.
+ * Each part of a date value is displayed in an individually editable segment.
+ */
+export const DateField = /*#__PURE__*/ (forwardRef as any)(function DateField<T extends DateValue>(
+	props: DateFieldProps<T>,
+	ref: ForwardedRef<HTMLDivElement>,
+) {
+	[props, ref] = useContextProps(props, ref, DateFieldContext);
+	let { validationBehavior: formValidationBehavior } = useSlottedContext(FormContext) || {};
+	let validationBehavior = props.validationBehavior ?? formValidationBehavior ?? 'native';
+	let { locale } = useLocale();
+	let state = useDateFieldState({
+		...props,
+		locale,
+		createCalendar,
+		validationBehavior,
+	});
+
+	let fieldRef = useRef<HTMLDivElement>(null);
+	let [labelRef, label] = useSlot(!props['aria-label'] && !props['aria-labelledby']);
+	let inputRef = useRef<HTMLInputElement>(null);
+	let { labelProps, fieldProps, inputProps, descriptionProps, errorMessageProps, ...validation } =
+		useDateField(
+			{
+				...removeDataAttributes(props),
+				label,
+				inputRef,
+				validationBehavior,
+			},
+			state,
+			fieldRef,
+		);
+
+	let renderProps = useRenderProps({
+		...removeDataAttributes(props),
+		values: {
+			state,
+			isInvalid: state.isInvalid,
+			isDisabled: state.isDisabled,
+			isReadOnly: state.isReadOnly,
+			isRequired: props.isRequired || false,
+		},
+		defaultClassName: 'react-aria-DateField',
+	});
+
+	let DOMProps = filterDOMProps(props, { global: true });
+	delete DOMProps.id;
+
+	return (
+		<Provider
+			values={[
+				[DateFieldStateContext, state],
+				[
+					GroupContext,
+					{
+						...fieldProps,
+						ref: fieldRef,
+						isInvalid: state.isInvalid,
+						isDisabled: state.isDisabled,
+					},
+				],
+				[InputContext, { ...inputProps, ref: inputRef }],
+				[LabelContext, { ...labelProps, ref: labelRef, elementType: 'span' }],
+				[
+					TextContext,
+					{
+						slots: {
+							description: descriptionProps,
+							errorMessage: errorMessageProps,
+						},
+					},
+				],
+				[FieldErrorContext, validation],
+			]}
+		>
+			<dom.div
+				{...DOMProps}
+				{...renderProps}
+				ref={ref}
+				slot={props.slot || undefined}
+				data-invalid={state.isInvalid || undefined}
+				data-disabled={state.isDisabled || undefined}
+				data-readonly={state.isReadOnly || undefined}
+				data-required={props.isRequired || undefined}
+			/>
+			<HiddenDateInput
+				autoComplete={props.autoComplete}
+				name={props.name}
+				isDisabled={props.isDisabled}
+				state={state}
+			/>
+		</Provider>
+	);
+});
+
+/**
+ * A time field allows users to enter and edit time values using a keyboard.
+ * Each part of a time value is displayed in an individually editable segment.
+ */
+export const TimeField = /*#__PURE__*/ (forwardRef as any)(function TimeField<T extends TimeValue>(
+	props: TimeFieldProps<T>,
+	ref: ForwardedRef<HTMLDivElement>,
+) {
+	[props, ref] = useContextProps(props, ref, TimeFieldContext);
+	let { validationBehavior: formValidationBehavior } = useSlottedContext(FormContext) || {};
+	let validationBehavior = props.validationBehavior ?? formValidationBehavior ?? 'native';
+	let { locale } = useLocale();
+	let state = useTimeFieldState({
+		...props,
+		locale,
+		validationBehavior,
+	});
+
+	let fieldRef = useRef<HTMLDivElement>(null);
+	let [labelRef, label] = useSlot(!props['aria-label'] && !props['aria-labelledby']);
+	let inputRef = useRef<HTMLInputElement>(null);
+	let { labelProps, fieldProps, inputProps, descriptionProps, errorMessageProps, ...validation } =
+		useTimeField(
+			{
+				...removeDataAttributes(props),
+				label,
+				inputRef,
+				validationBehavior,
+			},
+			state,
+			fieldRef,
+		);
+
+	let renderProps = useRenderProps({
+		...props,
+		values: {
+			state,
+			isInvalid: state.isInvalid,
+			isDisabled: state.isDisabled,
+			isReadOnly: state.isReadOnly,
+			isRequired: props.isRequired || false,
+		},
+		defaultClassName: 'react-aria-TimeField',
+	});
+
+	let DOMProps = filterDOMProps(props, { global: true });
+	delete DOMProps.id;
+
+	return (
+		<Provider
+			values={[
+				[TimeFieldStateContext, state],
+				[
+					GroupContext,
+					{
+						...fieldProps,
+						ref: fieldRef,
+						isInvalid: state.isInvalid,
+						isDisabled: state.isDisabled,
+					},
+				],
+				[InputContext, { ...inputProps, ref: inputRef }],
+				[LabelContext, { ...labelProps, ref: labelRef, elementType: 'span' }],
+				[
+					TextContext,
+					{
+						slots: {
+							description: descriptionProps,
+							errorMessage: errorMessageProps,
+						},
+					},
+				],
+				[FieldErrorContext, validation],
+			]}
+		>
+			<dom.div
+				{...DOMProps}
+				{...renderProps}
+				ref={ref}
+				slot={props.slot || undefined}
+				data-invalid={state.isInvalid || undefined}
+				data-disabled={state.isDisabled || undefined}
+				data-readonly={state.isReadOnly || undefined}
+				data-required={props.isRequired || undefined}
+			/>
+		</Provider>
+	);
+});
+
+export interface DateInputRenderProps {
+	/**
+	 * Whether the date input is currently hovered with a mouse.
+	 *
+	 * @selector [data-hovered]
+	 */
+	isHovered: boolean;
+	/**
+	 * Whether an element within the date input is focused, either via a mouse or keyboard.
+	 *
+	 * @selector [data-focus-within]
+	 */
+	isFocusWithin: boolean;
+	/**
+	 * Whether an element within the date input is keyboard focused.
+	 *
+	 * @selector [data-focus-visible]
+	 */
+	isFocusVisible: boolean;
+	/**
+	 * Whether the date input is disabled.
+	 *
+	 * @selector [data-disabled]
+	 */
+	isDisabled: boolean;
+
+	/**
+	 * Whether the date input is invalid.
+	 *
+	 * @selector [data-invalid]
+	 */
+	isInvalid: boolean;
+}
+
+export interface DateInputProps
+	extends SlotProps, StyleRenderProps<DateInputRenderProps>, GlobalDOMAttributes<HTMLDivElement> {
+	/**
+	 * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
+	 * element. A function may be provided to compute the class based on component state.
+	 *
+	 * @default 'react-aria-DateInput'
+	 */
+	className?: ClassNameOrFunction<DateInputRenderProps>;
+	children: (segment: IDateSegment) => ReactElement;
+}
+
+/**
+ * A date input groups the editable date segments within a date field.
+ */
+export const DateInput = /*#__PURE__*/ (forwardRef as any)(function DateInput(
+	props: DateInputProps,
+	ref: ForwardedRef<HTMLDivElement>,
+): JSX.Element {
+	// If state is provided by DateField/TimeField, just render.
+	// Otherwise (e.g. in DatePicker), we need to call hooks and create state ourselves.
+	let dateFieldState = useContext(DateFieldStateContext);
+	let timeFieldState = useContext(TimeFieldStateContext);
+	return dateFieldState || timeFieldState ? (
+		<DateInputInner {...props} ref={ref} />
+	) : (
+		<DateInputStandalone {...props} ref={ref} />
+	);
+});
+
+const DateInputStandalone = forwardRef(
+	(props: DateInputProps, ref: ForwardedRef<HTMLDivElement>) => {
+		let [dateFieldProps, fieldRef] = useContextProps(
+			{ slot: props.slot } as DateFieldProps<any>,
+			ref,
+			DateFieldContext,
+		);
+		let { locale } = useLocale();
+		let state = useDateFieldState({
+			...dateFieldProps,
+			locale,
+			createCalendar,
+		});
+
+		let inputRef = useRef<HTMLInputElement>(null);
+		let { fieldProps, inputProps } = useDateField({ ...dateFieldProps, inputRef }, state, fieldRef);
+
+		return (
+			<Provider
+				values={[
+					[DateFieldStateContext, state],
+					[InputContext, { ...inputProps, ref: inputRef }],
+					[
+						GroupContext,
+						{
+							...fieldProps,
+							ref: fieldRef,
+							isInvalid: state.isInvalid,
+							isDisabled: state.isDisabled,
+						},
+					],
+				]}
+			>
+				<DateInputInner {...props} />
+			</Provider>
+		);
+	},
+);
+
+const DateInputInner = forwardRef((props: DateInputProps, ref: ForwardedRef<HTMLDivElement>) => {
+	let { className, children } = props;
+	let dateFieldState = useContext(DateFieldStateContext);
+	let timeFieldState = useContext(TimeFieldStateContext);
+	let state = dateFieldState ?? timeFieldState!;
+
+	return (
+		<>
+			<Group
+				{...props}
+				ref={ref}
+				slot={props.slot || undefined}
+				className={className ?? 'react-aria-DateInput'}
+				isReadOnly={state.isReadOnly}
+				isInvalid={state.isInvalid}
+				isDisabled={state.isDisabled}
+			>
+				{state.segments.map((segment, i) => cloneElement(children(segment), { key: i }))}
+			</Group>
+			<Input className="" />
+		</>
+	);
+});
+
+export interface DateSegmentRenderProps extends Omit<IDateSegment, 'isEditable'> {
+	/**
+	 * Whether the segment is currently hovered with a mouse.
+	 *
+	 * @selector [data-hovered]
+	 */
+	isHovered: boolean;
+	/**
+	 * Whether the segment is focused, either via a mouse or keyboard.
+	 *
+	 * @selector [data-focused]
+	 */
+	isFocused: boolean;
+	/**
+	 * Whether the segment is keyboard focused.
+	 *
+	 * @selector [data-focus-visible]
+	 */
+	isFocusVisible: boolean;
+	/**
+	 * Whether the value is a placeholder.
+	 *
+	 * @selector [data-placeholder]
+	 */
+	isPlaceholder: boolean;
+	/**
+	 * Whether the segment is read only.
+	 *
+	 * @selector [data-readonly]
+	 */
+	isReadOnly: boolean;
+	/**
+	 * Whether the date field is disabled.
+	 *
+	 * @selector [data-disabled]
+	 */
+	isDisabled: boolean;
+	/**
+	 * Whether the date field is in an invalid state.
+	 *
+	 * @selector [data-invalid]
+	 */
+	isInvalid: boolean;
+	/**
+	 * The type of segment. Values include `literal`, `year`, `month`, `day`, etc.
+	 *
+	 * @selector [data-type="..."]
+	 */
+	type: DateSegmentType;
+}
+
+export interface DateSegmentProps
+	extends
+		RenderProps<DateSegmentRenderProps, 'span'>,
+		HoverEvents,
+		GlobalDOMAttributes<HTMLSpanElement> {
+	/**
+	 * The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
+	 * element. A function may be provided to compute the class based on component state.
+	 *
+	 * @default 'react-aria-DateSegment'
+	 */
+	className?: ClassNameOrFunction<DateSegmentRenderProps>;
+	segment: IDateSegment;
+}
+
+/**
+ * A date segment displays an individual unit of a date and time, and allows users to edit
+ * the value by typing or using the arrow keys to increment and decrement.
+ */
+export const DateSegment = /*#__PURE__*/ (forwardRef as any)(function DateSegment(
+	{ segment, ...otherProps }: DateSegmentProps,
+	ref: ForwardedRef<HTMLSpanElement>,
+) {
+	let dateFieldState = useContext(DateFieldStateContext);
+	let timeFieldState = useContext(TimeFieldStateContext);
+	let state = dateFieldState ?? timeFieldState!;
+	let domRef = useObjectRef(ref);
+	let { segmentProps } = useDateSegment(segment, state, domRef);
+	let { focusProps, isFocused, isFocusVisible } = useFocusRing();
+	let { hoverProps, isHovered } = useHover({
+		...otherProps,
+		isDisabled: state.isDisabled || segment.type === 'literal',
+	});
+	let renderProps = useRenderProps({
+		...otherProps,
+		values: {
+			...segment,
+			isReadOnly: state.isReadOnly,
+			isInvalid: state.isInvalid,
+			isDisabled: state.isDisabled,
+			isHovered,
+			isFocused,
+			isFocusVisible,
+		},
+		defaultChildren: segment.text,
+		defaultClassName: 'react-aria-DateSegment',
+	});
+
+	return (
+		<dom.span
+			{...mergeProps(
+				filterDOMProps(otherProps, { global: true }),
+				segmentProps,
+				focusProps,
+				hoverProps,
+			)}
+			{...renderProps}
+			style={segmentProps.style}
+			ref={domRef}
+			data-placeholder={segment.isPlaceholder || undefined}
+			data-invalid={state.isInvalid || undefined}
+			data-readonly={state.isReadOnly || undefined}
+			data-disabled={state.isDisabled || undefined}
+			data-type={segment.type}
+			data-hovered={isHovered || undefined}
+			data-focused={isFocused || undefined}
+			data-focus-visible={isFocusVisible || undefined}
+		/>
+	);
+});