Class: Yattho::Beta::Markdown

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

Overview

Use ‘Markdown` to wrap markdown content.

Direct Known Subclasses

Markdown

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

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

Constructor Details

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

Returns a new instance of Markdown.

Examples:

Default

<%= render(Yattho::Beta::Markdown.new) do %>
  <p>Text can be <b>bold</b>, <i>italic</i>, or <s>strikethrough</s>. <a href="https://github.com">Links </a> should be blue with no underlines (unless hovered over).</p>

  <p>There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.</p>

  <p>There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.</p>

  <blockquote>
    <p>There should be no margin above this first sentence.</p>
    <p>Blockquotes should be a lighter gray with a gray border along the left side.</p>
    <p>There should be no margin below this final sentence.</p>
  </blockquote>

  <h1>Header 1</h1>

  <p>This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.</p>

  <h2>Header 2</h2>

  <blockquote>This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.</blockquote>

  <h3>Header 3</h3>

  <pre><code>This is a code block following a header.</code></pre>

  <h4>Header 4</h4>

  <ul>
    <li>This is an unordered list following a header.</li>
    <li>This is an unordered list following a header.</li>
    <li>This is an unordered list following a header.</li>
  </ul>

  <h5>Header 5</h5>

  <ol>
    <li>This is an ordered list following a header.</li>
    <li>This is an ordered list following a header.</li>
    <li>This is an ordered list following a header.</li>
  </ol>

  <h6>Header 6</h6>

  <table>
    <thead>
      <tr>
        <th>What</th>
        <th>Follows</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>A table</td>
        <td>A header</td>
      </tr>
      <tr>
        <td>A table</td>
        <td>A header</td>
      </tr>
      <tr>
        <td>A table</td>
        <td>A header</td>
      </tr>
    </tbody>
  </table>

  <hr />

  <p>There's a horizontal rule above and below this.</p>

  <hr />

  <p>Here is an unordered list:</p>

  <ul>
    <li>Salt-n-Pepa</li>
    <li>Bel Biv DeVoe</li>
    <li>Kid 'N Play</li>
  </ul>

  <p>And an ordered list:</p>

  <ol>
    <li>Michael Jackson</li>
    <li>Michael Bolton</li>
    <li>Michael Bublé</li>
  </ol>

  <p>And an unordered task list:</p>

  <ul>
    <li><input type="checkbox" id="create-markdown" checked /><label for="create-markdown">Create a sample markdown document</label><br></li>
    <li><input type="checkbox" id="tasks-list" checked /><label for="tasks-list">Add tasks list to it</label><br></li>
    <li><input type="checkbox" id="take-vacation" checked /><label for="take-vacation">Take a vacation</label><br></li>
  </ul>

  <p>And a "mixed" task list:</p>

  <ul>
    <li><input type="checkbox"id="steal-underpants"/><label for="steal-underpants">Steal underpants</label></li>
    <li>?</li>
    <li><input type="checkbox"id="profit"/><label for="profit">Profit!</label></li>
  </ul>

  And a nested list:

  <ul>
    <li>Jackson 5
      <ul>
        <li>Michael</li>
        <li>Tito</li>
        <li>Jackie</li>
        <li>Marlon</li>
        <li>Jermaine</li>
      </ul>
    </li>
    <li>TMNT
      <ul>
        <li>Leonardo</li>
        <li>Michelangelo</li>
        <li>Donatello</li>
        <li>Raphael</li>
      </ul>
    </li>
  </ul>

  <p>Definition lists can be used with HTML syntax. Definition terms are bold and italic.</p>

  <dl>
      <dt>Name</dt>
      <dd>Godzilla</dd>
      <dt>Born</dt>
      <dd>1952</dd>
      <dt>Birthplace</dt>
      <dd>Japan</dd>
      <dt>Color</dt>
      <dd>Green</dd>
  </dl>

  <hr />

  <p>Tables should have bold headings and alternating shaded rows.</p>

  <table>
    <thead>
      <tr>
        <th>Artist</th>
        <th>Album</th>
        <th>Year</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>David Bowie</td>
        <td>Scary Monsters</td>
        <td>1980</td>
      </tr>
      <tr>
        <td>Prince</td>
        <td>Purple Rain</td>
        <td>1982</td>
      </tr>
      <tr>
        <td>Beastie Boys</td>
        <td>License to Ill</td>
        <td>1986</td>
      </tr>
      <tr>
        <td>Janet Jackson</td>
        <td>Rhythm Nation 1814</td>
        <td>1989</td>
      </tr>
    </tbody>
  </table>

  <p>If a table is too wide, it should condense down and/or scroll horizontally.</p>

  <table>
    <thead>
      <tr>
        <th>Artist</th>
        <th>Album</th>
        <th>Year</th>
        <th>Label</th>
        <th>Songs</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>David Bowie</td>
        <td>Scary Monsters</td>
        <td>1980</td>
        <td>RCA Records</td>
        <td>It's No Game (No. 1), Up the Hill Backwards, Scary Monsters (And Super Creeps), Ashes to Ashes, Fashion, Teenage Wildlife, Scream Like a Baby, Kingdom Come, Because You're Young, It's No Game (No. 2)</td>
      </tr>
      <tr>
        <td>Prince</td>
        <td>Purple Rain</td>
        <td>1982</td>
        <td>Warner Brothers Records</td>
        <td>Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain</td>
      </tr>
      <tr>
        <td>Beastie Boys</td>
        <td>License to Ill</td>
        <td>1986</td>
        <td>Def Jam</td>
        <td>Rhymin &amp; Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, Fight for Your Right, No Sleep till Brooklyn, Paul Revere, "Hold It Now, Hit It", Brass Monkey, Slow and Low, Time to Get Ill</td>
      </tr>
      <tr>
        <td>Janet Jackson</td>
        <td>Rhythm Nation 1814</td>
        <td>1989</td>
        <td>A&amp;M</td>
        <td>Interlude: Pledge, Rhythm Nation, Interlude: T.V., State of the World, Interlude: Race, The Knowledge, Interlude: Let's Dance, Miss You Much, Interlude: Come Back, Love Will Never Do (Without You), Livin' in a World (They Didn't Make), Alright, Interlude: Hey Baby, Escapade, Interlude: No Acid, Black Cat, Lonely, Come Back to Me, Someday Is Tonight, Interlude: Livin'...In Complete Darkness</td>
      </tr>
    </tbody>
  </table>

  <hr />

  <p>Code snippets like <code>var foo = "bar";</code> can be shown inline.</p>

  <p>Also, <code>this should vertically align</code> <s><code>with this</code></s> <s>and this</s>.</p>

  <p>Code can also be shown in a block element.</p>

  <pre><code>var foo = "bar";</code></pre>

  <p>Code can also use syntax highlighting.</p>

  <pre><code>var foo = "bar";</code></pre>

  <pre tabindex="0"><code>Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.</code></pre>

  <pre tabindex="0"><code>var foo = "The same thing is true for code with syntax highlighting. A single line of code should horizontally scroll if it is really long.";</code></pre>

  <p>Inline code inside table cells should still be distinguishable.</p>

  <table>
    <thead>
      <tr>
        <th>Language</th>
        <th>Code</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>JavasScript</td>
        <td><code>var foo = "bar";</code></td>
      </tr>
      <tr>
        <td>Ruby</td>
        <td><code>foo = "bar"</code></td>
      </tr>
    </tbody>
  </table>

  <pre><code>This is the final element on the page and there should be no margin below this.</code></pre>
<% end %>

Parameters:

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

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

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



275
276
277
278
279
280
281
282
283
 
# File 'app/components/yattho/beta/markdown.rb', line 275

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 



285
286
287
 
# File 'app/components/yattho/beta/markdown.rb', line 285

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