Class: Playbook::PbDocs::KitExample

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

Constant Summary

Constants included from Playbook::PositionPropsCss

Playbook::PositionPropsCss::POSITION_VALUES

Instance Attribute Summary

Attributes included from Playbook::Props

#values

Instance Method Summary collapse

Methods inherited from KitBase

#combined_html_options, #object, #pb_content_tag

Methods included from VerticalAlign

included, #vertical_align_options, #vertical_align_props, #vertical_align_values

Methods included from Bottom

#bottom_options, #bottom_values, included

Methods included from Playbook::PositionPropsCss

#positioning_css

Methods included from Right

included, #right_options, #right_values

Methods included from Top

included, #top_options, #top_values

Methods included from Left

included, #left_options, #left_values

Methods included from Truncate

included, #truncate_options, #truncate_props, #truncate_values

Methods included from Overflow

included, #overflow_options, #overflow_props, #overflow_values

Methods included from TextAlign

included, #text_align_options, #text_align_props, #text_align_values

Methods included from BorderRadius

#border_radius_options, #border_radius_props, #border_radius_values, included

Methods included from Hover

#hover_attributes, #hover_background_values, #hover_color_values, #hover_options, #hover_props, #hover_scale_values, #hover_shadow_values, #hover_values, included

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

#break_method_values, #filter_classname, included, #max_width_options, #max_width_props, #max_width_values, #min_width_options, #min_width_props, #min_width_values, #screen_size_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 



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

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

#example ⇒ Object 



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

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

#highlighter ⇒ Object 



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

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

#source ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 34

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

#swift_source ⇒ Object 



50
51
52
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 50

def swift_source
  read_kit_file("", "_#{example_key}.swift")
end

#tsx_source ⇒ Object 



46
47
48
 
# File 'app/pb_kits/playbook/pb_docs/kit_example.rb', line 46

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