Skip to content

Commit 9e6ce14

Browse files
committed
Add documentation for batch 5 components (#340)
Add documentation files for skeleton, switch, table, tabs, textarea, theme_toggle, tooltip, and typography components. Also adds missing stub methods for typography docs (Components.Heading, Components.TypographyList, InlineCode, docs_installation_path).
1 parent 992b5e3 commit 9e6ce14

File tree

9 files changed

+692
-0
lines changed

9 files changed

+692
-0
lines changed

lib/ruby_ui/docs/base.rb

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,25 @@ def docs_avatar_path
6666
def docs_badge_path
6767
"#"
6868
end
69+
70+
def docs_installation_path
71+
"#"
72+
end
73+
74+
# InlineCode helper for typography examples
75+
def InlineCode(&)
76+
code(&)
77+
end
78+
end
79+
end
80+
81+
# Module-level components stub
82+
module Components
83+
def self.Heading(level:, &block)
84+
# Stub for module-level Heading calls
85+
end
86+
87+
def self.TypographyList(items:, numbered: false)
88+
# Stub for TypographyList component
6989
end
7090
end
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# frozen_string_literal: true
2+
3+
class Views::Docs::Skeleton < Views::Base
4+
def view_template
5+
component = "Skeleton"
6+
7+
div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
8+
render Docs::Header.new(title: "Skeleton", description: "Use to show a placeholder while content is loading.")
9+
10+
Heading(level: 2) { "Usage" }
11+
12+
render Docs::VisualCodeExample.new(title: "Example", context: self) do
13+
<<~RUBY
14+
div(class: "flex items-center space-x-4") do
15+
Skeleton(class: "h-12 w-12 rounded-full")
16+
div(class: "space-y-2") do
17+
Skeleton(class: "h-4 w-[250px]")
18+
Skeleton(class: "h-4 w-[200px]")
19+
end
20+
end
21+
RUBY
22+
end
23+
24+
render Components::ComponentSetup::Tabs.new(component_name: component)
25+
26+
render Docs::ComponentsTable.new(component_files(component))
27+
end
28+
end
29+
end

lib/ruby_ui/switch/switch_docs.rb

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# frozen_string_literal: true
2+
3+
class Views::Docs::Switch < Views::Base
4+
def view_template
5+
component = "Switch"
6+
7+
div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
8+
render Docs::Header.new(title: "Switch", description: "A control that allows the user to toggle between checked and not checked.")
9+
10+
Heading(level: 2) { "Usage" }
11+
12+
render Docs::VisualCodeExample.new(title: "Default", context: self) do
13+
<<~RUBY
14+
Switch(name: "switch")
15+
RUBY
16+
end
17+
18+
render Docs::VisualCodeExample.new(title: "Checked", context: self) do
19+
<<~RUBY
20+
Switch(name: "switch", checked: true)
21+
RUBY
22+
end
23+
24+
render Docs::VisualCodeExample.new(title: "Disabled", context: self) do
25+
<<~RUBY
26+
Switch(name: "switch", disabled: true)
27+
RUBY
28+
end
29+
30+
render Docs::VisualCodeExample.new(title: "Aria Disabled", context: self) do
31+
<<~RUBY
32+
Switch(name: "switch", aria: {disabled: "true"})
33+
RUBY
34+
end
35+
36+
render Docs::VisualCodeExample.new(title: "With flag include_hidden false", context: self) do
37+
<<~RUBY
38+
# Supports the creation of a hidden input to be used in forms inspired by the Ruby on Rails implementation of check_box. Default is true.
39+
Switch(name: "switch", include_hidden: false)
40+
RUBY
41+
end
42+
43+
render Docs::ComponentsTable.new(component_files(component))
44+
end
45+
end
46+
end

lib/ruby_ui/table/table_docs.rb

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# frozen_string_literal: true
2+
3+
class Views::Docs::Table < Views::Base
4+
Invoice = Struct.new(:identifier, :status, :method, :amount, keyword_init: true)
5+
User = Struct.new(:avatar_url, :name, :username, :commits, :github_url, keyword_init: true)
6+
7+
def view_template
8+
component = "Table"
9+
10+
div(class: "max-w-2xl mx-auto w-full py-10 space-y-8") do
11+
render Docs::Header.new(title: "Table", description: "A responsive table component.")
12+
13+
Heading(level: 2) { "Usage" }
14+
15+
render Docs::VisualCodeExample.new(title: "Without builder", context: self) do
16+
<<~RUBY
17+
Table do
18+
TableCaption { "Employees at Acme inc." }
19+
TableHeader do
20+
TableRow do
21+
TableHead { "Name" }
22+
TableHead { "Email" }
23+
TableHead { "Status" }
24+
TableHead(class: "text-right") { "Role" }
25+
end
26+
end
27+
TableBody do
28+
invoices.each do |invoice|
29+
TableRow do
30+
TableCell(class: 'font-medium') { invoice.identifier }
31+
TableCell { render_status_badge(invoice.status) }
32+
TableCell { invoice.method }
33+
TableCell(class: "text-right") { format_amount(invoice.amount) }
34+
end
35+
end
36+
end
37+
TableFooter do
38+
TableRow do
39+
TableHead(class: "font-medium", colspan: 3) { "Total" }
40+
TableHead(class: "font-medium text-right") { format_amount(invoices.sum(&:amount)) }
41+
end
42+
end
43+
end
44+
RUBY
45+
end
46+
47+
render Components::ComponentSetup::Tabs.new(component_name: component)
48+
49+
render Docs::ComponentsTable.new(component_files(component))
50+
end
51+
end
52+
53+
private
54+
55+
def invoices
56+
[
57+
Invoice.new(identifier: "INV-0001", status: "Active", method: "Credit Card", amount: 100),
58+
Invoice.new(identifier: "INV-0002", status: "Active", method: "Bank Transfer", amount: 230),
59+
Invoice.new(identifier: "INV-0003", status: "Pending", method: "PayPal", amount: 350),
60+
Invoice.new(identifier: "INV-0004", status: "Inactive", method: "Credit Card", amount: 100)
61+
]
62+
end
63+
64+
def users
65+
[
66+
User.new(avatar_url: "https://avatars.githubusercontent.com/u/246692?v=4", name: "Joel Drapper", username: "joeldrapper", commits: 404),
67+
User.new(avatar_url: "https://avatars.githubusercontent.com/u/33979976?v=4", name: "Alexandre Ruban", username: "alexandreruban", commits: 16),
68+
User.new(avatar_url: "https://avatars.githubusercontent.com/u/77887?v=4", name: "Will Cosgrove", username: "willcosgrove", commits: 12),
69+
User.new(avatar_url: "https://avatars.githubusercontent.com/u/3025661?v=4", name: "Stephann V.", username: "stephannv", commits: 8),
70+
User.new(avatar_url: "https://avatars.githubusercontent.com/u/6411752?v=4", name: "Marco Roth", username: "marcoroth", commits: 8)
71+
]
72+
end
73+
74+
def github_link(user)
75+
"https://github.com/#{user.username}"
76+
end
77+
78+
def github_icon
79+
svg(viewbox: "0 0 438.549 438.549", class: "h-4 w-4") do |s|
80+
s.path(
81+
fill: "currentColor",
82+
d:
83+
"M409.132 114.573c-19.608-33.596-46.205-60.194-79.798-79.8-33.598-19.607-70.277-29.408-110.063-29.408-39.781 0-76.472 9.804-110.063 29.408-33.596 19.605-60.192 46.204-79.8 79.8C9.803 148.168 0 184.854 0 224.63c0 47.78 13.94 90.745 41.827 128.906 27.884 38.164 63.906 64.572 108.063 79.227 5.14.954 8.945.283 11.419-1.996 2.475-2.282 3.711-5.14 3.711-8.562 0-.571-.049-5.708-.144-15.417a2549.81 2549.81 0 01-.144-25.406l-6.567 1.136c-4.187.767-9.469 1.092-15.846 1-6.374-.089-12.991-.757-19.842-1.999-6.854-1.231-13.229-4.086-19.13-8.559-5.898-4.473-10.085-10.328-12.56-17.556l-2.855-6.57c-1.903-4.374-4.899-9.233-8.992-14.559-4.093-5.331-8.232-8.945-12.419-10.848l-1.999-1.431c-1.332-.951-2.568-2.098-3.711-3.429-1.142-1.331-1.997-2.663-2.568-3.997-.572-1.335-.098-2.43 1.427-3.289 1.525-.859 4.281-1.276 8.28-1.276l5.708.853c3.807.763 8.516 3.042 14.133 6.851 5.614 3.806 10.229 8.754 13.846 14.842 4.38 7.806 9.657 13.754 15.846 17.847 6.184 4.093 12.419 6.136 18.699 6.136 6.28 0 11.704-.476 16.274-1.423 4.565-.952 8.848-2.383 12.847-4.285 1.713-12.758 6.377-22.559 13.988-29.41-10.848-1.14-20.601-2.857-29.264-5.14-8.658-2.286-17.605-5.996-26.835-11.14-9.235-5.137-16.896-11.516-22.985-19.126-6.09-7.614-11.088-17.61-14.987-29.979-3.901-12.374-5.852-26.648-5.852-42.826 0-23.035 7.52-42.637 22.557-58.817-7.044-17.318-6.379-36.732 1.997-58.24 5.52-1.715 13.706-.428 24.554 3.853 10.85 4.283 18.794 7.952 23.84 10.994 5.046 3.041 9.089 5.618 12.135 7.708 17.705-4.947 35.976-7.421 54.818-7.421s37.117 2.474 54.823 7.421l10.849-6.849c7.419-4.57 16.18-8.758 26.262-12.565 10.088-3.805 17.802-4.853 23.134-3.138 8.562 21.509 9.325 40.922 2.279 58.24 15.036 16.18 22.559 35.787 22.559 58.817 0 16.178-1.958 30.497-5.853 42.966-3.9 12.471-8.941 22.457-15.125 29.979-6.191 7.521-13.901 13.85-23.131 18.986-9.232 5.14-18.182 8.85-26.84 11.136-8.662 2.286-18.415 4.004-29.263 5.146 9.894 8.562 14.842 22.077 14.842 40.539v60.237c0 3.422 1.19 6.279 3.572 8.562 2.379 2.279 6.136 2.95 11.276 1.995 44.163-14.653 80.185-41.062 108.068-79.226 27.88-38.161 41.825-81.126 41.825-128.906-.01-39.771-9.818-76.454-29.414-110.049z"
84+
)
85+
end
86+
end
87+
88+
def format_amount(amount)
89+
"$#{amount}.00"
90+
end
91+
92+
def render_status_badge(status)
93+
case status.downcase
94+
when "active"
95+
Badge(variant: :success, size: :sm) { status }
96+
when "inactive"
97+
Badge(variant: :destructive, size: :sm) { status }
98+
when "pending"
99+
Badge(variant: :warning, size: :sm) { status }
100+
end
101+
end
102+
end

0 commit comments

Comments
 (0)