feat: add focus and blur methods by reference

cervisebas commented 3 months ago

I would like the focus() and blur() methods to be added by reference, so that, through external components, these behaviors could be controlled.

Code example:

import { useRef, useState } from 'react';
import { View } from 'react-native';
import { Dropdown, DropdownRef } from 'react-native-paper-dropdown';
import { Button } from 'react-native-paper';

const OPTIONS = [
  { label: 'Male', value: 'male' },
  { label: 'Female', value: 'female' },
  { label: 'Other', value: 'other' },
];

export default function App() {
  const [gender, setGender] = useState<string>();
  const refDropdown = useRef<DropdownRef>(null);

  return(<View style={{ flexDirection: 'column' }}>
    <Dropdown
      ref={refDropdown}
      label={'Gender'}
      placeholder="Select Gender"
      options={OPTIONS}
      value={gender}
      onSelect={setGender}
    />

    <Button
      mode={'contained'}
      onPress={() => refDropdown.current?.focus()}
    >
      Focus
    </Button>
  </View>);
}

Video example:

https://github.com/user-attachments/assets/6fb7e010-e4d2-4a32-8205-d0913501f65d

Summary by CodeRabbit

New Features
- Introduced a dropdown component that can be focused and blurred via external buttons, enhancing user interaction.
- Added a multi-select dropdown with similar focus and blur capabilities for improved usability.
- Implemented error handling in the DropdownInput component to provide user feedback on form inputs.
Improvements
- Enhanced the Dropdown and MultiSelectDropdown components to support imperative method calls, allowing better integration within forms and other interactive elements.
Documentation
- Updated the documentation to include new methods for controlling dropdown visibility (focus() and blur()).
- Added a new type definition for DropdownRef, providing clear structure for dropdown control methods.

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent updates enhance the dropdown components across the application by introducing ref forwarding capabilities. This allows parent components to programmatically manage focus and blur states, improving user interactions through newly added buttons. The modifications foster a more interactive user interface, significantly elevating the overall functionality and responsiveness of the dropdown elements.

Changes

Files	Change Summary
`Example/src/App.tsx`	Introduced `useRef` for managing dropdown focus and blur; added buttons for user interaction with dropdown state.
`src/DropDown.tsx`	Added ref forwarding; exposed `focus` and `blur` methods for external control; updated export statement for `Dropdown`.
`src/multi-select-dropdown.tsx`	Incorporated ref forwarding and imperative methods (`focus`, `blur`); improved interaction capabilities.
`src/types.ts`	Defined new `DropdownRef` type to clarify the interface for focus and blur methods.
`src/dropdown-input.tsx`	Added `error` prop to handle error states in `TextInput`, enhancing usability.
`src/use-dropdown.ts`	Introduced `setEnable` function to control the dropdown's enabled state directly from external components.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Dropdown

    User->>App: Clicks Focus Button
    App->>Dropdown: Calls focus()
    Dropdown-->>User: Dropdown is focused

    User->>App: Clicks Blur Button
    App->>Dropdown: Calls blur()
    Dropdown-->>User: Dropdown is blurred

🐰 In fields where the bunnies play,
New dropdowns hop and sway.
With a click and a blink, they bloom,
Focusing bright, dismissing gloom.
Oh, the joy in each little flutter,
Interactive magic, making hearts flutter! 🌸

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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 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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

fateh999 commented 3 months ago

@cervisebas thanks for the pr, it is a good addition can you resolve the conflicts so I can merge it, I fixed some points.

fateh999 commented 3 months ago

@cervisebas once it gets merged we should update the documentation as well.

cervisebas commented 3 months ago

@cervisebas thanks for the pr, it is a good addition can you resolve the conflicts so I can merge it, I fixed some points.

Where can I see the conflicts?

fateh999 commented 3 months ago

@cervisebas thanks for the pr, it is a good addition can you resolve the conflicts so I can merge it, I fixed some points.

Where can I see the conflicts?

can you merge latest main in your branch. It should give you conflicts

cervisebas commented 3 months ago

@fateh999 Merge completed!

cervisebas commented 3 months ago

@cervisebas thanks for the pr, it is a good addition can you resolve the conflicts so I can merge it, I fixed some points.

Where can I see the conflicts?

can you merge latest main in your branch. It should give you conflicts

Thanks for the help

fateh999 / react-native-paper-dropdown