Features: Add hyperlink to text props

docs/assets/examples/textgrid/v2/main.go

@@ -84,5 +84,9 @@ func GetMaroto() core.Maroto {
 
 	m.AddRows(text.NewRow(10, "Multiline text with indentation"))
 
+	google := "https://google.com"
+
+	m.AddRows(text.NewRow(10, "text with hyperlink", props.Text{Hyperlink: &google}))
+
 	return m
 }

docs/assets/text/textgridv2.txt

@@ -1,4 +1,4 @@
-generate -> avg: 3.15ms, executions: [3.15ms]
-add_row -> avg: 67.50ns, executions: [111.00ns, 62.00ns, 25.00ns, 72.00ns]
-add_cols -> avg: 199.60ns, executions: [706.00ns, 119.00ns, 56.00ns, 67.00ns, 50.00ns]
-file_size -> 5.98Kb
+generate -> avg: 9.09ms, executions: [9.09ms]
+add_row -> avg: 325.00ns, executions: [667.00ns, 333.00ns, 250.00ns, 208.00ns, 167.00ns]
+add_rows -> avg: 141.60ns, executions: [208.00ns, 167.00ns, 83.00ns, 209.00ns, 41.00ns]
+file_size -> 8.66Kb

internal/fixture/fixture.go

@@ -17,6 +17,9 @@ import (
 
 func TextProp() props.Text {
 	fontProp := FontProp()
+
+	google := "https://www.google.com"
+
 	prop := props.Text{
 		Top:               12,
 		Left:              3,
@@ -27,6 +30,7 @@ func TextProp() props.Text {
 		BreakLineStrategy: breakline.DashStrategy,
 		VerticalPadding:   20,
 		Color:             fontProp.Color,
+		Hyperlink:         &google,
 	}
 	prop.MakeValid(&fontProp)
 	return prop

internal/providers/gofpdf/text.go

@@ -63,6 +63,11 @@
 		s.font.SetColor(textProp.Color)
 	}
 
+	// override style if hyperlink is set
+	if textProp.Hyperlink != nil {
+		s.font.SetColor(&props.BlueColor)
+	}
+
 	y += fontHeight
 
 	// Apply Unicode before calc spaces
@@ -171,8 +176,15 @@
 func (s *text) addLine(textProp *props.Text, xColOffset, colWidth, yColOffset, textWidth float64, text string) {
 	left, top, _, _ := s.pdf.GetMargins()
 
+	fontHeight := s.font.GetHeight(textProp.Family, textProp.Style, textProp.Size)
+
 	if textProp.Align == align.Left {
 		s.pdf.Text(xColOffset+left, yColOffset+top, text)
+
+		if textProp.Hyperlink != nil {
+			s.pdf.LinkString(xColOffset+left, yColOffset+top-fontHeight, textWidth, fontHeight, *textProp.Hyperlink)
+		}
+
 		return
 	}
 
@@ -184,6 +196,10 @@
 
 	dx := (colWidth - textWidth) / modifier
 
+	if textProp.Hyperlink != nil {
+		s.pdf.LinkString(dx+xColOffset+left, yColOffset+top-fontHeight, textWidth, fontHeight, *textProp.Hyperlink)
+	}
+
 	s.pdf.Text(dx+xColOffset+left, yColOffset+top, text)
 }
 

pkg/props/text.go

@@ -27,6 +27,8 @@
 	VerticalPadding float64
 	// Color define the fontstyle color.
 	Color *Color
+	// Hyperlink define a link to be opened when the text is clicked.
+	Hyperlink *string
 }
 
 func (t *Text) ToMap() map[string]interface{} {
@@ -71,6 +73,10 @@
 		m["prop_color"] = t.Color.ToString()
 	}
 
+	if t.Hyperlink != nil {
+		m["prop_hyperlink"] = *t.Hyperlink
+	}
+
 	return m
 }
 

test/maroto/components/texts/new_text_col_custom_prop.json

@@ -14,7 +14,8 @@
 				"prop_font_style": "B",
 				"prop_left": 3,
 				"prop_top": 12,
-				"prop_vertical_padding": 20
+				"prop_vertical_padding": 20,
+				"prop_hyperlink": "https://www.google.com"
 			}
 		}
 	]

test/maroto/components/texts/new_text_custom_prop.json

@@ -10,6 +10,7 @@
 		"prop_font_style": "B",
 		"prop_left": 3,
 		"prop_top": 12,
-		"prop_vertical_padding": 20
+		"prop_vertical_padding": 20,
+		"prop_hyperlink": "https://www.google.com"
 	}
 }

test/maroto/components/texts/new_text_row_custom_prop.json

@@ -21,7 +21,8 @@
 						"prop_font_style": "B",
 						"prop_left": 3,
 						"prop_top": 12,
-						"prop_vertical_padding": 20
+						"prop_vertical_padding": 20,
+						"prop_hyperlink": "https://www.google.com"
 					}
 				}
 			]