Releases: yippee-fun/phlex
2.3.0
2f4b364Highlights
- You can now pass
DateandTimeobjects as HTML attributes. - Specific HTML attributes on specific HTML elements (e.g.
img[srcset]) now generate comma-separated token lists when passed a RubyArray. Previously they generated space-separated token lists.
What's Changed
- Update doc comment in sgml.rb by @christopher-b in #895
- Prefer inline access modifiers by @joeldrapper in #901
- Add support for Date/Time attribute values by @joeldrapper in #903
- Comma-separated tokens by @joeldrapper in #904
New Contributors
- @christopher-b made their first contribution in #895
Full Changelog: 2.2.1...2.3.0
Contributors
Assets 2
2.2.1
b75799eHighlights
- You can now use the new
<selectedcontent>HTML element - Phlex CSV will now forward all the arguments to
row_templateand you can callsupermultiple times to fan out multiple rows in each iteration - When using a hash as an attribute value, you can now use the key
_:to set the value of the root, for example
PRs
- Update
around_rowto forward all arguments torow_templateby @willcosgrove in #881 - Root hash attributes by @willcosgrove in #889
- Add
<selectedcontent>element by @joeldrapper in #890 - CSV row fan-out by @willcosgrove in #885
- Add autoloading via Zeitwerk by @joeldrapper in #891
Full Changelog: 2.1.2...2.2.1
Contributors
Assets 2
2.1.2
Highlights
- Fixes an issue when
Phlex::CSVcolumns had empty values - Somer under-the-hood changes to capturing to make it easier to integrate with Rails in
phlex-rails
What's Changed
- Adds and passes test for blank and nil csv values by @nolantait in #876
- Move capturing up to the state object by @joeldrapper in #880
New Contributors
- @nolantait made their first contribution in #876
Full Changelog: 2.1.1...2.1.2
Contributors
Assets 2
2.1.1
[Experimental] support for ERB snippets
In this non-breaking release, we’ve added support for ERB snippets. Anything that you would have defined as a Ruby method, e.g. view_template can now be defined as ERB.
Basic inline example
In this example, we create a Nav component and define its view_template using ERB instead of Ruby. The erb class method defines the view_template method with the compiled ERB for us. We also expose an item snippet — again defined with ERB. This time it defines the item instance method. Here, we specify locals: %(href:), which means the method will be defined as def item(href:).
class Nav < Phlex::HTML
erb :view_template, <<~ERB
<nav>
<% yield %>
</nav>
ERB
erb :item, <<~ERB, locals: %(href:)
<a href="<%= href %>">
<% yield %>
</a>
ERB
endLocals
You can put anything in the locals string that you would regularly put in a Ruby method signature:
Required positional argument
erb :method_name, <<~ERB, locals: %(foo)
Optional positional argument
erb :method_name, <<~ERB, locals: %(foo = nil)
Positional argument with default
erb :method_name, <<~ERB, locals: %(foo = "test")
Required keyword argument
erb :method_name, <<~ERB, locals: %(foo:)
Optional keyword argument
erb :method_name, <<~ERB, locals: %(foo: nil)
Keyword argument with default
erb :method_name, <<~ERB, locals: %(foo: "test")
Note: we may rename locals: to params: or something else. Send us your feedback.
Sidecar templates
Instead of defining the ERB templates inline, you can alternatively define them as sidecar files. You’ll still need to define the method signatures in your component. Let’s go back to our nav component. We can remove the inline ERB.
class Nav < Phlex::HTML
erb :view_template
erb :item, locals: %(href:)
endIf this Nav component is defined in app/components/nav.rb, Phlex will search for the following sidecar files:
app/components/nav/view_template.html.erbapp/components/nav/item.html.erb
In the case of the view_template snippet, If Phlex can’t find app/components/nav/view_template.html.erb, it will also try app/components/nav.html.erb.
Performance
All ERB templates are compiled into methods once at boot so performance should be excellent.
Compatibility
For the most part, these ERB snippets should be completely compatible with Ruby snippets and all the Phlex features like fragments, caching, etc. When it comes to caching, the technique we use to bust the cache when you make changes in development mode with Rails will not work if you use external sidecar ERB files.
Security
Because ERB is not structural, we can’t provide all the same security features. It is possible, for example to write ERB like this, and since we don’t know you’re writing to an href attribute, we can’t strip javascript: from the start of the href.
<a href="<%= user_data %>">Click me</a>The main concern with inline ERB support was making sure you couldn’t unintentionally interpolate unescaped user data with #{} interpolation. Our solution to this is to only support the definition of ERB snippets at the class level where it’s very unlikely any user data will be in scope.
The correct way to output user data is with <%= %> tags, though it can’t be as safe as regular Phlex output because it is string-based, not structural.
PRs
- [EXPERIMENTAL] Add support for ERB snippets and sidecar templates by @joeldrapper in #867
Full Changelog: 2.1.0...2.1.1
Contributors
Assets 2
2.1.0
Highlights
- Building CSVs is now faster and we deprecated
view_templateforrow_templateinPhlex::CSVviews. - You can now use CDATA sections in
Phlex::SVGcomponents with the newcdatamethod. Phlex is no longer a “leaky abstraction”. - There’s a new
json_escapehelper available onPhlex::HTMLandPhlex::SVGcomponents for escaping JSON inside JavaScript strings..
PRs
- Add delimiter override option for CSVs by @evenreven in #865
- Add VERSION to autoloads by @paul in #869
- Support calculated buffers by @joeldrapper in #871
- Add JSON escape helper to Phlex::SGML by @joeldrapper in #872
- Add support for CDATA sections in SVGs by @joeldrapper in #873
- Ensure HTML output by @joeldrapper in #864
- Faster CSVs by @joeldrapper in #866
New Contributors
- @evenreven made their first contribution in #865
- @paul made their first contribution in #869
Full Changelog: 2.0.2...2.1.0
Contributors
Assets 2
2.0.2
What's Changed
If you try to access context before the component starts being rendered (e.g. from your initializer), it will now raise a helpful error message. This is non-breaking because it was always raising an error message. The previous error message was that it couldn’t find the method user_context on nil.
Full Changelog: 2.0.1...2.0.2
2.0.1
What's Changed
This non-breaking release fixes a regression that meant the render? predicate was called before the context was set. This meant an error would be raised if you called out to a helper in the render? method.
Full Changelog: 2.0.0...2.0.1
2.0.0
What's Changed
Many things [updated releases notes coming soon.]
New Contributors
- @alexanderadam made their first contribution in #722
- @ElMassimo made their first contribution in #737
- @bquorning made their first contribution in #742
- @AnthonySuper made their first contribution in #746
- @Xanderwot made their first contribution in #755
Full Changelog: 1.11.0...2.0.0
Contributors
Assets 2
2.0.0.rc1
Merge branch 'main' of https://github.com/phlex-ruby/phlex
1.11.0
What's Changed
Phlex::Kitis no longer experimental! 🎉- Improved the way
Phlex::Kitloads constants when a components’ method is called prior to the constant being loaded. - Improved the deprecation warning when defining the
templatemethod. The warning now tells you which class to fix. - We now warn on double-render and the use of non standard
idattributes
PRs
- Fix component kit autoload order bug by @joeldrapper in #729
- Warn on double render by @Vagab in #735
- warn on non-symbolic and non-lowercase :id by @Vagab in #741
Full Changelog: 1.10.3...1.11.0