Class: Views::Docs::Chart

Inherits:
Base
  • Object
show all
Defined in:
lib/ruby_ui/chart/chart_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
101
102
103
104
105
 
# File 'lib/ruby_ui/chart/chart_docs.rb', line 4

def view_template
  div(class: "max-w-2xl mx-auto w-full py-10 space-y-10") do
    render Docs::Header.new(title: "Chart", description: "Displays information in a visual way.")

    Heading(level: 2) { "Introduction" }

    Text do
      plain "RubyUI uses "
      InlineLink(href: "https://www.chartjs.org/") { "Chart.js" }
      plain " to render charts. Chart.js is a free open-source JavaScript library for data visualization, which supports 8 chart types: bar, line, area, pie, bubble, radar, polar, and scatter. If you're unfamiliar with Chart.js. We recommend the "
      InlineLink(href: "https://www.chartjs.org/docs/latest/getting-started/") { "Getting Started guide" }
      plain ". "
    end

    Heading(level: 2) { "Usage" }

    render Docs::VisualCodeExample.new(title: "Bar Chart", context: self) do
      <<~RUBY
        options = {
          type: 'bar',
          data: {
            labels: ['Phlex', 'VC', 'ERB'],
            datasets: [{
              label: 'render time (ms)',
              data: [100, 520, 1200],
            }]
          },
          options: {
            indexAxis: 'y',
            scales: {
              y: {
                beginAtZero: true
              }
            },
          },
        }

        Chart(options: options)
      RUBY
    end

    render Docs::VisualCodeExample.new(title: "Line Graph", context: self) do
      <<~RUBY
        options = {
          type: 'line',
          data: {
            labels: ['Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul'],
            datasets: [{
              label: 'Github Stars',
              data: [40, 30, 79, 140, 290, 550],
            }]
          },
          options: {
            scales: {
              y: {
                beginAtZero: true
              }
            },
            plugins: {
              legend: {
                display: false
              }
            }
          },
        }

        Chart(options: options)
      RUBY
    end

    render Docs::VisualCodeExample.new(title: "Pie Chart", description: "Setting custom background color", context: self) do
      <<~RUBY
        options = {
          type: 'pie',
          data: {
            labels: [
              'Red',
              'Blue',
              'Yellow'
            ],
            datasets: [{
              label: 'My First Dataset',
              data: [300, 50, 100],
              backgroundColor: [
                'rgb(255, 99, 132)',
                'rgb(54, 162, 235)',
                'rgb(255, 205, 86)'
              ],
              hoverOffset: 4
            }]
          },
        }

        Chart(options: options)
      RUBY
    end

    render Components::ComponentSetup::Tabs.new(component_name: "Chart")

    render Docs::ComponentsTable.new(components)
  end
end