Skip to content
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

feat: Add appendToBody prop for flexible datepicker positioning #311

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add appendToBody prop for flexible datepicker positioning #311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
73 changes: 59 additions & 14 deletions app/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import Datepicker, {
PopoverDirectionType,
WeekStringType
} from "../src";
import CloseIcon from "../src/components/icons/CloseIcon";
import { COLORS, DATE_LOOKING_OPTIONS } from "../src/constants";
import { dateFormat, dateIsValid } from "../src/libs/date";

Expand Down Expand Up @@ -45,6 +46,8 @@ export default function Playground() {
const [startWeekOn, setStartWeekOn] = useState<WeekStringType>("mon");
const [required, setRequired] = useState(false);
const [popoverDirection, setPopoverDirection] = useState<PopoverDirectionType>("down");
const [appendToBody, setAppendToBody] = useState(false);
const [isModalOpen, setIsModalOpen] = useState(false);

return (
<div className="px-4 py-8">
Expand All @@ -58,6 +61,36 @@ export default function Playground() {
<span className="text-gray-700">PlayGround</span>
</h1>

{/* Modal */}
{isModalOpen && appendToBody && (
<>
<div className="fixed inset-0 bg-black bg-opacity-50 z-40" />
<div className="fixed inset-0 z-50 flex items-center justify-center overflow-auto">
<div className="bg-white rounded-lg p-6 max-w-md w-full mx-4 relative">
<h2 className="text-xl font-bold mb-4">Datepicker in Modal</h2>
<p className="mb-4 text-gray-600">
Using appendToBody prevents the datepicker from being cut off by
modal overflow
</p>
<div className="mb-4">
<Datepicker
value={value}
onChange={setValue}
appendToBody
displayFormat="MMM DD, YYYY"
/>
</div>
<button
onClick={() => setIsModalOpen(false)}
className="absolute top-2 right-2 text-gray-500 hover:text-gray-700"
>
<CloseIcon className="w-6 h-6" />
</button>
</div>
</div>
</>
)}

<div className="max-w-md mx-auto my-4">
<Datepicker
value={value}
Expand Down Expand Up @@ -107,6 +140,7 @@ export default function Playground() {
apply: "AText"
}
}}
appendToBody={appendToBody}
asSingle={asSingle}
placeholder={placeholder}
separator={separator}
Expand All @@ -128,20 +162,6 @@ export default function Playground() {
}}
popoverDirection={popoverDirection}
required={required}
// classNames={{
// input: ({ disabled, readOnly, className }) => {
// if (disabled) {
// return "opacity-40";
// }
// return `className`;
// },
// toggleButton: () => {
// return "bg-blue-300 ease-in-out";
// },
// footer: () => {
// return `p-4 border-t border-gray-600 flex flex-row flex-wrap justify-end`;
// }
// }}
/>
</div>
<div className="py-4 max-w-3xl mx-auto flex flex-row flex-wrap">
Expand Down Expand Up @@ -244,6 +264,31 @@ export default function Playground() {
</label>
</div>
</div>
<div className="mb-2 w-1/2 sm:w-full">
<div className="inline-flex items-center">
<input
type="checkbox"
className="mr-2 rounded"
id="appendToBody"
checked={appendToBody}
onChange={e => setAppendToBody(e.target.checked)}
/>
<label className="block" htmlFor="appendToBody">
Append To Body
</label>
</div>
</div>

{appendToBody && (
<div className="text-center mb-8">
<button
onClick={() => setIsModalOpen(true)}
className="bg-blue-500 text-white px-4 py-2 rounded hover:bg-blue-600"
>
Open Calendar In Modal
</button>
</div>
)}
</div>

<div className="w-full sm:w-1/3 pr-2 flex flex-col">
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"@tailwindcss/forms": "^0.5.7",
"@types/node": "^22.3.0",
"@types/react": "^19.0.8",
"@types/react-dom": "^19.0.4",
"@typescript-eslint/eslint-plugin": "^8.22.0",
"@typescript-eslint/parser": "^8.22.0",
"autoprefixer": "^10.4.20",
Expand Down
165 changes: 120 additions & 45 deletions src/components/Datepicker.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { createPortal } from "react-dom";

import Calendar from "../components/Calendar";
import Footer from "../components/Footer";
Expand Down Expand Up @@ -74,7 +75,9 @@ const Datepicker = (props: DatepickerType) => {
toggleIcon = undefined,

useRange = true,
value = null
value = null,

appendToBody = false
} = props;

// Refs
Expand All @@ -96,11 +99,13 @@ const Datepicker = (props: DatepickerType) => {
const [input, setInput] = useState<HTMLInputElement | null>(null);

// Custom Hooks use
useOnClickOutside(containerRef.current, () => {
useOnClickOutside(containerRef.current, event => {
const container = containerRef.current;
if (container) {
hideDatepicker();
}
const calendar = calendarContainerRef.current;

if (calendar && calendar.contains(event?.target as Node)) return;

if (container) hideDatepicker();
});

// Functions
Expand Down Expand Up @@ -334,7 +339,8 @@ const Datepicker = (props: DatepickerType) => {
toggleClassName,
toggleIcon,
updateFirstDate: (newDate: Date) => firstGotoDate(newDate),
value
value,
appendToBody
};
}, [
minDate,
Expand Down Expand Up @@ -368,7 +374,8 @@ const Datepicker = (props: DatepickerType) => {
toggleClassName,
toggleIcon,
value,
firstGotoDate
firstGotoDate,
appendToBody
]);

const containerClassNameOverload = useMemo(() => {
Expand All @@ -390,56 +397,124 @@ const Datepicker = (props: DatepickerType) => {
: defaultPopupClassName;
}, [popupClassName]);

const calculatePosition = useCallback(() => {
if (!appendToBody || !input) return {};

const inputRect = input.getBoundingClientRect();
const scrollTop = window.pageYOffset || document.documentElement.scrollTop;
const scrollLeft = window.pageXOffset || document.documentElement.scrollLeft;

return {
position: "fixed" as const,
top: inputRect.bottom + scrollTop + 1,
left: inputRect.left + scrollLeft,
zIndex: 1000
};
}, [appendToBody, input]);

return (
<DatepickerContext.Provider value={contextValues}>
<div className={containerClassNameOverload} ref={containerRef}>
<Input />

<div className={popupClassNameOverload} ref={calendarContainerRef}>
<Arrow ref={arrowRef} />

<div className="mt-2.5 shadow-sm border border-gray-300 px-1 py-0.5 bg-white dark:bg-slate-800 dark:text-white dark:border-slate-600 rounded-lg">
<div className="flex flex-col lg:flex-row py-2">
{showShortcuts && <Shortcuts />}

<div
className={`flex items-stretch flex-col md:flex-row space-y-4 md:space-y-0 md:space-x-1.5 ${
showShortcuts ? "md:pl-2" : "md:pl-1"
} pr-2 lg:pr-1`}
>
<Calendar
date={firstDate}
onClickPrevious={previousMonthFirst}
onClickNext={nextMonthFirst}
changeMonth={changeFirstMonth}
changeYear={changeFirstYear}
minDate={minDate}
maxDate={maxDate}
/>

{useRange && (
<>
<div className="flex items-center">
<VerticalDash />
</div>

{appendToBody ? (
createPortal(
<div
className={popupClassNameOverload}
ref={calendarContainerRef}
style={calculatePosition()}
>
<Arrow ref={arrowRef} />
<div className="mt-2.5 shadow-sm border border-gray-300 px-1 py-0.5 bg-white dark:bg-slate-800 dark:text-white dark:border-slate-600 rounded-lg">
<div className="flex flex-col lg:flex-row py-2">
{showShortcuts && <Shortcuts />}

<div
className={`flex items-stretch flex-col md:flex-row space-y-4 md:space-y-0 md:space-x-1.5 ${
showShortcuts ? "md:pl-2" : "md:pl-1"
} pr-2 lg:pr-1`}
>
<Calendar
date={secondDate}
onClickPrevious={previousMonthSecond}
onClickNext={nextMonthSecond}
changeMonth={changeSecondMonth}
changeYear={changeSecondYear}
date={firstDate}
onClickPrevious={previousMonthFirst}
onClickNext={nextMonthFirst}
changeMonth={changeFirstMonth}
changeYear={changeFirstYear}
minDate={minDate}
maxDate={maxDate}
/>
</>
)}

{useRange && (
<>
<div className="flex items-center">
<VerticalDash />
</div>

<Calendar
date={secondDate}
onClickPrevious={previousMonthSecond}
onClickNext={nextMonthSecond}
changeMonth={changeSecondMonth}
changeYear={changeSecondYear}
minDate={minDate}
maxDate={maxDate}
/>
</>
)}
</div>
</div>

{showFooter && <Footer />}
</div>
</div>,
document.body
)
) : (
<div className={popupClassNameOverload} ref={calendarContainerRef}>
<Arrow ref={arrowRef} />
<div className="mt-2.5 shadow-sm border border-gray-300 px-1 py-0.5 bg-white dark:bg-slate-800 dark:text-white dark:border-slate-600 rounded-lg">
<div className="flex flex-col lg:flex-row py-2">
{showShortcuts && <Shortcuts />}

<div
className={`flex items-stretch flex-col md:flex-row space-y-4 md:space-y-0 md:space-x-1.5 ${
showShortcuts ? "md:pl-2" : "md:pl-1"
} pr-2 lg:pr-1`}
>
<Calendar
date={firstDate}
onClickPrevious={previousMonthFirst}
onClickNext={nextMonthFirst}
changeMonth={changeFirstMonth}
changeYear={changeFirstYear}
minDate={minDate}
maxDate={maxDate}
/>

{useRange && (
<>
<div className="flex items-center">
<VerticalDash />
</div>

<Calendar
date={secondDate}
onClickPrevious={previousMonthSecond}
onClickNext={nextMonthSecond}
changeMonth={changeSecondMonth}
changeYear={changeSecondYear}
minDate={minDate}
maxDate={maxDate}
/>
</>
)}
</div>
</div>
</div>

{showFooter && <Footer />}
{showFooter && <Footer />}
</div>
</div>
</div>
)}
</div>
</DatepickerContext.Provider>
);
Expand Down
Loading