Matestack Ui Core
AboutMatestack Ui CoreMatestack Ui VueJsMatestack Ui Bootstrap
1.5
1.5
  • Welcome
  • Getting started
    • Installation & Update
    • Concepts & Rails Integration
    • Quick Start
    • Support & Feedback [WIP]
    • Common Issues [WIP]
  • UI Components
    • Component Overview
    • Rails Integration
    • Component Registry
    • General Component API
    • Haml Components
    • Reusing Views or Partials
    • Testing [WIP]
  • Reactivity
    • Reactivity Overview
    • Rails Integration
    • Actions
    • Forms
    • Async
    • Cable
    • Isolated
    • Collection
    • Custom Vue.js Components
    • Vue.js Event Hub
    • Vuex [WIP]
  • SPA-like Apps
    • SPA Overview
    • Rails Integration
    • App API
    • Page API
    • Transitions
    • Authorization
    • Tutorial
      • Creating a SPA-like App with Matestack
      • Essential Guide 1: Setup
      • Essential Guide 2: ActiveRecord & Database
      • Essential Guide 3: Person Index, Show, Transition
      • Essential Guide 4: Forms & Actions (Create, Update, Delete)
      • Essential Guide 5: Toggle Component
      • Essential Guide 6: Async Component
      • Essential Guide 7: Partials and custom components
      • Essential Guide 8: Collection and async component
      • Essential Guide 9: Custom Vue.js components
      • Essential Guide 10: Styling and Notifications
      • Essential Guide 11: Authentication
      • Essential Guide 12: Heroku Deployment with Postgres
      • Essential Guide 13: Wrap Up & Outlook
  • Components API
    • Core Components
      • Abbr
      • Address
      • Area
      • Article
      • Aside
      • B
      • Bdi
      • Bdo
      • Blockquote
      • Button
      • Br
      • Caption
      • Cite
      • Code
      • Data
      • Datalist
      • Dd
      • Del
      • Details
      • Dfn
      • Dialog
      • Div
      • Dl
      • Dt
      • Em
      • Fieldset
      • Figure
      • Footer
      • Hr
      • Icon
      • Iframe
      • Img
      • Ins
      • Input
      • Header
      • Heading
      • Kbd
      • Label
      • Legend
      • Link
      • Lists
      • Main
      • Mark
      • Map
      • Meter
      • Nav
      • Noscript
      • Object
      • Option
      • Optgroup
      • Output
      • Paragraph
      • Param
      • Picture
      • Pg
      • Plain
      • Pre
      • Progress
      • S
      • Samp
      • Section
      • Select
      • Small
      • Span
      • Sup
      • Sub
      • Strong
      • Table
      • Template
      • Textarea
      • U
      • Unescaped
      • Q
      • Rails View
      • Rp
      • Rt
      • Ruby
      • Var
      • Video
      • Wbr
      • Youtube
    • Reactive Core Components
      • Action
      • Async
      • Cable
      • Collection
      • Form
      • Form Input
      • Form Checkbox
      • Form Radio
      • Form Select
      • Form Submit
      • Form Textarea
      • Onclick
      • Transition
      • Toggle
  • Integrations
    • Action Cable
    • Devise
    • CSS Frameworks [WIP]
    • Third Party JavaScript [WIP]
    • Third Party Ruby Gems [WIP]
  • Matestack Addons
    • Create your own Addon [WIP]
  • Community
    • Discord
    • Contribute
  • About
    • Core Team [WIP]
    • Sponsoring [WIP]
    • Legal Details [WIP]
Powered by GitBook
On this page
  • Parameters
  • Size (optional)
  • Text (optional)
  • HMTL attributes (optional)
  • Examples
  • Example 1: Basic usage
  • Example 1: Yield a given block
  • Example 2: Render options[:text] param

Was this helpful?

Edit on GitHub
  1. Components API
  2. Core Components

Heading

PreviousHeaderNextKbd

Last updated 3 years ago

Was this helpful?

The HTML <h1>, <h2>, <h3>, <h4>, <h5>, <h6> tags, implemented in Ruby.

Parameters

This component can take various optional configuration params and either yield content or display what gets passed to the text configuration param.

Size (optional)

Expects an integer, from 1 to 6. If not set, it defaults to 1 and creates and <h1> tag.

Text (optional)

Expects a string which will be displayed as the content inside the <h(1-6)> tag.

HMTL attributes (optional)

This component accepts all the canonical like id or class.

Examples

Example 1: Basic usage

heading size: 1, text: 'Heading, size 1'
heading size: 2, text: 'Heading, size 2'
heading size: 3, text: 'Heading, size 3'
heading size: 4, text: 'Heading, size 4'
heading size: 5, text: 'Heading, size 5'
heading size: 6, text: 'Heading, size 6'
heading text: 'Heading, default size 1'

returns

<h1>Heading, size 1</h1>
<h2>Heading, size 2</h2>
<h3>Heading, size 3</h3>
<h4>Heading, size 4</h4>
<h5>Heading, size 5</h5>
<h6>Heading, size 6</h6>
<h6>Heading, default size 1</h6>

Example 1: Yield a given block

heading id: "foo", class: "bar" do
  plain "Hello World"
end

returns

<h1 id="foo" class="bar">Hello World</h1>

Example 2: Render options[:text] param

heading id: "foo", class: "bar", text: "Hello World"

returns

<h1 id="foo" class="bar">Hello World</h1>
HTML global attributes