Document supported table types (#462)

livebook-dev · Jul 30, 2024 · 067dcf8 · 067dcf8
1 parent 44cebd0
commit 067dcf8
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/lib/kino/table.ex b/lib/kino/table.ex
@@ -22,10 +22,23 @@ defmodule Kino.Table do
   @type column :: %{
           :key => term(),
           :label => String.t(),
-          optional(:type) => String.t(),
+          optional(:type) => type(),
           optional(:summary) => %{String.t() => String.t()}
         }
 
+  @typedoc """
+  The following types have meaning on the front-end:
+
+    * "date"
+    * "list"
+    * "number"
+    * "struct"
+    * "text"
+    * "uri"
+
+  """
+  @type type :: String.t()
+
   @type state :: term()
 
   @doc """