turbo-ruby's Introduction

Turbo::Ruby

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add turbo-ruby

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install turbo-ruby

Note: Usage in Rails

In order to use turbo-ruby in Rails with the Rails render method you have to install the phlex-rails gem in your app.

Regular Element

# Ruby
Turbo::Elements::TurboStream.new(action: "console_log", message: "Hello World").to_html

<!-- Rails -->
<%= render Turbo::Elements::TurboStream.new(action: "console_log", message: "Hello World") %>

Blocks

# Ruby
Turbo::Elements::TurboStream.new(action: "morph", target: "post_1") do
  %(<div id="post_id">
      <h1>Post 1</h1>
    </div>)
end.to_html

<!-- Rails -->
<%= render Turbo::Elements::TurboStream.new(action: "morph", target: "post_1") do %>
  <div id="post_id">
    <h1>Post 1</h1>
  </div>
<% end %>

Partials (Rails only)

<!-- Rails -->
<%= render Turbo::Elements::TurboStream.new(action: "morph", target: "post_1", view_context: self, partial: "posts/post", locals: { post: @post } %>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/turbo-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Turbo::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

turbo-ruby's People

Contributors

Stargazers

Watchers

turbo-ruby's Issues

Implement `Turbo::Elements::TurboFrame`

Introduce a `StreamsBuilder` class

Something like:

Turbo::StreamsBuilder.render do |turbo_stream|
  turbo_stream.append(...)
  turbo_stream.console_log(...)
  turbo_stream.morph(...)
end

Which would return one string like:

<turbo-stream action="append" ...>...</turbo-stream>
<turbo-stream action="console_log" ...>...</turbo-stream>
<turbo-stream action="morph" ...>...</turbo-stream>

or inside a model:

class Post < ApplicationRecord
  broadcast_turbo_stream_actions do |turbo_stream|
    turbo_stream.append(...)
    turbo_stream.console_log(...)
    turbo_stream.morph(...)
  end
end

Extract `**rendering` attributes in `Turbo::Elements::TurboStream`

Currently a Turbo::Elements::TurboStream element takes arbitrary attributes which get rendered on the element via the attributes keyword. The **rendering splat is used for taking in arguments for rendering partials.

Ideally the splat can be used for arbitrary attributes which get rendered on the element. We could extract the attributes needed for rendering out of the splat or we explicitly define the required attributes for rendering as keyword arguments.

Recommend Projects

marcoroth / turbo-ruby Goto Github PK