Add documentation for batch 4 components

djalmaaraujo · djalmaaraujo · commit 035255d5b708 · 2025-12-17T11:47:44.000-03:00
diff --git a/lib/ruby_ui/popover/popover_docs.rb b/lib/ruby_ui/popover/popover_docs.rb
diff --git a/lib/ruby_ui/progress/progress_docs.rb b/lib/ruby_ui/progress/progress_docs.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Views::Docs::Progress < Views::Base
+  def view_template
+    component = "Progress"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Progress", description: "Displays an indicator showing the completion progress of a task, typically displayed as a progress bar.")
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          Progress(value: 50, class: "w-[60%]")
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "With custom indicator color", context: self) do
+        <<~RUBY
+          Progress(value: 35, class: "w-[60%] [&>*]:bg-success")
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end
diff --git a/lib/ruby_ui/radio_button/radio_button_docs.rb b/lib/ruby_ui/radio_button/radio_button_docs.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class Views::Docs::RadioButton < Views::Base
+  def view_template
+    component = "RadioButton"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Radio Button", description: "A control that allows users to make a single selection from a list of options.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          div(class: "flex items-center space-x-2") do
+            RadioButton(id: "default")
+            FormFieldLabel(for: "default") { "Default" }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Checked", context: self) do
+        <<~RUBY
+          div(class: "flex items-center space-x-2") do
+            RadioButton(id: "checked", checked: true)
+            FormFieldLabel(for: "checked") { "Checked" }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Disabled", context: self) do
+        <<~RUBY
+          div(class: "flex flex-row items-center gap-2") do
+            RadioButton(class: "peer",id: "disabled", disabled: true)
+            FormFieldLabel(for: "disabled") { "Disabled" }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Aria Disabled", context: self) do
+        <<~RUBY
+          div(class: "flex flex-row items-center gap-2") do
+            RadioButton(class: "peer", id: "aria-disabled", aria: {disabled: "true"})
+            FormFieldLabel(for: "aria-disabled") { "Aria Disabled" }
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end
diff --git a/lib/ruby_ui/select/select_docs.rb b/lib/ruby_ui/select/select_docs.rb
@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+class Views::Docs::Select < Views::Base
+  def view_template
+    component = "Select"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Select", description: "Displays a list of options for the user to pick from—triggered by a button.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Select (Deconstructed)", context: self) do
+        <<~RUBY
+          Select(class: "w-56") do
+            SelectInput(value: "apple", id: "select-a-fruit")
+
+            SelectTrigger do
+              SelectValue(placeholder: "Select a fruit", id: "select-a-fruit") { "Apple" }
+            end
+
+            SelectContent(outlet_id: "select-a-fruit") do
+              SelectGroup do
+                SelectLabel { "Fruits" }
+                SelectItem(value: "apple") { "Apple" }
+                SelectItem(value: "orange") { "Orange" }
+                SelectItem(value: "banana") { "Banana" }
+                SelectItem(value: "watermelon") { "Watermelon" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Pre-selected Item", context: self) do
+        <<~RUBY
+          Select(class: "w-56") do
+            SelectInput(value: "banana", id: "select-preselected-fruit")
+
+            SelectTrigger do
+              SelectValue(placeholder: "Select a fruit", id: "select-preselected-fruit") { "Banana" }
+            end
+
+            SelectContent(outlet_id: "select-preselected-fruit") do
+              SelectGroup do
+                SelectLabel { "Fruits" }
+                SelectItem(value: "apple") { "Apple" }
+                SelectItem(value: "orange") { "Orange" }
+                SelectItem(value: "banana") { "Banana" }
+                SelectItem(value: "watermelon") { "Watermelon" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Disabled", context: self) do
+        <<~RUBY
+          Select(class: "w-56") do
+            SelectInput(value: "apple", id: "select-a-fruit")
+
+            SelectTrigger(disabled: true) do
+              SelectValue(placeholder: "Select a fruit", id: "select-a-fruit") { "Apple" }
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Data Disabled", context: self) do
+        <<~RUBY
+          Select(class: "w-56") do
+            SelectInput(value: "apple", id: "select-a-fruit")
+
+            SelectTrigger do
+              SelectValue(placeholder: "Select a fruit", id: "select-a-fruit") { "Apple" }
+            end
+
+            SelectContent(outlet_id: "select-a-fruit") do
+              SelectGroup do
+                SelectLabel { "Fruits" }
+                SelectItem(data: {disabled: true}, value: "apple") { "Apple" }
+                SelectItem(value: "orange") { "Orange" }
+                SelectItem(value: "banana") { "Banana" }
+                SelectItem(data: {disabled: true}, value: "watermelon") { "Watermelon" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Aria Disabled Trigger", context: self) do
+        <<~RUBY
+          Select(class: "w-56") do
+            SelectInput(value: "apple", id: "select-a-fruit")
+
+            SelectTrigger(aria: {disabled: "true"}) do
+              SelectValue(placeholder: "Select a fruit", id: "select-a-fruit") { "Apple" }
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Aria Disabled Item", context: self) do
+        <<~RUBY
+          Select(class: "w-56") do
+            SelectInput(value: "apple", id: "select-a-fruit")
+
+            SelectTrigger do
+              SelectValue(placeholder: "Select a fruit", id: "select-a-fruit") { "Apple" }
+            end
+
+            SelectContent(outlet_id: "select-a-fruit") do
+              SelectGroup do
+                SelectLabel { "Fruits" }
+                SelectItem(aria: {disabled: "true"}, value: "apple") { "Apple" }
+                SelectItem(value: "orange") { "Orange" }
+                SelectItem(value: "banana") { "Banana" }
+                SelectItem(aria: {disabled: "true"}, value: "watermelon") { "Watermelon" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end
diff --git a/lib/ruby_ui/separator/separator_docs.rb b/lib/ruby_ui/separator/separator_docs.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Views::Docs::Separator < Views::Base
+  def view_template
+    component = "Separator"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Separator", description: "Visually or semantically separates content.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          div do
+            div(class: "space-y-1") do
+              h4(class: "text-sm font-medium leading-none") { "RubyUI" }
+              p(class: "text-sm text-muted-foreground") { "An open-source UI component library." }
+            end
+            Separator(class: "my-4")
+            div(class: "flex h-5 items-center space-x-4 text-sm") do
+              div { "Blog" }
+              Separator(as: :hr, orientation: :vertical)
+              div { "Docs" }
+              Separator(orientation: :vertical)
+              div { "Source" }
+            end
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end
diff --git a/lib/ruby_ui/sheet/sheet_docs.rb b/lib/ruby_ui/sheet/sheet_docs.rb
@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+class Views::Docs::Sheet < Views::Base
+  def view_template
+    component = "Sheet"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Sheet", description: "Extends the Sheet component to display content that complements the main content of the screen.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          Sheet do
+            SheetTrigger do
+              Button(variant: :outline) { "Open Sheet" }
+            end
+            SheetContent(class: 'sm:max-w-sm') do
+              SheetHeader do
+                SheetTitle { "Edit profile" }
+                SheetDescription { "Make changes to your profile here. Click save when you're done." }
+              end
+
+              SheetMiddle do
+                label { "Name" }
+                Input(placeholder: "Joel Drapper") { "Joel Drapper" }
+                label { "Email" }
+                Input(placeholder: "joel@drapper.me")
+              end
+              SheetFooter do
+                Button(variant: :outline, data: { action: 'click->ruby-ui--sheet-content#close' }) { "Cancel" }
+                Button(type: "submit") { "Save" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Side", description: "Use the side property to indicate the edge of the screen where the component will appear.", context: self) do
+        <<~RUBY
+          div(class: 'grid grid-cols-2 gap-4') do
+            # -- TOP --
+            Sheet do
+              SheetTrigger do
+                Button(variant: :outline, class: 'w-full justify-center') { :top }
+              end
+              SheetContent(side: :top, class: ("sm:max-w-sm" if [:left, :right].include?(:top))) do
+                SheetHeader do
+                  SheetTitle { "Edit profile" }
+                  SheetDescription { "Make changes to your profile here. Click save when you're done." }
+                end
+                Form do
+                  SheetMiddle do
+                    label { "Name" }
+                    Input(placeholder: "Joel Drapper") { "Joel Drapper" }
+
+                    label { "Email" }
+                    Input(placeholder: "joel@drapper.me")
+                  end
+                  SheetFooter do
+                    Button(variant: :outline, data: { action: 'click->ruby-ui--sheet-content#close' }) { "Cancel" }
+                    Button(type: "submit") { "Save" }
+                  end
+                end
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end
diff --git a/lib/ruby_ui/shortcut_key/shortcut_key_docs.rb b/lib/ruby_ui/shortcut_key/shortcut_key_docs.rb
@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Views::Docs::ShortcutKey < Views::Base
+  def view_template
+    component = "ShortcutKey"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Shortcut Key", description: "A component for displaying keyboard shortcuts.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          div(class: "flex flex-col items-center gap-y-4") do
+            ShortcutKey do
+              span(class: "text-xs") { "⌘" }
+              plain "K"
+            end
+            p(class: "text-muted-foreground text-sm text-center") { "Note this does not trigger anything, it is purely a visual prompt" }
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end
diff --git a/lib/ruby_ui/sidebar/sidebar_docs.rb b/lib/ruby_ui/sidebar/sidebar_docs.rb
