Class: Playbook::PbDocs::KitExample

Inherits:
KitBase
  • Object
show all
Includes:
Markdown::Helper
Defined in:
app/pb_kits/playbook/pb_docs/kit_example.rb

Instance Attribute Summary

Attributes included from Playbook::Props

#values

Instance Method Summary collapse

Methods included from Markdown::Helper

call, markdown, #render_markdown, #rouge, #rouge_markdown

Methods inherited from KitBase

#object

Methods included from Playbook::Position

included, #position_options, #position_values

Methods included from Order

included, #order_options, #order_props, #order_values

Methods included from FlexShrink

#flex_shrink_options, #flex_shrink_props, #flex_shrink_values, included

Methods included from FlexGrow

#flex_grow_options, #flex_grow_props, #flex_grow_values, included

Methods included from Flex

#flex_options, #flex_props, #flex_values, included

Methods included from AlignSelf

#align_self_options, #align_self_props, #align_self_values, included

Methods included from AlignContent

#align_content_options, #align_content_props, #align_content_values, included

Methods included from AlignItems

#align_items_options, #align_items_props, #align_items_values, included

Methods included from JustifySelf

included, #justify_self_options, #justify_self_props, #justify_self_values

Methods included from JustifyContent

included, #justify_content_options, #justify_content_props, #justify_content_values

Methods included from FlexWrap

#flex_wrap_options, #flex_wrap_props, #flex_wrap_values, included

Methods included from FlexDirection

#flex_direction_options, #flex_direction_props, #flex_direction_values, included

Methods included from Cursor

#cursor_options, #cursor_props, #cursor_values, included

Methods included from Display

#display_options, #display_props, #display_size_values, #display_values, included

Methods included from LineHeight

included, #line_height_options, #line_height_props, #line_height_values

Methods included from Shadow

included, #shadow_options, #shadow_props, #shadow_values

Methods included from NumberSpacing

included, #number_spacing_options, #number_spacing_values

Methods included from ZIndex

included, #screen_size_values, #z_index_options, #z_index_props, #z_index_values

Methods included from Spacing

included, #max_width_options, #max_width_props, #max_width_values, #spacing_options, #spacing_props, #spacing_values

Methods included from Classnames

#generate_classname, #generate_classname_without_spacing, included

Methods included from Playbook::Props

#initialize, #prop

Methods included from Playbook::PbKitHelper

#pb_rails

Methods included from Playbook::PbFormsHelper

#pb_form_with

Instance Method Details

#description ⇒ Object 



25
26
27
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 25

def description
  @description ||= read_kit_file("docs", "_#{example_key}.md")
end

#example ⇒ Object 



17
18
19
20
21
22
23
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 17

def example
  if type == "rails"
    render inline: source
  elsif type == "react"
    react_component example_key.camelize, { dark: dark }
  end
end

#highlighter ⇒ Object 



29
30
31
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 29

def highlighter
  type.eql?("rails") ? "erb" : "react"
end

#source ⇒ Object 



33
34
35
36
37
38
39
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 33

def source
  @source ||= begin
    extension = type == "react" ? "jsx" : "html.erb"
    stringified_code = read_kit_file("docs", "_#{example_key}.#{extension}")
    sanitize_code(stringified_code)
  end
end

#tsx_source ⇒ Object 



41
42
43
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 41

def tsx_source
  read_kit_file("", "_#{example_key}.tsx")
end