This repository contains a React component called "MentionInput." It's designed to handle mentions in input fields, and it can be used in various applications.
To get started with this project, follow the steps below:
- Node.js: Make sure you have Node.js installed on your system.
-
Clone the repository to your local machine:
git clone https://github.com/Vasu7389/mention-input
-
Navigate to the project directory:
cd mention-input
-
Install the project dependencies:
npm install
To use the "MentionInput" component in your project, you can import it and include it in your application code. Here's an example of how to use it:
import MentionInput from "./MentionInput";
function App() {
return (
<div>
{/* Your other components */}
<MentionInput />
{/* Your other components */}
</div>
);
}
export default App;
To run the application locally, follow these steps:
-
Make sure you have completed the installation steps mentioned above.
-
Start the development server:
npm run dev
-
Open your web browser and visit http://localhost:5173 to view the application.
To run the test cases for the "MentionInput" component, you can use the following command:
npm test
This will execute the unit tests and provide you with the test results.
We welcome contributions to this project. If you'd like to contribute, please follow these steps:
-
Fork the repository on GitHub.
-
Clone your forked repository to your local machine.
-
Create a new branch for your work:
git checkout -b feature/my-feature
-
Make your changes, add tests if applicable, and commit them.
-
Push your changes to your fork on GitHub.
-
Create a pull request (PR) from your fork's branch to the main repository's
main
branch. Be sure to provide a clear and detailed description of your changes in the PR.
Thank you for your contributions!