Skip to content

Updating README to add examples for view helpers #262

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.

Sign up for GitHub

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 1 commit into from
Nov 4, 2017
Merged

Updating README to add examples for view helpers #262

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ a file inside the `config/initializers` directory.
#### Using view helpers

Sometimes you'll need to use view helper methods like `link_to`, `h`, `mailto`,
`edit_resource_path` in the returned JSON representation returned by the `data`
`edit_resource_path`, `check_box_tag` in the returned JSON representation returned by the `data`
method.

To have these methods available to be used, this is the way to go:
Expand All @@ -558,22 +558,46 @@ class MyCustomDatatable < AjaxDatatablesRails::Base
def_delegator :@view, :mail_to

# or define them in one pass
def_delegators :@view, :link_to, :h, :mailto, :edit_resource_path, :other_method
def_delegators :@view, :link_to, :h, :mailto, :edit_resource_path, :check_box_tag, :other_method

# Define columns as described above for `id`, `first_name`, `email`, and others
def view_columns
...
end

# now, you'll have these methods available to be used anywhere
# example: mapping the 2d jsonified array returned.
def data
records.map do |record|
{
id: check_box_tag('users[]', record.id),
first_name: link_to(record.fname, edit_resource_path(record)),
email: mail_to(record.email),
email: mail_to(record.email)
# other attributes
}
end
end
end
```

If you want to keep things tidy in the data mapping method, you could use
[Draper](https://github.com/drapergem/draper) to define column mappings like below.

```ruby
...
def data
records.map do |record|
{
id: record.decorate.id,
first_name: record.decorate.first_name,
email: record.decorate.email
# other attributes
}
end
end
...
```


#### Options

Expand Down