rails_liff

RailsLiff

RailsLiff make LIFF easy to use.

Feature

• register LIFF once and reuse to your all path.
• liff_submit event: a hook when LIFF form submit, with form data in js object format.
• liff_send_text_message: quick send message and close LIFF.

Installation

gem 'rails_liff'

login to line developers, and create 3 LIFF for 3 different size.

• for compact

  • name: Compact
  • size: Compact
  • Endpoint URL: https://yourwebsite/liff

• for tall

  • name: Tall
  • size: Tall
  • Endpoint URL: https://yourwebsite/liff

• for full

  • name: Full
  • size: Full
  • Endpoint URL: https://yourwebsite/liff

and then copy the result to enviroment parameters:

LIFF_COMPACT=line://app/for_compact_liff_id
LIFF_TALL=line://app/for_tall_liff_id
LIFF_FULL=line://app/for_full_liff_id

Usage

Implement LIFF View

RailsLiff using view format .liff, so you can reuse exists controller and model, you can create a LIFF form by only adding a new view file.

Suppose you have a resource todos, you want to create a liff form for todos/new, so you create a file app/views/todos/new.liff.erb, the content is as follows:

<% content_for :title, "new todo" %>

<%= render "todos/form.html", todo: @todo %>

<%= link_to "test", liff_path(path: '/todos/new') %>

You can test the form at localhost:3000/todos/new.liff

Generate LIFF Link

You can change any path to liff by liff_path method.

for example:

liff_path(path: '/todos/new')

You can choice the liff size by liff_size parameter. the default value of liff_size is compact.

liff_path(path: '/todos/new', liff_size: :compact)
liff_path(path: '/todos/new', liff_size: :tall)
liff_path(path: '/todos/new', liff_size: :full)

liff_path method add format :liff automatically.

Author

create by etrex

License

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