Add customizable indicator arrows #726
Conversation
garettarrowood
force-pushed
the
add-customizable-arrows
branch
from
db55961 to
a03cb4e
Compare
garettarrowood
force-pushed
the
add-customizable-arrows
branch
from
a03cb4e to
c8a256a
Compare
|
Sorry about the extra CI builds. Just realized it's been running a few times as I appended the documentation. Tried to log in and stop the last one to no avail. I'll be sure to include the [skip ci] option should a need to alter any documentation again. |
|
|
||
| ### Added | ||
|
|
||
| * Add config option to customize up and down arrows used for direction indicators in the FormHelper. PR [#726](https://github.com/activerecord-hackery/ransack/pull/726) |
There was a problem hiding this comment.
Can you please wrap at 80 characters in the source file?
| @@ -213,8 +213,18 @@ The sort link may be displayed without the order indicator arrow by passing | |||
| <%= sort_link(@q, :name, hide_indicator: true) %> | |||
| ``` | |||
|
|
|||
| Alternatively, all sort links may be displayed without the order indicator arrow | |||
| by adding this to an initializer file like `config/initializers/ransack.rb`: | |||
| These indicator arrows may also be customized by setting them in an initializer file like `config/initializers/ransack.rb`: | |||
| end | ||
| ``` | ||
|
|
||
| Alternatively, all sort links may be displayed without the order indicator arrows: |
| # like `config/initializers/ransack.rb` as follows: | ||
| # | ||
| # Ransack.configure do |config| | ||
| # # Set the up_arrow as an icon, set the down arrow as unicode |
There was a problem hiding this comment.
For line 86, I'd suggest # # Set the up arrow as an icon, and the down arrow as unicode.
(Note: "up arrow" written as text instead of in snakecase)
| end | ||
|
|
||
| def down_arrow | ||
| '▲'.freeze | ||
| Ransack.options[:down_arrow] | ||
| end |
There was a problem hiding this comment.
I originally extracted these 2 public arrow methods out from the private method #order_indicator to allow developers to set custom arrows by overloading them.
Now that developers can do it with a config setting, I'm not sure there is any reason to keep them as separate public methods. Performance-wise it would be better to inline them.
WDYT?
There was a problem hiding this comment.
Oh, except if anyone is actually overloading these methods now, their apps will break. Never mind 😄
|
@garettarrowood The changes were so minor that let's just merge this in and I'll do a mini-cleanup. Thanks again for the clean PR with tests. |
|
@jonatack Cool! Thank you for the merge and cleaning up those comments/docs. |
|
@garettarrowood Thanks again for your contribution! |
TODO: Avoid cloning and restoring Ransack.options in each test.
|
Great refactoring and additions to the tests. I enjoyed reviewing your edits. |
|
Thanks @garettarrowood. I'm a bit bothered by all the tests duplicated for the two adapters. Code bloat. Probably should be fixed. |
This addition allows users to pass in their own up and down arrows. The default arrows remain the same. The user can pass in just one arrow, or both arrows.
Functionality is hand-tested with a codebase in production. Please let me know if you'd like any edits.