Document Tooltip Feature in README.md

segun-codes commented 1 year ago

💡Format this Issue Into a First Timers Issue

This has been marked as a good candidate for becoming a first-timers-only issue like these, meaning that it's simple, self-contained, and with some extra formatting✍️, could be a great entry point for a new contributor. If you're familiar enough with this code, please consider reformatting it as a first-timers-only issue, and then ping @publiclab/reviewers to get it labeled🏷. Or, if this is not your first time, try to solve it yourself🧑‍💻!

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from underrepresented groups in free and open-source software!

We know that the process of creating a pull request is one of the biggest barriers for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

[ ] 🙋 Claim this issue: Claim the issue by commenting. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

💡 Learn how to claim 🙋

Claiming an issue

Unless the issue is marked as reserved for someone, you can just say "I'd like to try this!" and then you've claimed it - no need to wait for someone to assign it to you. Just be sure you link your pull request (PR) to this issue so we can see where your solution is.

And open one early if possible - even before you've completed it with additional commits - and others can help you figure out any issues you may face.

[ ] 📝 Update the file README.md in the Leaflet.DistortableImage repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

Place the diff below in line 80 (i.e., just below bullet point Suppress toolbar) and add a single line space afterward.

+  [tooltipText](#Tooltip-Text)

Place the diff below in line 337 (i.e. just above section UI Functionalities)

+  ### Tooltip Text
+  `tooltipText` (*optional*, default: '', value: *string*)
+
+  This provides the flexibility to add tooltip text to every image placed on the tile layer.
+
+  For ex.
+
+  ```js
+  // Sets up tooltip text for an image, the text is displayed when mouse is placed on it
+  img = L.distortableImageOverlay(
+         'example.jpg', 
+         {tooltipText: 'Sample text'}
+  );
+  ```

[ ] 💾 Commit your changes
[ ] 🔀 Start a Pull Request. There are two ways how you can start a pull request:

If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.
You can also edit files directly in your browser and open a pull request from there.

[ ] 🏁 Done Ask in comments for a review :)

🤔❓ Questions?

Is someone else already working on this?

We encourage you to link to this issue by mentioning the issue # in your pull request, so we can see if someone's already started on it. If someone seem stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

(This issue was created by First-Timers-Bot.)

segun-codes commented 1 year ago

@jywarren, we agreed to have the READMe.md file updated to explain how tooltip can be setup hence the need for this issue. If the suggestion in the diff section above is okay by you, then I will request @TildaDares to apply first-timer-only label on the issue. Many thanks!

sudeep162002 commented 1 year ago

hi everyone , I am new to this community and want to work on this issue . I have made a pull request .

publiclab / Leaflet.DistortableImage