Skip to content

Commit edf8ccd

Browse files
authored
Merge pull request #248 from marcoroth/mark_tag
add mark matestack core component
2 parents ba30386 + a3b3834 commit edf8ccd

File tree

5 files changed

+85
-0
lines changed

5 files changed

+85
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
%mark{@tag_attributes}
2+
- if options[:text].blank? && block_given?
3+
= yield
4+
- else
5+
= options[:text]
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module Matestack::Ui::Core::Mark
2+
class Mark < Matestack::Ui::Core::Component::Static
3+
end
4+
end

docs/components/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ You can build your [own components](/docs/extend/custom_components.md) as well,
3737
- [rt](/docs/components/rb.md)
3838
- [rp](/docs/components/rt.md)
3939
- [legend](/docs/components/legend.md)
40+
- [mark](/docs/components/mark.md)
4041
- [noscript](/docs/components/noscript.md)
4142
- [sup](/docs/components/sup.md)
4243
- [sub](/docs/components/sub.md)

docs/components/mark.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# matestack core component: Mark
2+
3+
Show [specs](/spec/usage/components/mark_spec.rb)
4+
5+
The HTML `<mark>` tag implemented in ruby.
6+
7+
## Parameters
8+
9+
This component can take 2 optional configuration params and either yield content or display what gets passed to the `text` configuration param.
10+
11+
#### # id (optional)
12+
Expects a string with all ids the `<mark>` should have.
13+
14+
#### # class (optional)
15+
Expects a string with all classes the `<mark>` should have.
16+
17+
## Example 1: Yield a given block
18+
19+
```ruby
20+
mark id: 'foo', class: 'bar' do
21+
plain 'Mark Example 1' # optional content
22+
end
23+
```
24+
25+
returns
26+
27+
```html
28+
<mark id="foo" class="bar">
29+
Mark Example 1
30+
</mark>
31+
```
32+
33+
## Example 2: Render `options[:text]` param
34+
35+
```ruby
36+
mark id: 'foo', class: 'bar', text: 'Mark Example 2'
37+
```
38+
39+
returns
40+
41+
```html
42+
<mark id="foo" class="bar">
43+
Mark Example 2
44+
</mark>

spec/usage/components/mark_spec.rb

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
require_relative '../../support/utils'
2+
include Utils
3+
4+
describe 'mark Component', type: :feature, js: true do
5+
it 'Renders a simple and enhanced mark tag on a page' do
6+
class ExamplePage < Matestack::Ui::Page
7+
def response
8+
components {
9+
# simple mark
10+
mark text: 'Simple mark Tag'
11+
12+
# enhanced mark
13+
mark id: 'my-id', class: 'my-class' do
14+
plain 'Enhanced mark Tag'
15+
end
16+
}
17+
end
18+
end
19+
20+
visit '/example'
21+
22+
static_output = page.html
23+
24+
expected_static_output = <<~HTML
25+
<mark>Simple mark Tag</mark>
26+
<mark id="my-id" class="my-class">Enhanced mark Tag</mark>
27+
HTML
28+
29+
expect(stripped(static_output)).to include(stripped(expected_static_output))
30+
end
31+
end

0 commit comments

Comments
 (0)