Class: Views::Docs::Command

Inherits:
Base
  • Object
show all
Defined in:
lib/ruby_ui/command/command_docs.rb

Instance Method Summary collapse

Methods inherited from Base

#Alert, #AlertDescription, #AlertTitle, #Heading, #InlineCode, #InlineLink, #Text, #component_files, #docs_accordion_path, #docs_alert_dialog_path, #docs_alert_path, #docs_aspect_ratio_path, #docs_avatar_path, #docs_badge_path, #docs_installation_path, #docs_separator_path, #docs_sheet_path

Instance Method Details

#view_template ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ruby_ui/command/command_docs.rb', line 4

def view_template
  component = "Command"
  div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
    render Docs::Header.new(title: "Command", description: "Fast, composable, unstyled command menu for Phlex.")

    Heading(level: 2) { "Usage" }

    render Docs::VisualCodeExample.new(title: "Example", context: self) do
      <<~RUBY
        CommandDialog do
          CommandDialogTrigger do
            Button(variant: "outline", class: 'w-56 pr-2 pl-3 justify-between') do
              div(class: "flex items-center space-x-1") do
                search_icon
                span(class: "text-muted-foreground font-normal") do
                  plain "Search"
                end
              end
              ShortcutKey do
                span(class: "text-xs") { "⌘" }
                plain "K"
              end
            end
          end
          CommandDialogContent do
            Command do
              CommandInput(placeholder: "Type a command or search...")
              CommandEmpty { "No results found." }
              CommandList do
                CommandGroup(title: "Components") do
                  components_list.each do |component|
                    CommandItem(value: component[:name], href: component[:path]) do
                      default_icon
                      plain component[:name]
                    end
                  end
                end
                CommandGroup(title: "Settings") do
                  settings_list.each do |setting|
                    CommandItem(value: setting[:name], href: setting[:path]) do
                      default_icon
                      plain setting[:name]
                    end
                  end
                end
              end
            end
          end
        end
      RUBY
    end

    render Docs::VisualCodeExample.new(title: "With keybinding", context: self) do
      <<~RUBY
        CommandDialog do
          CommandDialogTrigger(keybindings: ['keydown.ctrl+j@window', 'keydown.meta+j@window']) do
            p(class: "text-sm text-muted-foreground") do
              span(class: 'mr-1') { "Press" }
              ShortcutKey do
                span(class: "text-xs") { "⌘" }
                plain "J"
              end
            end
          end
          CommandDialogContent do
            Command do
              CommandInput(placeholder: "Type a command or search...")
              CommandEmpty { "No results found." }
              CommandList do
                CommandGroup(title: "Components") do
                  components_list.each do |component|
                    CommandItem(value: component[:name], href: component[:path]) do
                      default_icon
                      plain component[:name]
                    end
                  end
                end
                CommandGroup(title: "Settings") do
                  settings_list.each do |setting|
                    CommandItem(value: setting[:name], href: setting[:path]) do
                      default_icon
                      plain setting[:name]
                    end
                  end
                end
              end
            end
          end
        end
      RUBY
    end

    render Components::ComponentSetup::Tabs.new(component_name: component)

    render Docs::ComponentsTable.new(component_files(component))
  end
end