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.

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

Update Datepicker.svelte #1494

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Update Datepicker.svelte #1494

merged 1 commit into from
Dec 2, 2024

Conversation

cimagle
Copy link
Contributor

@cimagle cimagle commented Nov 26, 2024

fix days of previous month shown in wrong order

Closes #

πŸ“‘ Description

Status

  • Not Completed
  • Completed

βœ… Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • I have checked the page with https://validator.unl.edu/
  • All the tests have passed
  • My pull request is based on the latest commit (not the npm version).

β„Ή Additional Information

Summary by CodeRabbit

  • Bug Fixes
    • Improved the display order of days from the previous month in the datepicker component.

This change enhances the user experience by ensuring that the calendar view is more intuitive and visually organized.

fix days of previous month shown in wrong order
Copy link

vercel bot commented Nov 26, 2024

@cimagle is attempting to deploy a commit to the Themesberg Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

Walkthrough

The changes in this pull request involve a modification to the getDaysInMonth function within the Datepicker.svelte component. The adjustment alters how days from the previous month are added to the daysArray, switching from appending to prepending. This change impacts the order of days displayed but does not affect the overall functionality or structure of the datepicker, as no other logic or error handling has been modified.

Changes

File Path Change Summary
src/lib/datepicker/Datepicker.svelte Modified getDaysInMonth function to prepend days from the previous month to daysArray instead of appending.

Possibly related PRs

Poem

🐰 In the garden where the dates bloom,
A change was made to lift the gloom.
Days from the past now leap to the front,
Prepending joy in a cheerful hunt!
With each click, the calendar sings,
A dance of dates, oh what joy it brings! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@cimagle
Copy link
Contributor Author

cimagle commented Nov 26, 2024

the datepicker is showing the previous months dates wrong
image
pr is to fix the order of the prev months dates in the array
image

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
src/lib/datepicker/Datepicker.svelte (2)

Line range hint 93-107: Consider improving function organization and documentation.

The getDaysInMonth function handles multiple responsibilities and its name doesn't fully reflect its complete functionality. Consider these improvements:

  1. Rename to better reflect its purpose (e.g., generateCalendarGrid)
  2. Split into smaller, focused functions
  3. Add JSDoc comments explaining the logic

Here's a suggested refactor:

- function getDaysInMonth(date: Date): Date[] {
+ /**
+  * Generates a complete calendar grid for the given month, including padding days
+  * from adjacent months to ensure full weeks.
+  * @param date - Any date within the target month
+  * @returns Array of dates representing the calendar grid
+  */
+ function generateCalendarGrid(date: Date): Date[] {
   const year = date.getFullYear();
   const month = date.getMonth();
+   return [
+     ...getPreviousMonthPadding(year, month),
+     ...getCurrentMonthDays(year, month),
+     ...getNextMonthPadding(year, month)
+   ];
+ }
+
+ /** Get padding days from the previous month */
+ function getPreviousMonthPadding(year: number, month: number): Date[] {
   const firstDay = new Date(year, month, 0);
-   const lastDay = new Date(year, month + 1, 0);
   const daysArray: Date[] = [];
 
   let start = firstDay.getDay() - firstDayOfWeek;
   if (start < 0) start += 7;
   for (let i = 0; i < start; i++) {
     daysArray.unshift(new Date(year, month, -i));
   }
+   return daysArray;
+ }
 
-   // Add days of the current month
+  /** Get all days in the current month */
+  function getCurrentMonthDays(year: number, month: number): Date[] {
+   const lastDay = new Date(year, month + 1, 0);
+   const daysArray: Date[] = [];
   for (let i = 1; i <= lastDay.getDate(); i++) {
     daysArray.push(new Date(year, month, i));
   }
+   return daysArray;
+ }
 
-   // Add days from next month to fill the last week
+  /** Get padding days from the next month */
+  function getNextMonthPadding(year: number, month: number): Date[] {
+   const currentDays = getCurrentMonthDays(year, month);
+   const previousDays = getPreviousMonthPadding(year, month);
+   const daysArray: Date[] = [];
-   const remainingDays = 7 - (daysArray.length % 7);
+   const remainingDays = 7 - ((currentDays.length + previousDays.length) % 7);
   if (remainingDays < 7) {
     for (let i = 1; i <= remainingDays; i++) {
       daysArray.push(new Date(year, month + 1, i));
     }
   }
   return daysArray;
}

Line range hint 308-316: Enhance calendar grid accessibility.

While the component has good accessibility support, consider these improvements for the calendar grid:

  1. Add aria-label to the calendar grid
  2. Add aria-current="date" for today's date
  3. Add aria-disabled for dates from adjacent months
-        <div class="grid grid-cols-7 gap-1" role="grid">
+        <div 
+          class="grid grid-cols-7 gap-1" 
+          role="grid"
+          aria-label={`Calendar for ${currentMonth.toLocaleString(locale, { month: 'long', year: 'numeric' })}`}>
           {#each weekdays as day}
             <div class="text-center text-sm font-medium text-gray-500 dark:text-gray-400" role="columnheader">{day}</div>
           {/each}
           {#each daysInMonth as day}
-            <Button color={isSelected(day) ? color : 'alternative'} size="sm" class="w-full h-8 {day.getMonth() !== currentMonth.getMonth() ? 'text-gray-300 dark:text-gray-600' : ''} {isToday(day) ? 'font-bold' : ''} {isInRange(day) ? getRangeBackgroundClass(color) : ''}" on:click={() => handleDaySelect(day)} on:keydown={handleCalendarKeydown} aria-label={day.toLocaleDateString(locale, { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' })} aria-selected={isSelected(day)} role="gridcell">
+            <Button 
+              color={isSelected(day) ? color : 'alternative'} 
+              size="sm" 
+              class="w-full h-8 {day.getMonth() !== currentMonth.getMonth() ? 'text-gray-300 dark:text-gray-600' : ''} {isToday(day) ? 'font-bold' : ''} {isInRange(day) ? getRangeBackgroundClass(color) : ''}" 
+              on:click={() => handleDaySelect(day)} 
+              on:keydown={handleCalendarKeydown} 
+              aria-label={day.toLocaleDateString(locale, { weekday: 'long', year: 'numeric', month: 'long', day: 'numeric' })} 
+              aria-selected={isSelected(day)} 
+              aria-current={isToday(day) ? 'date' : undefined}
+              aria-disabled={day.getMonth() !== currentMonth.getMonth()}
+              role="gridcell">
               {day.getDate()}
             </Button>
           {/each}
         </div>
πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 6542fdb and a1d3b17.

πŸ“’ Files selected for processing (1)
  • src/lib/datepicker/Datepicker.svelte (1 hunks)
πŸ”‡ Additional comments (1)
src/lib/datepicker/Datepicker.svelte (1)

95-95: LGTM! The fix correctly addresses the previous month days ordering issue.

The change from push to unshift ensures that days from the previous month are added in chronological order. Previously, using push was causing the days to appear in reverse order since we were iterating through them backwards.

A few recommendations to ensure robustness:

  1. Consider adding test cases specifically for the calendar grid's first week to verify the ordering
  2. Update the component's documentation to mention this fix if there was a known issue being tracked

Let's verify the calendar grid's first week behavior:

Copy link

vercel bot commented Nov 27, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
flowbite-svelte ❌ Failed (Inspect) Nov 27, 2024 6:28am

@shinokada shinokada merged commit 23f3d08 into themesberg:main Dec 2, 2024
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants