ruby_ui 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0caf3d89b3375e334dc257510c34bf7f168b295534dc8bf2bfc4dde95d3a6a04
-  data.tar.gz: 55dcc86d6feb87270a5c82915fa635e752b1a7ae1a91d5b30e12af61f91fc13f
+  metadata.gz: ae8ccd52ccc249a9a1a409facc1883da7f87170bc5f70a0df32755e2fc5e5577
+  data.tar.gz: df99edbcb78e881e98a114c58b1e0e771180d40acc0677ab182c50e29487d33d
 SHA512:
-  metadata.gz: abcfe605c2dc17b11f2c3cc8dbe5e2db054c95f5e0dac319c883762add2985fb0b7ddd8547c8148504e75ef83971ee7c55c874bffa3505deefe50eb7e8e09f6a
-  data.tar.gz: fbe88cc5c6c8e327209588628340d1225773dcd0a6ce064a657ccaa9eaa163c98d4d2280e966932bdf2c9e7da910ab0a6913cb65093cb4091c026690f88039ac
+  metadata.gz: 9509f7c13c94b9f1b4767cc194e7eaeecda6ffd8eeb872c97693e7cf9ac875dbefa1457edc882df7e2ac093facf77ff856f1af3191549a7f37be8d901cb00ec6
+  data.tar.gz: 44f479fb9b95d79318e358dc4b2864a5b13cc51d1ddd958a199cd6c184ed190de8d93a07e07d416ca2d5c89e23094f1b158c187048b3030d17eadca9b23eb065

data/LICENSE.txt

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

data/README.md

@@ -87,4 +87,8 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
 
 ---
 
+## Sponsors
+[![DigitalOcean Referral Badge](https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg)](https://www.digitalocean.com/?refcode=0fdaefc76c39&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)
+
+
 © 2024 RubyUI. All rights reserved. 🔒

data/lib/generators/ruby_ui/install/docs_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module RubyUI
+  module Generators
+    module Install
+      class DocsGenerator < Rails::Generators::Base
+        namespace "ruby_ui:install:docs"
+        source_root File.expand_path("../../../ruby_ui", __dir__)
+        class_option :force, type: :boolean, default: false
+
+        def copy_docs_files
+          say "Installing RubyUI documentation files..."
+
+          docs_file_paths.each do |source_path|
+            dest_filename = File.basename(source_path).sub("_docs", "")
+            copy_file source_path, Rails.root.join("app/views/docs", dest_filename), force: options["force"]
+          end
+
+          say ""
+          say "Documentation installed to app/views/docs/", :green
+        end
+
+        private
+
+        def docs_file_paths
+          Dir.glob(File.join(self.class.source_root, "*", "*_docs.rb"))
+        end
+      end
+    end
+  end
+end

data/lib/ruby_ui/accordion/accordion_docs.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class Views::Docs::Accordion < Views::Base
+  def view_template
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      component = "Accordion"
+      render Docs::Header.new(title: component,
+        description: "A vertically stacked set of interactive headings that each reveal a section of content.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        @@code = <<~RUBY
+          div(class: "w-full") do
+            Accordion do
+              AccordionItem do
+                AccordionTrigger do
+                  p(class: "font-medium") { "What is PhlexUI?" }
+                  AccordionIcon()
+                end
+
+                AccordionContent do
+                  p(class: "text-sm pb-4") do
+                    "PhlexUI is a UI component library for Ruby devs who want to build better, faster."
+                  end
+                end
+              end
+            end
+
+            Accordion do
+              AccordionItem do
+                AccordionTrigger do
+                  p(class: "font-medium") { "Can I use it with Rails?" }
+                  AccordionIcon()
+                end
+
+                AccordionContent do
+                  p(class: "text-sm pb-4") do
+                    "Yes, PhlexUI is pure Ruby and works great with Rails. It's a Ruby gem that you can install into your Rails app."
+                  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

data/lib/ruby_ui/alert/alert_docs.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+class Views::Docs::Alert < Views::Base
+  def view_template
+    component = "Alert"
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Alert", description: "Displays a callout for user attention.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          Alert do
+            rocket_icon
+            AlertTitle { "Pro tip" }
+            AlertDescription { "With RubyUI you'll ship faster." }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Without Icon", context: self) do
+        <<~RUBY
+          Alert do
+            AlertTitle { "Pro tip" }
+            AlertDescription { "Simply, don't include an icon and your alert will look like this." }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Warning", context: self) do
+        <<~RUBY
+          Alert(variant: :warning) do
+            info_icon
+            AlertTitle { "Ship often" }
+            AlertDescription { "Shipping is good, your users will thank you for it." }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Destructive", context: self) do
+        <<~RUBY
+          Alert(variant: :destructive) do
+            alert_icon
+            AlertTitle { "Oopsie daisy!" }
+            AlertDescription { "Your design system is non-existent." }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Success", context: self) do
+        <<~RUBY
+          Alert(variant: :success) do
+            check_icon
+            AlertTitle { "Installation successful" }
+            AlertDescription { "You're all set to start using RubyUI in your application." }
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+
+  private
+
+  def rocket_icon
+    svg(
+      xmlns: "http://www.w3.org/2000/svg",
+      viewbox: "0 0 24 24",
+      fill: "currentColor",
+      class: "w-5 h-5"
+    ) do |s|
+      s.path(
+        fill_rule: "evenodd",
+        d:
+          "M9.315 7.584C12.195 3.883 16.695 1.5 21.75 1.5a.75.75 0 01.75.75c0 5.056-2.383 9.555-6.084 12.436A6.75 6.75 0 019.75 22.5a.75.75 0 01-.75-.75v-4.131A15.838 15.838 0 016.382 15H2.25a.75.75 0 01-.75-.75 6.75 6.75 0 017.815-6.666zM15 6.75a2.25 2.25 0 100 4.5 2.25 2.25 0 000-4.5z",
+        clip_rule: "evenodd"
+      )
+      s.path(
+        d:
+          "M5.26 17.242a.75.75 0 10-.897-1.203 5.243 5.243 0 00-2.05 5.022.75.75 0 00.625.627 5.243 5.243 0 005.022-2.051.75.75 0 10-1.202-.897 3.744 3.744 0 01-3.008 1.51c0-1.23.592-2.323 1.51-3.008z"
+      )
+    end
+  end
+
+  def alert_icon
+    svg(
+      xmlns: "http://www.w3.org/2000/svg",
+      viewbox: "0 0 24 24",
+      fill: "currentColor",
+      class: "w-5 h-5"
+    ) do |s|
+      s.path(
+        fill_rule: "evenodd",
+        d:
+          "M9.401 3.003c1.155-2 4.043-2 5.197 0l7.355 12.748c1.154 2-.29 4.5-2.599 4.5H4.645c-2.309 0-3.752-2.5-2.598-4.5L9.4 3.003zM12 8.25a.75.75 0 01.75.75v3.75a.75.75 0 01-1.5 0V9a.75.75 0 01.75-.75zm0 8.25a.75.75 0 100-1.5.75.75 0 000 1.5z",
+        clip_rule: "evenodd"
+      )
+    end
+  end
+
+  def info_icon
+    svg(
+      xmlns: "http://www.w3.org/2000/svg",
+      viewbox: "0 0 24 24",
+      fill: "currentColor",
+      class: "w-5 h-5"
+    ) do |s|
+      s.path(
+        fill_rule: "evenodd",
+        d:
+          "M2.25 12c0-5.385 4.365-9.75 9.75-9.75s9.75 4.365 9.75 9.75-4.365 9.75-9.75 9.75S2.25 17.385 2.25 12zm8.706-1.442c1.146-.573 2.437.463 2.126 1.706l-.709 2.836.042-.02a.75.75 0 01.67 1.34l-.04.022c-1.147.573-2.438-.463-2.127-1.706l.71-2.836-.042.02a.75.75 0 11-.671-1.34l.041-.022zM12 9a.75.75 0 100-1.5.75.75 0 000 1.5z",
+        clip_rule: "evenodd"
+      )
+    end
+  end
+
+  def check_icon
+    svg(
+      xmlns: "http://www.w3.org/2000/svg",
+      viewbox: "0 0 24 24",
+      fill: "currentColor",
+      class: "w-5 h-5"
+    ) do |s|
+      s.path(
+        fill_rule: "evenodd",
+        d:
+          "M2.25 12c0-5.385 4.365-9.75 9.75-9.75s9.75 4.365 9.75 9.75-4.365 9.75-9.75 9.75S2.25 17.385 2.25 12zm13.36-1.814a.75.75 0 10-1.22-.872l-3.236 4.53L9.53 12.22a.75.75 0 00-1.06 1.06l2.25 2.25a.75.75 0 001.14-.094l3.75-5.25z",
+        clip_rule: "evenodd"
+      )
+    end
+  end
+end

data/lib/ruby_ui/alert_dialog/alert_dialog_docs.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class Views::Docs::AlertDialog < Views::Base
+  def view_template
+    component = "AlertDialog"
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Alert Dialog", description: "A modal dialog that interrupts the user with important content and expects a response.")
+
+      Heading(level: 2) { "Usage" }
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          AlertDialog do
+            AlertDialogTrigger do
+              Button { "Show dialog" }
+            end
+            AlertDialogContent do
+              AlertDialogHeader do
+                AlertDialogTitle { "Are you absolutely sure?" }
+                AlertDialogDescription { "This action cannot be undone. This will permanently delete your account and remove your data from our servers." }
+              end
+              AlertDialogFooter do
+                AlertDialogCancel { "Cancel" }
+                AlertDialogAction { "Continue" } # Will probably be a link to a controller action (e.g. delete account)
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end

data/lib/ruby_ui/aspect_ratio/aspect_ratio_docs.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+class Views::Docs::AspectRatio < Views::Base
+  def view_template
+    component = "AspectRatio"
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Aspect Ratio", description: "Displays content within a desired ratio.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "16/9", context: self) do
+        <<~RUBY
+          AspectRatio(aspect_ratio: "16/9", class: "rounded-md overflow-hidden border shadow-sm") do
+            img(
+              alt: "Placeholder",
+              loading: "lazy",
+              src: image_path('pattern.jpg')
+            )
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "4/3", context: self) do
+        <<~RUBY
+          AspectRatio(aspect_ratio: "4/3", class: "rounded-md overflow-hidden border shadow-sm") do
+            img(
+              alt: "Placeholder",
+              loading: "lazy",
+              src: image_path('pattern.jpg')
+            )
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "1/1", context: self) do
+        <<~RUBY
+          AspectRatio(aspect_ratio: "1/1", class: "rounded-md overflow-hidden border shadow-sm") do
+            img(
+              alt: "Placeholder",
+              loading: "lazy",
+              src: image_path('pattern.jpg')
+            )
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "21/9", context: self) do
+        <<~RUBY
+          AspectRatio(aspect_ratio: "21/9", class: "rounded-md overflow-hidden border shadow-sm") do
+            img(
+              alt: "Placeholder",
+              loading: "lazy",
+              src: image_path('pattern.jpg')
+            )
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end

data/lib/ruby_ui/avatar/avatar_docs.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+class Views::Docs::Avatar < Views::Base
+  def view_template
+    component = "Avatar"
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Avatar", description: "An image element with a fallback for representing the user.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Image & fallback", context: self) do
+        <<~RUBY
+          Avatar do
+            AvatarImage(src: "https://avatars.githubusercontent.com/u/246692?v=4", alt: "joeldrapper")
+            AvatarFallback { "JD" }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Only fallback", context: self) do
+        <<~RUBY
+          Avatar do
+            AvatarFallback { "JD" }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Sizes", context: self) do
+        <<~RUBY
+          div(class: 'flex items-center space-x-2') do
+            # size: :xs
+            Avatar(size: :xs) do
+              AvatarImage(src: "https://avatars.githubusercontent.com/u/246692?v=4", alt: "joeldrapper")
+              AvatarFallback { "JD" }
+            end
+            # size: :sm
+            Avatar(size: :sm) do
+              AvatarImage(src: "https://avatars.githubusercontent.com/u/246692?v=4", alt: "joeldrapper")
+              AvatarFallback { "JD" }
+            end
+            # size: :md
+            Avatar(size: :md) do
+              AvatarImage(src: "https://avatars.githubusercontent.com/u/246692?v=4", alt: "joeldrapper")
+              AvatarFallback { "JD" }
+            end
+            # size: :lg
+            Avatar(size: :lg) do
+              AvatarImage(src: "https://avatars.githubusercontent.com/u/246692?v=4", alt: "joeldrapper")
+              AvatarFallback { "JD" }
+            end
+            # size: :xl
+            Avatar(size: :xl) do
+              AvatarImage(src: "https://avatars.githubusercontent.com/u/246692?v=4", alt: "joeldrapper")
+              AvatarFallback { "JD" }
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Sizes (only fallback)", context: self) do
+        @@code = <<~RUBY
+          div(class: 'flex items-center space-x-2') do
+            # size: :xs
+            Avatar(size: :xs) do
+              AvatarFallback { "JD" }
+            end
+            # size: :sm
+            Avatar(size: :sm) do
+              AvatarFallback { "JD" }
+            end
+            # size: :md
+            Avatar(size: :md) do
+              AvatarFallback { "JD" }
+            end
+            # size: :lg
+            Avatar(size: :lg) do
+              AvatarFallback { "JD" }
+            end
+            # size: :xl
+            Avatar(size: :xl) do
+              AvatarFallback { "JD" }
+            end
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end

data/lib/ruby_ui/badge/badge_docs.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class Views::Docs::Badge < Views::Base
+  def view_template
+    component = "Badge"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Badge", description: "Displays a badge or a component that looks like a badge.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Default", context: self) do
+        <<~RUBY
+          Badge { "Badge" }
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Primary", context: self) do
+        <<~RUBY
+          Badge(variant: :primary) { 'Primary' }
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Outline", context: self) do
+        <<~RUBY
+          Badge(variant: :outline) { 'Outline' }
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Variants", context: self) do
+        <<~RUBY
+          div(class: 'flex flex-wrap gap-2 justify-center') do
+            Badge(variant: :destructive) { 'Destructive' }
+            Badge(variant: :warning) { 'Warning' }
+            Badge(variant: :success) { 'Success' }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Other Colors", context: self) do
+        <<~RUBY
+          div(class: 'flex flex-wrap gap-2 justify-center') do
+            Badge(variant: :red) { 'Red' }
+            Badge(variant: :orange) { 'Orange' }
+            Badge(variant: :amber) { 'Amber' }
+            Badge(variant: :yellow) { 'Yellow' }
+            Badge(variant: :lime) { 'Lime' }
+            Badge(variant: :green) { 'Green' }
+            Badge(variant: :emerald) { 'Emerald' }
+            Badge(variant: :teal) { 'Teal' }
+            Badge(variant: :cyan) { 'Cyan' }
+            Badge(variant: :sky) { 'Sky' }
+            Badge(variant: :blue) { 'Blue' }
+            Badge(variant: :indigo) { 'Indigo' }
+            Badge(variant: :violet) { 'Violet' }
+            Badge(variant: :purple) { 'Purple' }
+            Badge(variant: :fuchsia) { 'Fuchsia' }
+            Badge(variant: :pink) { 'Pink' }
+            Badge(variant: :rose) { 'Rose' }
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Sizes", context: self) do
+        <<~RUBY
+          div(class: 'flex flex-wrap gap-2 justify-center items-center') do
+            Badge(size: :sm) { "Small" }
+            Badge(size: :md) { "Medium" }
+            Badge(size: :lg) { "Large" }
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      # components
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+end

data/lib/ruby_ui/breadcrumb/breadcrumb_docs.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+class Views::Docs::Breadcrumb < Views::Base
+  def view_template
+    component = "Breadcrumb"
+
+    div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
+      render Docs::Header.new(title: "Breadcrumb", description: "Indicates the user's current location within a navigational hierarchy.")
+
+      Heading(level: 2) { "Usage" }
+
+      render Docs::VisualCodeExample.new(title: "Example", context: self) do
+        <<~RUBY
+          Breadcrumb do
+            BreadcrumbList do
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/") { "Home" }
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/docs/accordion") { "Components" }
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                BreadcrumbPage { "Breadcrumb" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "With custom separator", context: self) do
+        <<~RUBY
+          Breadcrumb do
+            BreadcrumbList do
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/") { "Home" }
+              end
+              BreadcrumbSeparator { slash_icon }
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/docs/accordion") { "Components" }
+              end
+              BreadcrumbSeparator { slash_icon }
+              BreadcrumbItem do
+                BreadcrumbPage { "Breadcrumb" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "Collapsed", context: self) do
+        <<~RUBY
+          Breadcrumb do
+            BreadcrumbList do
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/") { "Home" }
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                BreadcrumbEllipsis()
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/docs/accordion") { "Components" }
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                BreadcrumbPage { "Breadcrumb" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Docs::VisualCodeExample.new(title: "With Link component", context: self) do
+        <<~RUBY
+          Breadcrumb do
+            BreadcrumbList do
+              BreadcrumbItem do
+                BreadcrumbLink(href: "/") { "Home" }
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                Link(href: "/docs/accordion", class: "px-0") { "Components" }
+              end
+              BreadcrumbSeparator()
+              BreadcrumbItem do
+                BreadcrumbPage { "Breadcrumb" }
+              end
+            end
+          end
+        RUBY
+      end
+
+      render Components::ComponentSetup::Tabs.new(component_name: component)
+
+      render Docs::ComponentsTable.new(component_files(component))
+    end
+  end
+
+  private
+
+  def slash_icon
+    svg(
+      xmlns: "http://www.w3.org/2000/svg",
+      class: "w-4 h-4",
+      viewbox: "0 0 24 24",
+      fill: "none",
+      stroke: "currentColor",
+      stroke_width: "2",
+      stroke_linecap: "round",
+      stroke_linejoin: "round"
+    ) { |s| s.path(d: "M22 2 2 22") }
+  end
+end