Class: Primer::Beta::Markdown

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/beta/markdown.rb

Overview

Use ‘Markdown` to wrap markdown content.

Constant Summary collapse

DEFAULT_TAG = 
:div
TAG_OPTIONS = 
[DEFAULT_TAG, :article, :td].freeze

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Constants included from AttributesHelper

AttributesHelper::PLURAL_ARIA_ATTRIBUTES, AttributesHelper::PLURAL_DATA_ATTRIBUTES

Instance Method Summary collapse

Methods inherited from Component

deprecated?, generate_id

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Methods included from AttributesHelper

#aria, #data, #extract_data, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Methods included from ExperimentalSlotHelpers

included

Methods included from ExperimentalRenderHelpers

included

Constructor Details

#initialize(tag: DEFAULT_TAG, **system_arguments) ⇒ Markdown

Returns a new instance of Markdown.

Parameters:

  • tag (Symbol) (defaults to: DEFAULT_TAG) —

    <%= one_of(Primer::Beta::Markdown::TAG_OPTIONS) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



14
15
16
17
18
19
20
21
22
 
# File 'app/components/primer/beta/markdown.rb', line 14

def initialize(tag: DEFAULT_TAG, **system_arguments)
  @system_arguments = system_arguments
  @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)

  @system_arguments[:classes] = class_names(
    "markdown-body",
    system_arguments[:classes]
  )
end

Instance Method Details

#call ⇒ Object 



24
25
26
 
# File 'app/components/primer/beta/markdown.rb', line 24

def call
  render(Primer::BaseComponent.new(**@system_arguments)) { content }
end