-
-
Notifications
You must be signed in to change notification settings - Fork 43
Add abbr component with specs and documentation #124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
%abbr{@tag_attributes} | ||
- if options[:text].blank? && block_given? | ||
= yield | ||
- else | ||
= options[:text] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
module Matestack::Ui::Core::Abbr | ||
class Abbr < Matestack::Ui::Core::Component::Static | ||
REQUIRED_KEYS = [:title] | ||
|
||
def setup | ||
@tag_attributes.merge!({ | ||
"title": options[:title] | ||
}) | ||
end | ||
|
||
end | ||
end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# matestack core component: abbr | ||
|
||
Show [specs](../../spec/usage/components/abbr_spec.rb) | ||
|
||
The HTML `abbr` tag implemented in ruby. | ||
|
||
## Parameters | ||
|
||
This component expects 1 required param, 2 optional configuration params and either yield content or display what gets passed to the `text` configuration param. | ||
|
||
#### # title - required | ||
Expects a string with the meaning of the abbreviation contained within the tag. | ||
|
||
#### # id - optional | ||
Expects a string with all ids the `abbr` should have. | ||
|
||
#### # class - optional | ||
Expects a string with all classes the `abbr` should have. | ||
|
||
michaelrevans marked this conversation as resolved.
Show resolved
Hide resolved
|
||
#### # text - optional | ||
Expects a string which will be displayed as the content inside the `abbr`. If this is not passed, a block must be passed instead. | ||
|
||
## Example 1 - render options[:text] param | ||
|
||
```ruby | ||
abbr title: 'Hypertext Markup Language', text: 'HTML' | ||
``` | ||
|
||
returns | ||
|
||
```html | ||
<abbr title="Hypertext Markup Language">HTML</abbr> | ||
``` | ||
|
||
|
||
## Example 2 - yield a given block | ||
|
||
```ruby | ||
abbr title: 'Cascading Style Sheets' do | ||
span text: 'CSS' | ||
end | ||
``` | ||
|
||
returns | ||
|
||
```html | ||
<abbr title="Cascading Style Sheets">CSS</abbr> | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
require_relative '../../support/utils' | ||
include Utils | ||
|
||
describe 'Abbr Component', type: :feature, js: true do | ||
|
||
it 'Example 1' do | ||
|
||
class ExamplePage < Matestack::Ui::Page | ||
|
||
def response | ||
components { | ||
abbr title: 'Hypertext Markup Language', text: 'HTML' | ||
} | ||
end | ||
|
||
end | ||
|
||
visit '/example' | ||
|
||
static_output = page.html | ||
|
||
expected_static_output = <<~HTML | ||
<abbr title="Hypertext Markup Language">HTML</abbr> | ||
HTML | ||
|
||
expect(stripped(static_output)).to include(stripped(expected_static_output)) | ||
end | ||
|
||
it 'Example 2' do | ||
|
||
class ExamplePage < Matestack::Ui::Page | ||
|
||
def response | ||
components { | ||
abbr title: 'Cascading Style Sheets' do | ||
span text: 'CSS' | ||
end | ||
} | ||
end | ||
|
||
end | ||
|
||
visit '/example' | ||
|
||
static_output = page.html | ||
|
||
expected_static_output = <<~HTML | ||
<abbr title="Cascading Style Sheets"><span>CSS</span></abbr> | ||
HTML | ||
|
||
expect(stripped(static_output)).to include(stripped(expected_static_output)) | ||
end | ||
|
||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.