Add Timepicker

[Chizaruu]

Closes #1293

📑 Description

This Pull Request adds a fully functional Timepicker.

https://flowbite.com/docs/forms/timepicker/

• [x] Default timepicker
• [x] Timepicker with icon
• [x] Timepicker with dropdown
• [x] Timepicker with select
• [x] Timepicker range selector
• [x] Timerange with dropdown
• [x] Timerange picker with toggle
• [x] Inline timepicker buttons
• [x] Modal with timepicker
• [x] Drawer with timepicker

Status

• [] Not Completed
• [x] Completed

✅ Checks

• [x] My pull request adheres to the code style of this project
• [x] My code requires changes to the documentation
• [x] 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

Release Notes

• New Features

  • Introduced the Timepicker component for flexible time selection, supporting various modes such as dropdown, range, and inline buttons.
  • Added comprehensive documentation with detailed usage examples for the Timepicker component.

• Bug Fixes

  • Enhanced testing coverage for the Timepicker component to ensure proper functionality.

• Chores

  • Updated the package.json to include the new Timepicker component in the exports.
  • Added a new JSON file defining the Timepicker component's properties and events.

[vercel[bot]]

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

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

The pull request introduces a new Timepicker component to the flowbite-svelte project. This includes updates to the package.json to export the component, the creation of the Timepicker.svelte file with various properties and functionalities, a new JSON definition for the component, and comprehensive documentation. Additionally, a test case for the Timepicker component has been added to ensure its proper integration and functionality within the application.

Changes

File	Change Summary
package.json	Added new export for Timepicker.svelte with type definition and Svelte file paths.
src/lib/forms/Timepicker.svelte	Introduced Timepicker component with multiple properties and internal state management for time selection.
src/lib/index.js	Added export for Timepicker component from ./forms/Timepicker.svelte.
src/routes/component-data/Timepicker.json	Created JSON file defining the Timepicker component with its properties and events.
src/routes/docs/forms/timepicker.md	Added documentation for the Timepicker component, including setup instructions and usage examples.
tests/forms.spec.ts	Added test case to verify the presence of <h1> element on the Timepicker documentation page.

Assessment against linked issues

Objective	Addressed	Explanation
Default timepicker	✅
Timepicker with icon	✅
Timepicker with dropdown	✅
Timepicker with select	✅
Timepicker range selector	✅
Timerange with dropdown	✅
Timerange picker with toggle	✅
Inline timepicker buttons	✅
Modal with timepicker	✅
Drawer with timepicker	✅

• #1464: The changes in this PR involve updates to the DatePicker component, which is related to the new Timepicker component in the main PR as both are part of the form components in the Flowbite Svelte project.

"In a garden of time, I hop and play,
With a Timepicker here, brightening the day!
Select hours and minutes, in styles galore,
From dropdowns to buttons, oh, what a score!
With each tick and tock, my joy's on display,
Let's celebrate time in a whimsical way! 🐇✨"

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 04928fc27de246e843afd29645adaef46bef6c37 and 84ef383ee153d25ba7f7e8407b721d7a12f2d56b.

📒 Files selected for processing (1)

• package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• package.json

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
flowbite-svelte	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 19, 2024 1:09pm

[shinokada]

Thank you for your PR. I had a quick look and the followings are what I found.

Default timepicker

1. When I click outside to close the dropdown, the selected goes back to 00:00.
2. Above issue happens when you change the selected time.

Inline timepicker buttons

When I select a date, it doesn't highlight. Also when I click outside, the letter primary color disappear.

Modal with timepicker

Same issues as Inline timepicker buttons

Drawer with timepicker

As you see in the following image, it has wider space between day and time.

[Chizaruu]

Thank you for your PR. I had a quick look and the followings are what I found.

Default timepicker

1. When I click outside to close the dropdown, the selected goes back to 00:00.

2. Above issue happens when you change the selected time.

Default Timepicker doesn't have a dropdown, so I'm struggling to replicate it.

Inline timepicker buttons

When I select a date, it doesn't highlight. Also when I click outside, the letter primary color disappear.

Modal with timepicker

Same issues as Inline timepicker buttons

This is an issue with the Datepicker component, isSelected(day) isn't reactive, so the selected button's color isn't being updated with the component being open | inline

I submitted a PR addressing this issue. https://github.com/themesberg/flowbite-svelte/pull/1466

function isSameDate(date1: Date | null, date2: Date | null): boolean {
    if (!date1 || !date2) return false;
    return date1.toDateString() === date2.toDateString();
  }

  $: isSelected = (day: Date): boolean => {
    if (range) {
      return isSameDate(day, rangeFrom) || isSameDate(day, rangeTo);
    }
    return isSameDate(day, value);
  };

Drawer with timepicker

As you see in the following image, it has wider space between day and time.

Sorry, visual design isn't my strong suit. 😅 I've submitted a commit that should be more pleasant to the eye.

[shinokada]

Please let me know when it is ready.

[Chizaruu]

Please let me know when it is ready.

It looks okay to me. Please let me know if you have anything you want me to add/change. :)

[shinokada]

1. When I click outside to close, the time selected goes back to 00:00.
2. Sometimes, when I click the inside field, the dropdown doesn't open. I noticed that I have to click between numbers and right icon. This means clicking a number doesn't open a dropdown. Is it possible to open the dropdown when a user clicks anywhere in the field?
3. Hover doesn't change to a pointer. It needs hover:cursor-pointer.

[Chizaruu]

1. When I click outside to close, the time selected goes back to 00:00.

That is weird. I'll test this out and try to stop it from happening.

2. Sometimes, when I click the inside field, the dropdown doesn't open. I noticed that I have to click between numbers and right icon. This means clicking a number doesn't open a dropdown. Is it possible to open the dropdown when a user clicks anywhere in the field?

Ah, by chance, are you using Google Chrome for development? I usually develop using Firefox, which means this may be a browser compatibility issue. I'll see if I can sort this out soon.

3. Hover doesn't change to a pointer. It needs hover:cursor-pointer.

~~I'll add this in tomorrow afternoon (AEDT).~~ soon.

[arkangel-dev]

Hey, so when will this be pushed to NPM? Because the docs says there is Timepicker component but there isn't at the moment

[zevsasaki]

Please release a new version with this component.

[shinokada]

v0.48.5 updated.

[LewRobin]

1. When I click outside to close, the time selected goes back to 00:00.

That is weird. I'll test this out and try to stop it from happening.

2. Sometimes, when I click the inside field, the dropdown doesn't open. I noticed that I have to click between numbers and right icon. This means clicking a number doesn't open a dropdown. Is it possible to open the dropdown when a user clicks anywhere in the field?

Ah, by chance, are you using Google Chrome for development? I usually develop using Firefox, which means this may be a browser compatibility issue. I'll see if I can sort this out soon.

3. Hover doesn't change to a pointer. It needs hover:cursor-pointer.

~I'll add this in tomorrow afternoon (AEDT).~ soon.

Have these issue been addressed in the latest version? If not, is there a recommended workaround to prevent the time from resetting when focus changes and have the dropdown opening correctly?

[shinokada]

@Chizaruu Can you have a look at this, please?

[AlexKovynev]

@Chizaruu can it be ported to 1.0?