docs: Icon updates (#334)

* icons: Update documentation for icons. This commit updates the schema documentation for icons to match the icon validation in the community repo. * icons: Update icon usage. This commit updates all examples to use icons that will validate in the community repo.
tidbyt · Jul 25, 2022 · 6ecb268 · 6ecb268
1 parent d8a4733
commit 6ecb268
Show file tree

Hide file tree

Showing 14 changed files with 37 additions and 37 deletions.
diff --git a/docs/schema/datetime/example.star b/docs/schema/datetime/example.star
@@ -21,7 +21,7 @@ def get_schema():
                 id = "event_time",
                 name = "Event Time",
                 desc = "The time of the event.",
-                icon = "cog",
+                icon = "gear",
             ),
         ],
     )
diff --git a/docs/schema/generated/example.star b/docs/schema/generated/example.star
@@ -41,7 +41,7 @@ def more_options(pet):
                 id = "leash",
                 name = "Leash",
                 desc = "A toggle to enable a dog leash.",
-                icon = "cog",
+                icon = "gear",
                 default = False,
             ),
         ]
@@ -51,7 +51,7 @@ def more_options(pet):
                 id = "litter-box",
                 name = "Litter Box",
                 desc = "A toggle to enable a litter box.",
-                icon = "cog",
+                icon = "gear",
                 default = False,
             ),
         ]
@@ -66,7 +66,7 @@ def get_schema():
                 id = "pet",
                 name = "Pet Type",
                 desc = "What type of pet do you have?",
-                icon = "cog",
+                icon = "gear",
             ),
             schema.Generated(
                 id = "generated",

diff --git a/docs/schema/location/example.star b/docs/schema/location/example.star
@@ -33,7 +33,7 @@ def get_schema():
                 id = "location",
                 name = "Location",
                 desc = "Location for which to display time.",
-                icon = "place",
+                icon = "locationDot",
             ),
         ],
     )
diff --git a/docs/schema/photoselect/example.star b/docs/schema/photoselect/example.star
@@ -17,7 +17,7 @@ def get_schema():
                 id = "photo",
                 name = "Add Photo",
                 desc = "A photo to display.",
-                icon = "cog",
+                icon = "gear",
             ),
         ],
     )

diff --git a/docs/schema/schema.md b/docs/schema/schema.md
@@ -64,7 +64,7 @@ The `get_schema` method returns a `schema.Schema` object that contains _fields_.
 Next up should be more familiar. We're now passing `config` into `main()`. This is the same for current pixlet scripts that take `config` today. In [Community Apps](https://github.com/tidbyt/community), we will populate the config hashmap with values configured from the mobile app.
 
 ## Icons
-Each schema field takes an `icon` value. We use the free icons from [Font Awesome](https://fontawesome.com/) with the names camel cased. For example [users-cog](https://fontawesome.com/v5.15/icons/users-cog?style=solid) should be `usersCog` in the `icon` value.
+Each schema field takes an `icon` value. We use the free icons from [Font Awesome](https://fontawesome.com/v6/search?s=solid%2Cbrands) at version 6.1.1 with the names camel cased. For example [users-cog](https://fontawesome.com/v6/icons/users-cog?style=solid&s=solid) should be `usersCog` in the `icon` value. When submitting to the community repo, the icon names are validated against this [icon map](https://github.com/tidbyt/community/blob/main/apps/icons.go).
 
 ## Dynamic Fields
 Pixlet offers two types of fields: basic fields like `Toggle` or `Text` and dynamic fields that take a `handler` method like `LocationBased` or `Typeahead`. For dynamic fields, the `handler` will get called with user inputs. What the handler returns is specific to the field.
@@ -83,7 +83,7 @@ schema.DateTime(
     id = "event_time",
     name = "Event Time",
     desc = "The time of the event.",
-    icon = "cog",
+    icon = "gear",
 )
 ```
 
@@ -149,7 +149,7 @@ def more_options(pet):
                 id = "leash",
                 name = "Leash",
                 desc = "A toggle to enable a dog leash.",
-                icon = "cog",
+                icon = "gear",
                 default = False,
             ),
         ]
@@ -159,7 +159,7 @@ def more_options(pet):
                 id = "litter-box",
                 name = "Litter Box",
                 desc = "A toggle to enable a litter box.",
-                icon = "cog",
+                icon = "gear",
                 default = False,
             ),
         ]
@@ -178,7 +178,7 @@ schema.Location(
     id = "location",
     name = "Location",
     desc = "Location for which to display time.",
-    icon = "place",
+    icon = "locationDot",
 )
 ```
 
@@ -290,7 +290,7 @@ schema.PhotoSelect(
     id = "photo",
     name = "Add Photo",
     desc = "A photo to display.",
-    icon = "cog",
+    icon = "gear",
 )
 ```
 
@@ -311,7 +311,7 @@ schema.Text(
     id = "msg",
     name = "Message",
     desc = "A message to display.",
-    icon = "cog",
+    icon = "gear",
     default = "Hello",
 )
 ```
@@ -327,7 +327,7 @@ schema.Toggle(
     id = "party_mode",
     name = "Party Mode",
     desc = "A toggle to enable party mode.",
-    icon = "cog",
+    icon = "gear",
     default = False,
 )
 ```
@@ -348,7 +348,7 @@ schema.Typeahead(
     id = "search",
     name = "Search",
     desc = "A list of items that match search.",
-    icon = "cog",
+    icon = "gear",
     handler = search,
 )
 ```

diff --git a/docs/schema/text/example.star b/docs/schema/text/example.star
@@ -18,7 +18,7 @@ def get_schema():
                 id = "msg",
                 name = "Message",
                 desc = "A message to display.",
-                icon = "cog",
+                icon = "gear",
                 default = "Hello",
             ),
         ],

diff --git a/docs/schema/toggle/example.star b/docs/schema/toggle/example.star
@@ -23,7 +23,7 @@ def get_schema():
                 id = "party_mode",
                 name = "Party Mode",
                 desc = "A toggle to enable party mode.",
-                icon = "cog",
+                icon = "gear",
                 default = False,
             ),
         ],

diff --git a/docs/schema/typeahead/example.star b/docs/schema/typeahead/example.star
@@ -36,7 +36,7 @@ def get_schema():
                 id = "search",
                 name = "Search",
                 desc = "A list of items that match search.",
-                icon = "cog",
+                icon = "gear",
                 handler = search,
             ),
         ],

diff --git a/examples/sunrise.star b/examples/sunrise.star
@@ -59,7 +59,7 @@ def get_schema():
                 id = "location",
                 name = "Location",
                 desc = "Location for which to display time.",
-                icon = "place",
+                icon = "locationDot",
             ),
         ],
     )
diff --git a/schema/datetime_test.go b/schema/datetime_test.go
@@ -18,13 +18,13 @@ t = schema.DateTime(
 	id = "event_name",
 	name = "Event Name",
 	desc = "The time of the event.",
-	icon = "cog",
+	icon = "gear",
 )
 
 assert(t.id == "event_name")
 assert(t.name == "Event Name")
 assert(t.desc == "The time of the event.")
-assert(t.icon == "cog")
+assert(t.icon == "gear")
 
 def main():
 	return []

diff --git a/schema/location_test.go b/schema/location_test.go
@@ -18,13 +18,13 @@ s = schema.Location(
 	id = "location",
 	name = "Location",
 	desc = "Location for which to display time.",
-	icon = "place",
+	icon = "locationDot",
 )
 
 assert(s.id == "location")
 assert(s.name == "Location")
 assert(s.desc == "Location for which to display time.")
-assert(s.icon == "place")
+assert(s.icon == "locationDot")
 
 def main():
 	return []

diff --git a/schema/photoselect_test.go b/schema/photoselect_test.go
@@ -18,13 +18,13 @@ t = schema.PhotoSelect(
 	id = "photo",
 	name = "Add Photo",
 	desc = "A photo.",
-	icon = "cog",
+	icon = "gear",
 )
 
 assert(t.id == "photo")
 assert(t.name == "Add Photo")
 assert(t.desc == "A photo.")
-assert(t.icon == "cog")
+assert(t.icon == "gear")
 
 def main():
 	return []

diff --git a/schema/schema_test.go b/schema/schema_test.go
@@ -47,13 +47,13 @@ def get_schema():
                 id = "locationid",
                 name = "Location",
                 desc = "A Location",
-                icon = "place",
+                icon = "locationDot",
             ),
             schema.LocationBased(
                 id = "locationbasedid",
                 name = "Locationbased",
                 desc = "A Locationbased",
-                icon = "place",
+                icon = "locationDot",
                 handler = locationbasedhandler,
             ),
             schema.Toggle(
@@ -67,7 +67,7 @@ def get_schema():
                 id = "textid",
                 name = "Text",
                 desc = "A Text",
-                icon = "cog",
+                icon = "gear",
                 default = "Default text",
             ),
             schema.Dropdown(
@@ -136,15 +136,15 @@ def main():
 				ID:          "locationid",
 				Name:        "Location",
 				Description: "A Location",
-				Icon:        "place",
+				Icon:        "locationDot",
 			},
 			{
 				Type:        "locationbased",
 				ID:          "locationbasedid",
 				Name:        "Locationbased",
 				Description: "A Locationbased",
 				Handler:     "locationbasedhandler",
-				Icon:        "place",
+				Icon:        "locationDot",
 			},
 			{
 				Type:        "onoff",
@@ -159,7 +159,7 @@ def main():
 				ID:          "textid",
 				Name:        "Text",
 				Description: "A Text",
-				Icon:        "cog",
+				Icon:        "gear",
 				Default:     "Default text",
 			},
 			{
@@ -251,14 +251,14 @@ def get_schema():
          "name": "Location",
          "description": "A Location",
          "id": "locationid",
-         "icon": "place",
+         "icon": "locationDot",
         },
         {"type": "locationbased",
          "id": "locationbasedid",
          "name": "Locationbased",
          "description": "A Locationbased",
          "handler": "locationbasedhandler",
-         "icon": "place",
+         "icon": "locationDot",
         },
         {"type": "onoff",
           "id": "onoffid",
@@ -373,15 +373,15 @@ def main():
 				ID:          "locationid",
 				Name:        "Location",
 				Description: "A Location",
-				Icon:        "place",
+				Icon:        "locationDot",
 			},
 			{
 				Type:        "locationbased",
 				ID:          "locationbasedid",
 				Name:        "Locationbased",
 				Description: "A Locationbased",
 				Handler:     "locationbasedhandler",
-				Icon:        "place",
+				Icon:        "locationDot",
 			},
 			{
 				Type:        "onoff",

diff --git a/schema/typeahead_test.go b/schema/typeahead_test.go
@@ -30,14 +30,14 @@ t = schema.Typeahead(
     id = "search",
     name = "Search",
     desc = "A list of items that match search.",
-    icon = "cog",
+    icon = "gear",
     handler = search,
 )
 
 assert(t.id == "search")
 assert(t.name == "Search")
 assert(t.desc == "A list of items that match search.")
-assert(t.icon == "cog")
+assert(t.icon == "gear")
 assert(t.handler("")[0].display == "Grand Central")
 
 def main():