Merge pull request #237 from marcoroth/develop

add kbd matestack core component

Author: pascalwengerter

app/concepts/matestack/ui/core/kbd/kbd.haml

@@ -0,0 +1,5 @@
+%kbd{@tag_attributes}
+  - if options[:text].blank? && block_given?
+    = yield
+  - else
+    = options[:text]

app/concepts/matestack/ui/core/kbd/kbd.rb

@@ -0,0 +1,4 @@
+module Matestack::Ui::Core::Kbd
+  class Kbd < Matestack::Ui::Core::Component::Static
+  end
+end

docs/components/README.md

@@ -40,6 +40,7 @@ You can build your [own components](/docs/extend/custom_components.md) as well,
 - [noscript](/docs/components/noscript.md)
 - [sup](/docs/components/sup.md)
 - [sub](/docs/components/sub.md)
+- [kbd](/docs/components/kbd.md)
 
 ## Dynamic Core Components
 

docs/components/kbd.md

@@ -0,0 +1,44 @@
+# matestack core component: kbd
+
+Show [specs](/spec/usage/components/kbd_spec.rb)
+
+The HTML kbd tag implemented in ruby.
+
+## Parameters
+
+This component can take 2 optional configuration params and either yield content or display what gets passed to the `text` configuration param.
+
+#### # id (optional)
+Expects a string with all ids the kbd should have.
+
+#### # class (optional)
+Expects a string with all classes the kbd should have.
+
+## Example 1: Yield a given block
+
+```ruby
+kbd id: 'foo', class: 'bar' do
+  plain 'Keyboard input' # optional content
+end
+```
+
+returns
+
+```html
+<kbd id="foo" class="bar">
+  Keyboard input
+</kbd>
+```
+
+## Example 2: Render `options[:text]` param
+
+```ruby
+kbd id: 'foo', class: 'bar', text: 'Keyboard input'
+```
+
+returns
+
+```html
+<kbd id="foo" class="bar">
+  Keyboard input
+</kbd>

spec/usage/components/kbd_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../../support/utils'
+include Utils
+
+describe 'kbd Component', type: :feature, js: true do
+  it 'Renders a simple and enhanced kbd tag on a page' do
+    class ExamplePage < Matestack::Ui::Page
+      def response
+        components {
+          # simple kbd
+          kbd text: 'Simple Keyboard Input'
+
+          # enhanced kbd
+          kbd id: 'my-id', class: 'my-class' do
+            plain 'Enhanced Keyboard Input'
+          end
+        }
+      end
+    end
+
+    visit '/example'
+
+    static_output = page.html
+
+    expected_static_output = <<~HTML
+      <kbd>Simple Keyboard Input</kbd>
+      <kbd id="my-id" class="my-class">Enhanced Keyboard Input</kbd>
+    HTML
+
+    expect(stripped(static_output)).to include(stripped(expected_static_output))
+  end
+end