Merge pull request #10 from ErikKalkoken/feat-improve-readme-2

feat: further improve readme

Author: dweymouth

README.md

@@ -1,15 +1,71 @@
 # fyne-tooltip
 
+Add-on package for Fyne adding tooltip support.
 
+[![GitHub Release](https://img.shields.io/github/v/release/dweymouth/fyne-tooltip)](https://github.com/dweymouth/fyne-tooltip/releases)
+[![Fyne](https://img.shields.io/badge/dynamic/regex?url=https%3A%2F%2Fgithub.com%2Fdweymouth%2Ffyne-tooltip%2Fblob%2Fmain%2Fgo.mod&search=fyne%5C.io%5C%2Ffyne%5C%2Fv2%20(v%5Cd*%5C.%5Cd*%5C.%5Cd*)&replace=%241&label=Fyne&cacheSeconds=https%3A%2F%2Fgithub.com%2Ffyne-io%2Ffyne)](https://github.com/fyne-io/fyne)
+[![Go Reference](https://pkg.go.dev/badge/github.com/dweymouth/fyne-tooltip.svg)](https://pkg.go.dev/github.com/dweymouth/fyne-tooltip)
+[![GitHub License](https://img.shields.io/github/license/dweymouth/fyne-tooltip)](https://github.com/dweymouth/fyne-tooltip?tab=MIT-1-ov-file#readme)
 
-https://github.com/user-attachments/assets/e9a2b9dd-9d6c-49f2-9c3a-b896fec4609d
+## Contents
+
+- [Overview](#overview)
+- [Demo](#demo)
+- [Example](#example)
+- [Guide](#guide)
+  - [Enabling tool tips in a window](#enabling-tool-tips-in-a-window)
+  - [Using built-in tool tip widgets](#using-built-in-tool-tip-widgets)
+  - [Enabling tool tips in a PopUp](#enabling-tool-tips-in-a-popup)
+  - [Creating new tool tip widgets](#creating-new-tool-tip-widgets)
+  - [Extending existing widgets for tool tip support](#extending-existing-widgets-for-tool-tip-support)
 
+## Overview
 
 **fyne-tooltip** is an add-on package for Fyne adding tooltip support. It provides a tool tip rendering system, along with drop-in tooltip-enabled extensions of several of the Fyne builtin widgets, as well as an easy means to extend existing widgets to add tool tip support, or creating new tooltip-enabled custom widgets. It aims to be easy and low-friction to integrate into your existing Fyne projects, as well as easy to remove and switch back to Fyne core if and when tooltips are supported natively.
 
 Tool tip widgets implement `desktop.Hoverable` to show the tool tips after a short delay on MouseIn, and hide them on MouseOut.
 
-## Enabling tool tips in a window
+## Demo
+
+In the following video you can see how tooltips look with **fyne-tooltip** in a Fyne app. The source code is available at `cmd/example.go`.
+
+https://github.com/user-attachments/assets/e9a2b9dd-9d6c-49f2-9c3a-b896fec4609d
+
+## Example
+
+The following is a complete Fyne app that shows how to use **fyne-tooltip** with a label widget.
+
+```go
+package main
+
+import (
+	"fyne.io/fyne/v2"
+	"fyne.io/fyne/v2/app"
+	"fyne.io/fyne/v2/container"
+	fynetooltip "github.com/dweymouth/fyne-tooltip"
+	ttwidget "github.com/dweymouth/fyne-tooltip/widget"
+)
+
+func main() {
+	myApp := app.New()
+	myWindow := myApp.NewWindow("Example")
+
+	label := ttwidget.NewLabel("This is a label")
+	label.SetToolTip("This is a tooltip")
+
+	content := container.NewCenter(label)
+	myWindow.SetContent(fynetooltip.AddWindowToolTipLayer(content, myWindow.Canvas()))
+
+	myWindow.Resize(fyne.NewSize(800, 600))
+	myWindow.ShowAndRun()
+}
+```
+
+## Guide
+
+This chapter explains how **fyne-tooltip** works and how to use it in your own Fyne apps.
+
+### Enabling tool tips in a window
 
 **fyne-tooltip** requires tool tip layers to be created for the tool tips to be rendered into, and provides APIs to do so for windows and pop-ups. It is called when setting the window's content:
 
@@ -27,7 +83,7 @@ window.SetCloseIntercept(func() {
 })
 ```
 
-## Using built-in tool tip widgets
+### Using built-in tool tip widgets
 
 Drop-in replacements for several built-in Fyne widgets are provided, which have been extended from the base implementation to add tool tip support.
 
@@ -46,7 +102,7 @@ func main() {
 }
 ```
 
-## Enabling tool tips in a PopUp
+### Enabling tool tips in a PopUp
 
 Similarly to windows, **fyne-tooltip** requires a tool tip layer to be created for pop ups to enable tool tips to be shown.
 It is called after creating the pop up with content, but before showing it.
@@ -60,7 +116,7 @@ pop.Show()
 The pop up may be hidden and re-shown. It is only necessary to create the pop up layer once. When the popup is hidden and will not be shown again,
 it is important to call `DestroyPopUpToolTipLayer` to release memory resources associated with the tool tip layer.
 
-## Creating new tool tip widgets
+### Creating new tool tip widgets
 
 To create custom widgets that are tool tip enabled, just extend from the `ToolTipWidget` base struct instead of `BaseWidget`. The widget will automatically
 have a SetToolTip API, and the mouse event hooks added to show and hide the tool tip.
@@ -79,7 +135,26 @@ func NewMyWidget() *MyWidget {
 }
 ```
 
-## Extending existing widgets for tool tip support
+If your custom widget implements `desktop.Hoverable`, e.g. to make it tappable, you must also forward calls to `ToolTipWidget` in your overridden methods to enable tooltips to work. Here is an example for how this could be implemented:
+
+```go
+func (w *CustomWidget) MouseIn(e *desktop.MouseEvent) {
+	w.ToolTipWidgetExtend.MouseIn(e)
+	// custom logic
+}
+
+func (w *CustomWidget) MouseMoved(e *desktop.MouseEvent) {
+	w.ToolTipWidgetExtend.MouseMoved(e)
+    // custom logic
+}
+
+func (w *CustomWidget) MouseOut() {
+	w.ToolTipWidgetExtend.MouseOut()
+	// custom logic
+}
+```
+
+### Extending existing widgets for tool tip support
 
 To extend existing widgets with tool tip support, use the `ToolTipWidgetExtend` struct. You must override `ExtendBaseWidget` to call both the
 parent widget's `ExtendBaseWidget`, as well as `ExtendToolTipWidget`
@@ -130,33 +205,3 @@ func (b *Button) MouseMoved(e *desktop.MouseEvent) {
 	b.Button.MouseMoved(e)
 }
 ```
-
-## Example app
-
-Below is a complete example app that shows how to use **fyne-tooltips**. The source code of the example app shown in the video is also available at `cmd/example.go`.
-
-```go
-package main
-
-import (
-	"fyne.io/fyne/v2"
-	"fyne.io/fyne/v2/app"
-	"fyne.io/fyne/v2/container"
-	fynetooltip "github.com/dweymouth/fyne-tooltip"
-	ttwidget "github.com/dweymouth/fyne-tooltip/widget"
-)
-
-func main() {
-	myApp := app.New()
-	myWindow := myApp.NewWindow("Example")
-
-	label := ttwidget.NewLabel("This is a label")
-	label.SetToolTip("This is a tooltip")
-
-	content := container.NewCenter(label)
-	myWindow.SetContent(fynetooltip.AddWindowToolTipLayer(content, myWindow.Canvas()))
-
-	myWindow.Resize(fyne.NewSize(800, 600))
-	myWindow.ShowAndRun()
-}
-```