fix(Datepicker): expose focus() and clear() methods via ref.

[MiroslavPetrik]

Closes #1299 (possibly #1039)

• I have followed the Your First Code Contribution section of the Contributing guide

Summarize the changes made and the motivation behind them.

Enhanced the Datepicker component to expose clear() and focus() ref methods.
This is required when datepicker value is in controlled mode.

Reference related issues using # followed by the issue number.

Closes #1299 and (possibly #1039)

If there are breaking API changes - like adding or removing props, or changing the structure of the theme - describe them, and provide steps to update existing code.

No breaking changes.

Summary by CodeRabbit

• New Features
  • Enhanced the Datepicker component to support direct manipulation through focus and clear methods.
• Refactor
  • Improved the Datepicker component's architecture for better usability and control.
• Tests
  • Added new tests to ensure the functionality of focusing and clearing values in the Datepicker component.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
flowbite-react	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 15, 2024 8:44am

[coderabbitai]

Walkthrough

This update significantly enhances the Datepicker component by integrating forwardRef and useImperativeHandle, allowing for direct manipulation via a ref. It introduces a DatepickerRef interface, offering focus and clear methods for external control. Furthermore, it improves internal functions and beefs up testing with new utilities and tests for the added methods, ensuring the component’s robustness and flexibility in handling user interactions.

Changes

File	Change Summary
src/components/Datepicker/Datepicker.tsx	- Refactored to use forwardRef and useImperativeHandle - Exposed DatepickerRef interface with focus and clear methods - Adjusted internal functions for better control - Added tests for focusing input and clearing value using ref.current
src/components/Datepicker/Datepicker.spec.tsx	- Added tests for focusing input and clearing value using ref.current

Assessment against linked issues

Objective	Addressed	Explanation
Enable forwarding of ref to the Datepicker component (#1299)	✅
Implement a programmatic API that exposes methods to the ref object using useImperativeHandle (#1299)	✅
Address the limitation of the Datepicker being uncontrolled and only accepting defaultValue but not the value prop (#1299)	✅
Implement a clear() method to reset the Datepicker value to the default (#1299)	✅
Allow the Datepicker to accept a ref for focusing the input programmatically (#1299)	✅

🐰✨📅✨🐰

A hop, a skip, in the code we dip,

To tweak and fix, with magic tricks.

Now with a tap, or a gentle click,

Focus, clear, all so slick.

In fields of dates, our choices stick.

🐰✨📅✨🐰

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>.
  • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.53%. Comparing base (7461173) to head (c8e46ba).
Report is 201 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1300      +/-   ##
==========================================
- Coverage   99.54%   95.53%   -4.02%     
==========================================
  Files         163      217      +54     
  Lines        6621     9665    +3044     
  Branches      401      558     +157     
==========================================
+ Hits         6591     9233    +2642     
- Misses         30      432     +402     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 31c9d9d and c8e46ba.

Files selected for processing (2)

• src/components/Datepicker/Datepicker.spec.tsx (2 hunks)
• src/components/Datepicker/Datepicker.tsx (5 hunks)

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

• src/components/Datepicker/Datepicker.spec.tsx
• src/components/Datepicker/Datepicker.tsx

[anshul-kai]

Calling clear() doesn't clear the rendered value. For folks looking for an interim hack, try the following approach using a key.

  const ref = useRef<DatepickerRef>(null);
  const [key, setKey] = useState(Date.now());

  useEffect(() => {
    if (value === null) {
      ref.current?.clear();
      setKey(Date.now());
    }
  }, [value]);

  return (
    <Flowbite theme={{ theme: customTheme }}>
      <Datepicker
        ref={ref}
        key={key}
        value={value}
        onChange={onChange}
      />
    </Flowbite>
  );