Skip to content

Calendar: support ID prop #25013

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
micahgodbolt merged 4 commits into from
Sep 29, 2022
Merged

Calendar: support ID prop #25013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2c85873
add ID to calendar types and pass to root div
micahgodbolt Sep 29, 2022
32abb85
change file
micahgodbolt Sep 29, 2022
5814f55
api update
micahgodbolt Sep 29, 2022
f9716ee
Update change/@fluentui-react-170d6594-4aee-4504-8885-b70ae2901269.json
micahgodbolt Sep 29, 2022
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
7 changes: 7 additions & 0 deletions change/@fluentui-react-170d6594-4aee-4504-8885-b70ae2901269.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "minor",
"comment": "chore: support ID prop in Calendar",
"packageName": "@fluentui/react",
"email": "[email protected]",
"dependentChangeType": "patch"
}
1 change: 1 addition & 0 deletions packages/react/etc/react.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3007,6 +3007,7 @@ export interface ICalendarProps extends IBaseProps<ICalendar>, React_2.RefAttrib
firstWeekOfYear?: FirstWeekOfYear;
highlightCurrentMonth?: boolean;
highlightSelectedMonth?: boolean;
id?: string;
isDayPickerVisible?: boolean;
isMonthPickerVisible?: boolean;
maxDate?: Date;
Expand Down
2 changes: 2 additions & 0 deletions packages/react/src/components/Calendar/Calendar.base.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,7 @@ export const CalendarBase: React.FunctionComponent<ICalendarProps> = React.forwa
minDate,
maxDate,
restrictedDates,
id,
className,
showCloseButton,
allFocusable,
Expand Down Expand Up @@ -326,6 +327,7 @@ export const CalendarBase: React.FunctionComponent<ICalendarProps> = React.forwa

return (
<div
id={id}
Copy link
Member

@GeoffCoxMSFT GeoffCoxMSFT Sep 29, 2022

Choose a reason for hiding this comment

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

I think v7 CalendarBase never actually applied id to the div. The forwarded ref has the HTMLDivElement props, but not the ICalendarProps. I think we could add id to v8, but then ODSP would see an output change when moving to v8.

Copy link
Member Author

@micahgodbolt micahgodbolt Sep 29, 2022

Choose a reason for hiding this comment

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

I checked it before, and the ID does get passed through. Here's a demo

https://codepen.io/micahgodbolt/pen/PoeRpVo?editors=0111

ref={forwardedRef}
role="group"
aria-label={selectionAndTodayString}
Expand Down
5 changes: 5 additions & 0 deletions packages/react/src/components/Calendar/Calendar.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ export interface ICalendarProps extends IBaseProps<ICalendar>, React.RefAttribut
*/
onDismiss?: () => void;

/**
* ID for the calendar
*/
id?: string;

/**
* Default value of the Calendar, if any
*/
Expand Down