Move module to maragu.dev/gomponents-heroicons/v3 (#9)

.github/workflows/ci.yml

@@ -29,6 +29,7 @@ jobs:
         version:
           - "."
           - "v2"
+          - "v3"
 
     steps:
       - name: Checkout

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Maragu ApS
+Copyright (c) Maragu ApS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -2,3 +2,4 @@
 test:
 	go test -shuffle on ./...
 	cd v2 && go test -shuffle on ./...
+	cd v3 && go test -shuffle on ./...

README.md

@@ -1,19 +1,16 @@
 # gomponents + heroicons
 
-[Heroicons](https://heroicons.com) for [gomponents](https://www.gomponents.com).
+<img src="logo.png" alt="Logo" width="300" align="right">
 
-Heroicons has two version: v1 and v2. This library supports both.
+[![GoDoc](https://pkg.go.dev/badge/maragu.dev/gomponents-heroicons)](https://pkg.go.dev/maragu.dev/gomponents-heroicons)
+[![Go](https://github.com/maragudk/gomponents-heroicons/actions/workflows/ci.yml/badge.svg)](https://github.com/maragudk/gomponents-heroicons/actions/workflows/ci.yml)
 
-To get the newest v2:
+[Heroicons](https://heroicons.com) for [gomponents](https://www.gomponents.com).
 
 ```shell
-go get github.com/maragudk/gomponents-heroicons/v2@v2
+go get maragu.dev/gomponents-heroicons/v3@v3
 ```
 
-To get v1:
-
-```shell
-go get github.com/maragudk/gomponents-heroicons
-```
+Made with ✨sparkles✨ by [maragu](https://www.maragu.dev/).
 
-Made in 🇩🇰 by [maragu](https://www.maragu.dk), maker of [online Go courses](https://www.golang.dk/).
+Does your company depend on this project? [Contact me at markus@maragu.dk](mailto:markus@maragu.dk?Subject=Supporting%20your%20project) to discuss options for a one-time or recurring invoice to ensure its continued thriving.

v3/go.mod

@@ -0,0 +1,5 @@
+module maragu.dev/gomponents-heroicons/v3
+
+go 1.18
+
+require maragu.dev/gomponents v1.0.0

v3/go.sum

@@ -0,0 +1,2 @@
+maragu.dev/gomponents v1.0.0 h1:eeLScjq4PqP1l+r5z/GC+xXZhLHXa6RWUWGW7gSfLh4=
+maragu.dev/gomponents v1.0.0/go.mod h1:oEDahza2gZoXDoDHhw8jBNgH+3UR5ni7Ur648HORydM=

v3/heroicons.go

@@ -0,0 +1,38 @@
+package heroicons
+
+import (
+	. "maragu.dev/gomponents"
+	. "maragu.dev/gomponents/html"
+)
+
+func Outline(children ...Node) Node {
+	// <svg fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true">
+	return SVG(
+		Attr("fill", "none"),
+		Attr("viewBox", "0 0 24 24"),
+		Attr("stroke-width", "1.5"),
+		Attr("stroke", "currentColor"),
+		Aria("hidden", "true"),
+		Group(children),
+	)
+}
+
+func Solid(children ...Node) Node {
+	// <svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true">
+	return SVG(
+		Attr("viewBox", "0 0 24 24"),
+		Attr("fill", "currentColor"),
+		Aria("hidden", "true"),
+		Group(children),
+	)
+}
+
+func Mini(children ...Node) Node {
+	// <svg viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
+	return SVG(
+		Attr("viewBox", "0 0 20 20"),
+		Attr("fill", "currentColor"),
+		Aria("hidden", "true"),
+		Group(children),
+	)
+}

v3/heroicons_test.go

@@ -0,0 +1,29 @@
+package heroicons_test
+
+import (
+	"testing"
+
+	. "maragu.dev/gomponents"
+	. "maragu.dev/gomponents/html"
+
+	heroicons "maragu.dev/gomponents-heroicons/v3"
+	"maragu.dev/gomponents-heroicons/v3/internal/assert"
+)
+
+func TestOutline(t *testing.T) {
+	t.Run("returns svg with no fill, viewBox 0 0 24 24, stroke width 1.5, currentColor stroke", func(t *testing.T) {
+		assert.Equal(t, `<svg fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" aria-hidden="true" class="hat"><path></path></svg>`, heroicons.Outline(Class("hat"), El("path")))
+	})
+}
+
+func TestSolid(t *testing.T) {
+	t.Run("returns svg with viewbox 0 0 24 24, currentColor fill", func(t *testing.T) {
+		assert.Equal(t, `<svg viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" class="hat"><path></path></svg>`, heroicons.Solid(Class("hat"), El("path")))
+	})
+}
+
+func TestMini(t *testing.T) {
+	t.Run("returns svg with viewbox 0 0 20 20, currentColor fill", func(t *testing.T) {
+		assert.Equal(t, `<svg viewBox="0 0 20 20" fill="currentColor" aria-hidden="true" class="hat"><path></path></svg>`, heroicons.Mini(Class("hat"), El("path")))
+	})
+}

v3/internal/assert/assert.go

@@ -0,0 +1,20 @@
+// Package assert provides testing helpers.
+package assert
+
+import (
+	"strings"
+	"testing"
+
+	g "maragu.dev/gomponents"
+)
+
+// Equal checks for equality between the given expected string and the rendered Node string.
+func Equal(t *testing.T, expected string, actual g.Node) {
+	t.Helper()
+
+	var b strings.Builder
+	_ = actual.Render(&b)
+	if expected != b.String() {
+		t.Fatalf(`expected "%v" but got "%v"`, expected, b.String())
+	}
+}

v3/mini/academic_cap.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func AcademicCap(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M9.664 1.319a.75.75 0 01.672 0 41.059 41.059 0 018.198 5.424.75.75 0 01-.254 1.285 31.372 31.372 0 00-7.86 3.83.75.75 0 01-.84 0 31.508 31.508 0 00-2.08-1.287V9.394c0-.244.116-.463.302-.592a35.504 35.504 0 013.305-2.033.75.75 0 00-.714-1.319 37 37 0 00-3.446 2.12A2.216 2.216 0 006 9.393v.38a31.293 31.293 0 00-4.28-1.746.75.75 0 01-.254-1.285 41.059 41.059 0 018.198-5.424zM6 11.459a29.848 29.848 0 00-2.455-1.158 41.029 41.029 0 00-.39 3.114.75.75 0 00.419.74c.528.256 1.046.53 1.554.82-.21.324-.455.63-.739.914a.75.75 0 101.06 1.06c.37-.369.69-.77.96-1.193a26.61 26.61 0 013.095 2.348.75.75 0 00.992 0 26.547 26.547 0 015.93-3.95.75.75 0 00.42-.739 41.053 41.053 0 00-.39-3.114 29.925 29.925 0 00-5.199 2.801 2.25 2.25 0 01-2.514 0c-.41-.275-.826-.541-1.25-.797a6.985 6.985 0 01-1.084 3.45 26.503 26.503 0 00-1.281-.78A5.487 5.487 0 006 12v-.54z" clip-rule="evenodd"/>`))
+}

v3/mini/adjustments_horizontal.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func AdjustmentsHorizontal(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M10 3.75a2 2 0 10-4 0 2 2 0 004 0zM17.25 4.5a.75.75 0 000-1.5h-5.5a.75.75 0 000 1.5h5.5zM5 3.75a.75.75 0 01-.75.75h-1.5a.75.75 0 010-1.5h1.5a.75.75 0 01.75.75zM4.25 17a.75.75 0 000-1.5h-1.5a.75.75 0 000 1.5h1.5zM17.25 17a.75.75 0 000-1.5h-5.5a.75.75 0 000 1.5h5.5zM9 10a.75.75 0 01-.75.75h-5.5a.75.75 0 010-1.5h5.5A.75.75 0 019 10zM17.25 10.75a.75.75 0 000-1.5h-1.5a.75.75 0 000 1.5h1.5zM14 10a2 2 0 10-4 0 2 2 0 004 0zM10 16.25a2 2 0 10-4 0 2 2 0 004 0z"/>`))
+}

v3/mini/adjustments_vertical.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func AdjustmentsVertical(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M17 2.75a.75.75 0 00-1.5 0v5.5a.75.75 0 001.5 0v-5.5zM17 15.75a.75.75 0 00-1.5 0v1.5a.75.75 0 001.5 0v-1.5zM3.75 15a.75.75 0 01.75.75v1.5a.75.75 0 01-1.5 0v-1.5a.75.75 0 01.75-.75zM4.5 2.75a.75.75 0 00-1.5 0v5.5a.75.75 0 001.5 0v-5.5zM10 11a.75.75 0 01.75.75v5.5a.75.75 0 01-1.5 0v-5.5A.75.75 0 0110 11zM10.75 2.75a.75.75 0 00-1.5 0v1.5a.75.75 0 001.5 0v-1.5zM10 6a2 2 0 100 4 2 2 0 000-4zM3.75 10a2 2 0 100 4 2 2 0 000-4zM16.25 10a2 2 0 100 4 2 2 0 000-4z"/>`))
+}

v3/mini/archive_box.go

@@ -0,0 +1,13 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArchiveBox(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M2 3a1 1 0 00-1 1v1a1 1 0 001 1h16a1 1 0 001-1V4a1 1 0 00-1-1H2z"/>
+  <path fill-rule="evenodd" d="M2 7.5h16l-.811 7.71a2 2 0 01-1.99 1.79H4.802a2 2 0 01-1.99-1.79L2 7.5zM7 11a1 1 0 011-1h4a1 1 0 110 2H8a1 1 0 01-1-1z" clip-rule="evenodd"/>`))
+}

v3/mini/archive_box_arrow_down.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArchiveBoxArrowDown(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M2 3a1 1 0 00-1 1v1a1 1 0 001 1h16a1 1 0 001-1V4a1 1 0 00-1-1H2zm0 4.5h16l-.811 7.71a2 2 0 01-1.99 1.79H4.802a2 2 0 01-1.99-1.79L2 7.5zM10 9a.75.75 0 01.75.75v3.546l.943-1.048a.75.75 0 111.114 1.004l-2.25 2.5a.75.75 0 01-1.114 0l-2.25-2.5a.75.75 0 111.114-1.004l.943 1.048V9.75A.75.75 0 0110 9z" clip-rule="evenodd"/>`))
+}

v3/mini/archive_box_x_mark.go

@@ -0,0 +1,13 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArchiveBoxXMark(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M2 3a1 1 0 00-1 1v1a1 1 0 001 1h16a1 1 0 001-1V4a1 1 0 00-1-1H2z"/>
+  <path fill-rule="evenodd" d="M2 7.5h16l-.811 7.71a2 2 0 01-1.99 1.79H4.802a2 2 0 01-1.99-1.79L2 7.5zm5.22 1.72a.75.75 0 011.06 0L10 10.94l1.72-1.72a.75.75 0 111.06 1.06L11.06 12l1.72 1.72a.75.75 0 11-1.06 1.06L10 13.06l-1.72 1.72a.75.75 0 01-1.06-1.06L8.94 12l-1.72-1.72a.75.75 0 010-1.06z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_down.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDown(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M10 3a.75.75 0 01.75.75v10.638l3.96-4.158a.75.75 0 111.08 1.04l-5.25 5.5a.75.75 0 01-1.08 0l-5.25-5.5a.75.75 0 111.08-1.04l3.96 4.158V3.75A.75.75 0 0110 3z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_down_circle.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDownCircle(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm.75-11.25a.75.75 0 00-1.5 0v4.59L7.3 9.24a.75.75 0 00-1.1 1.02l3.25 3.5a.75.75 0 001.1 0l3.25-3.5a.75.75 0 10-1.1-1.02l-1.95 2.1V6.75z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_down_left.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDownLeft(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M14.78 5.22a.75.75 0 00-1.06 0L6.5 12.44V6.75a.75.75 0 00-1.5 0v7.5c0 .414.336.75.75.75h7.5a.75.75 0 000-1.5H7.56l7.22-7.22a.75.75 0 000-1.06z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_down_on_square.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDownOnSquare(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M13.75 7h-3v5.296l1.943-2.048a.75.75 0 011.114 1.004l-3.25 3.5a.75.75 0 01-1.114 0l-3.25-3.5a.75.75 0 111.114-1.004l1.943 2.048V7h1.5V1.75a.75.75 0 00-1.5 0V7h-3A2.25 2.25 0 004 9.25v7.5A2.25 2.25 0 006.25 19h7.5A2.25 2.25 0 0016 16.75v-7.5A2.25 2.25 0 0013.75 7z"/>`))
+}

v3/mini/arrow_down_on_square_stack.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDownOnSquareStack(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M8 1a.75.75 0 01.75.75V6h-1.5V1.75A.75.75 0 018 1zm-.75 5v3.296l-.943-1.048a.75.75 0 10-1.114 1.004l2.25 2.5a.75.75 0 001.114 0l2.25-2.5a.75.75 0 00-1.114-1.004L8.75 9.296V6h2A2.25 2.25 0 0113 8.25v4.5A2.25 2.25 0 0110.75 15h-5.5A2.25 2.25 0 013 12.75v-4.5A2.25 2.25 0 015.25 6h2zM7 16.75v-.25h3.75a3.75 3.75 0 003.75-3.75V10h.25A2.25 2.25 0 0117 12.25v4.5A2.25 2.25 0 0114.75 19h-5.5A2.25 2.25 0 017 16.75z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_down_right.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDownRight(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M6.28 5.22a.75.75 0 00-1.06 1.06l7.22 7.22H6.75a.75.75 0 000 1.5h7.5a.747.747 0 00.75-.75v-7.5a.75.75 0 00-1.5 0v5.69L6.28 5.22z"/>`))
+}

v3/mini/arrow_down_tray.go

@@ -0,0 +1,13 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowDownTray(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path d="M10.75 2.75a.75.75 0 00-1.5 0v8.614L6.295 8.235a.75.75 0 10-1.09 1.03l4.25 4.5a.75.75 0 001.09 0l4.25-4.5a.75.75 0 00-1.09-1.03l-2.955 3.129v3.75z"/>
+  <path d="M3.5 12.75a.75.75 0 00-1.5 0v3.5A2.75 2.75 0 004.75 18h10.5A2.75 2.75 0 0018 15.25v-2.5a.75.75 0 00-1.5 0v3.5c0 .69-.56 1.25-1.25 1.25H4.75c-.69 0-1.25-.56-1.25-1.25v-2.5z"/>`))
+}

v3/mini/arrow_left.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowLeft(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M17 10a.75.75 0 01-.75.75H5.612l4.158 3.96a.75.75 0 11-1.04 1.08l-5.5-5.25a.75.75 0 010-1.08l5.5-5.25a.75.75 0 111.04 1.08L5.612 9.25H16.25A.75.75 0 0117 10z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_left_circle.go

@@ -0,0 +1,19 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowLeftCircle(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<g clip-path="url(#clip0_9_2121)">
+    <path fill-rule="evenodd" d="M10 18a8 8 0 100-16 8 8 0 000 16zm3.25-7.25a.75.75 0 000-1.5H8.66l2.1-1.95a.75.75 0 10-1.02-1.1l-3.5 3.25a.75.75 0 000 1.1l3.5 3.25a.75.75 0 001.02-1.1l-2.1-1.95h4.59z" clip-rule="evenodd"/>
+  </g>
+  <defs>
+    <clipPath id="clip0_9_2121">
+      <path d="M0 0h20v30H0z"/>
+    </clipPath>
+  </defs>`))
+}

v3/mini/arrow_left_on_rectangle.go

@@ -0,0 +1,13 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowLeftOnRectangle(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M3 4.25A2.25 2.25 0 015.25 2h5.5A2.25 2.25 0 0113 4.25v3a.75.75 0 01-1.5 0v-2a.75.75 0 00-.75-.75h-5.5a.75.75 0 00-.75.75v11.5c0 .414.336.75.75.75h5.5a.75.75 0 00.75-.75v-2a.75.75 0 011.5 0v3A2.25 2.25 0 0110.75 18h-5.5A2.25 2.25 0 013 15.75V4.25z" clip-rule="evenodd"/>
+  <path fill-rule="evenodd" d="M19 10a.75.75 0 00-.75-.75H8.704l1.048-.943a.75.75 0 10-1.004-1.114l-2.5 2.25a.75.75 0 000 1.114l2.5 2.25a.75.75 0 101.004-1.114l-1.048-.943h9.546A.75.75 0 0019 10z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_long_down.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowLongDown(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M10 2a.75.75 0 01.75.75v12.59l1.95-2.1a.75.75 0 111.1 1.02l-3.25 3.5a.75.75 0 01-1.1 0l-3.25-3.5a.75.75 0 111.1-1.02l1.95 2.1v3.75A.75.75 0 0110 2z" clip-rule="evenodd"/>`))
+}

v3/mini/arrow_long_left.go

@@ -0,0 +1,12 @@
+package mini
+
+import (
+	g "maragu.dev/gomponents"
+
+	h "maragu.dev/gomponents-heroicons/v3"
+)
+
+func ArrowLongLeft(children ...g.Node) g.Node {
+	return h.Mini(g.Group(children),
+		g.Raw(`<path fill-rule="evenodd" d="M18 10a.75.75 0 01-.75.75H4.66l2.1 1.95a.75.75 0 11-1.02 1.1l-3.5-3.25a.75.75 0 010-1.1l3.5-3.25a.75.75 0 111.02 1.1l-2.1 1.95h12.59A.75.75 0 0118 10z" clip-rule="evenodd"/>`))
+}