Skip to content

fix: ensure isReadonly applies to all non-literal date segments #7969

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
LFDanLu merged 10 commits into from
Aug 29, 2025
Merged

fix: ensure isReadonly applies to all non-literal date segments #7969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3ed43ed
fix: force data-readonly when datefield is readonly
Persists Mar 20, 2025
5f8443f
chore: simplify isEditable
Persists Mar 20, 2025
c51d74d
Merge branch 'main' into fix-readonly-datesegment
Persists Apr 7, 2025
73ea82a
Merge branch 'main' into fix-readonly-datesegment
snowystinger May 19, 2025
c91c224
adding tests
snowystinger May 19, 2025
e3c9bfe
Merge branch 'main' into fix-readonly-datesegment
snowystinger Jul 15, 2025
d6fb6af
update based on expectations
snowystinger Jul 15, 2025
51bb1e0
fix formatting
snowystinger Jul 15, 2025
9488738
Apply suggestion from @snowystinger
snowystinger Jul 15, 2025
b69c18d
Merge branch 'main' into fix-readonly-datesegment
snowystinger Aug 25, 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
14 changes: 7 additions & 7 deletions packages/react-aria-components/src/DateField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,11 +111,11 @@ export const DateField = /*#__PURE__*/ (forwardRef as forwardRefType)(function D
slot={props.slot || undefined}
data-invalid={state.isInvalid || undefined}
data-disabled={state.isDisabled || undefined} />
<HiddenDateInput
<HiddenDateInput
autoComplete={props.autoComplete}
name={props.name}
isDisabled={props.isDisabled}
state={state} />
state={state} />
</Provider>
);
});
Expand Down Expand Up @@ -180,7 +180,7 @@ export const TimeField = /*#__PURE__*/ (forwardRef as forwardRefType)(function T
{...renderProps}
ref={ref}
slot={props.slot || undefined}
data-invalid={state.isInvalid || undefined}
data-invalid={state.isInvalid || undefined}
data-disabled={state.isDisabled || undefined} />
</Provider>
);
Expand Down Expand Up @@ -269,6 +269,7 @@ const DateInputInner = forwardRef((props: DateInputProps, ref: ForwardedRef<HTML
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}))}
Expand Down Expand Up @@ -337,12 +338,11 @@ export const DateSegment = /*#__PURE__*/ (forwardRef as forwardRefType)(function
let {segmentProps} = useDateSegment(segment, state, domRef);
let {focusProps, isFocused, isFocusVisible} = useFocusRing();
let {hoverProps, isHovered} = useHover({...otherProps, isDisabled: state.isDisabled || segment.type === 'literal'});
let {isEditable, ...segmentRest} = segment;
let renderProps = useRenderProps({
...otherProps,
values: {
...segmentRest,
isReadOnly: !isEditable,
...segment,
isReadOnly: state.isReadOnly,
isInvalid: state.isInvalid,
isDisabled: state.isDisabled,
isHovered,
Expand All @@ -361,7 +361,7 @@ export const DateSegment = /*#__PURE__*/ (forwardRef as forwardRefType)(function
ref={domRef}
data-placeholder={segment.isPlaceholder || undefined}
data-invalid={state.isInvalid || undefined}
data-readonly={!isEditable || undefined}
data-readonly={state.isReadOnly || undefined}
data-disabled={state.isDisabled || undefined}
data-type={segment.type}
data-hovered={isHovered || undefined}
Expand Down
7 changes: 5 additions & 2 deletions packages/react-aria-components/src/Group.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ export interface GroupProps extends AriaLabelingProps, Omit<HTMLAttributes<HTMLE
isDisabled?: boolean,
/** Whether the group is invalid. */
isInvalid?: boolean,
/** Whether the group is read only. */
isReadOnly?: boolean,
/**
* An accessibility role for the group. By default, this is set to `'group'`.
* Use `'region'` when the contents of the group is important enough to be
Expand All @@ -65,7 +67,7 @@ export const GroupContext = createContext<ContextValue<GroupProps, HTMLDivElemen
*/
export const Group = /*#__PURE__*/ (forwardRef as forwardRefType)(function Group(props: GroupProps, ref: ForwardedRef<HTMLDivElement>) {
[props, ref] = useContextProps(props, ref, GroupContext);
let {isDisabled, isInvalid, onHoverStart, onHoverChange, onHoverEnd, ...otherProps} = props;
let {isDisabled, isInvalid, isReadOnly, onHoverStart, onHoverChange, onHoverEnd, ...otherProps} = props;

let {hoverProps, isHovered} = useHover({onHoverStart, onHoverChange, onHoverEnd, isDisabled});
let {isFocused, isFocusVisible, focusProps} = useFocusRing({
Expand All @@ -92,7 +94,8 @@ export const Group = /*#__PURE__*/ (forwardRef as forwardRefType)(function Group
data-hovered={isHovered || undefined}
data-focus-visible={isFocusVisible || undefined}
data-disabled={isDisabled || undefined}
data-invalid={isInvalid || undefined}>
data-invalid={isInvalid || undefined}
data-readonly={isReadOnly || undefined}>
{renderProps.children}
</div>
);
Expand Down
6 changes: 6 additions & 0 deletions packages/react-aria-components/stories/DateField.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ export default {
isInvalid: {
control: 'boolean'
},
isDisabled: {
control: 'boolean'
},
isReadOnly: {
control: 'boolean'
},
validationBehavior: {
control: 'select',
options: ['native', 'aria']
Expand Down
65 changes: 64 additions & 1 deletion packages/react-aria-components/test/DateField.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ describe('DateField', () => {
expect(segment).toHaveAttribute('data-placeholder', 'true');
expect(segment).toHaveAttribute('data-type');
expect(segment).toHaveAttribute('data-test', 'test');
expect(segment).not.toHaveAttribute('data-readonly');
}

for (let literal of [...input.children].filter(child => child.getAttribute('data-type') === 'literal')) {
expect(literal).not.toHaveAttribute('data-readonly');
}
});

Expand Down Expand Up @@ -164,7 +169,7 @@ describe('DateField', () => {
});

it('should support disabled state', () => {
let {getByRole} = render(
let {getByRole, getAllByRole} = render(
<DateField isDisabled>
<Label>Birth date</Label>
<DateInput className={({isDisabled}) => isDisabled ? 'disabled' : ''}>
Expand All @@ -175,6 +180,64 @@ describe('DateField', () => {
let group = getByRole('group');
expect(group).toHaveAttribute('data-disabled');
expect(group).toHaveClass('disabled');

for (let segment of getAllByRole('spinbutton')) {
expect(segment).not.toHaveAttribute('data-readonly');
expect(segment).toHaveAttribute('data-disabled');
}
for (let literal of [...group.children].filter(child => child.getAttribute('data-type') === 'literal')) {
expect(literal).not.toHaveAttribute('data-readonly');
expect(literal).toHaveAttribute('data-disabled');
}
});

it('should support readonly with disabled state', () => {
let {getByRole, getAllByRole} = render(
<DateField isReadOnly isDisabled>
<Label>Birth date</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
</DateField>
);

let group = getByRole('group');
expect(group).toHaveAttribute('data-readonly');
expect(group).toHaveAttribute('data-disabled');

for (let segment of getAllByRole('spinbutton')) {
expect(segment).toHaveAttribute('data-readonly');
expect(segment).toHaveAttribute('data-disabled');
}
for (let literal of [...group.children].filter(child => child.getAttribute('data-type') === 'literal')) {
expect(literal).toHaveAttribute('data-readonly');
expect(literal).toHaveAttribute('data-disabled');
}
});

it('should support readonly state', () => {
let {getByRole, getAllByRole} = render(
<DateField isReadOnly>
<Label>Birth date</Label>
<DateInput>
{segment => <DateSegment segment={segment} />}
</DateInput>
</DateField>
);

let group = getByRole('group');
expect(group).toHaveAttribute('data-readonly');
expect(group).not.toHaveAttribute('data-disabled');
expect(group).not.toHaveClass('disabled');

for (let segment of getAllByRole('spinbutton')) {
expect(segment).toHaveAttribute('data-readonly');
expect(segment).not.toHaveAttribute('data-disabled');
}
for (let literal of [...group.children].filter(child => child.getAttribute('data-type') === 'literal')) {
expect(literal).toHaveAttribute('data-readonly');
expect(literal).not.toHaveAttribute('data-disabled');
}
});

it('should support render props', () => {
Expand Down