document selected field

maxmarcon · Dec 26, 2024 · 792ee34 · 792ee34
1 parent d800757
commit 792ee34
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/live_select.ex b/lib/live_select.ex
@@ -95,6 +95,9 @@ defmodule LiveSelect do
   ## Slots
 
   You can control how your options and tags are rendered by using the `:option` and `:tag` slots.
+  Both slots will be passed an option as argument. In the case of the `:option` slot, the option will have an
+  extra boolean field `:selected`, which will be set to `true` if the option has been selected by the user.
+
   Let's say you want to show some fancy icons next to each option in the dropdown and the tags:
 
   ```elixir