administrate_filterable

Kelola Filter Khusus

Plugin Administrate untuk menambahkan filter khusus ke halaman indeks Anda. Filter akan dirender sebagai komponen di luar kanvas, sehingga tidak akan memakan terlalu banyak ruang di halaman indeks Anda. Sangat terinspirasi oleh filter ActiveAdmin.

Mengapa Anda membutuhkan ini?

Mari kita sepakat bahwa tim Admin telah melakukan pekerjaan yang baik dengan fungsi pencarian atau filter default. Ini sudah mendukung beberapa bidang pencarian dan pencarian tabel relasional. Sangat mudah untuk menyesuaikannya (seperti mengaktifkan/menonaktifkan pencarian, menentukan bidang pencarian khusus, dll).

Namun ada beberapa kekurangan yang saya temukan:

1. Karena menggunakan kotak pencarian tunggal, proses pencarian dibaliknya cukup berat. Ini akan mencari semua atribut model, dan akan lebih lambat jika Anda memiliki banyak data.
2. Sekali lagi, karena ia mencari semua atribut, maka akan sulit untuk mencari atribut tertentu. Misalnya, jika Anda memiliki registration_status dan employment_status , dan Anda ingin mencari status pendaftaran "aktif" saja, Anda akan mendapatkan semua catatan "aktif", termasuk status pekerjaan.
3. Ini tidak ramah pengguna jika menyangkut daftar pencarian yang ditentukan (misalnya daftar dropdown). Pengguna harus mengetikkan nilainya secara manual, dan ini tidak baik untuk pengalaman pengguna.

Silakan bagikan pemikiran Anda jika Anda memiliki alasan lain.

Persyaratan

• Versi Ruby on Rails >= 5.0
• Kelola versi >= 0.2.2

Instalasi

administrate_filterable ke Gemfile Anda:

 gem 'administrate_filterable'

Dan kemudian jalankan:

 $ bundle install

Atau, jalankan saja:

 $ bundle add administrate_filterable

Penggunaan

Aktifkan filternya

Untuk setiap sumber daya yang ingin Anda tambahkan filter khusus, tambahkan baris berikut ke pengontrol Administrate masing-masing.

 include AdministrateFilterable :: Filterer

Contoh:

 class UsersController < Administrate :: ApplicationController
  include AdministrateFilterable :: Filterer

  # ...
end

Menyesuaikan bidang filter

Secara default, semua atribut dari COLLECTION_ATTRIBUTES akan dirender sebagai kolom filter. Anda dapat menimpanya dengan menambahkan FILTER_ATTRIBUTES ke file dasbor Administrate Anda.

Contoh ( app/dashboards/user_dashboard.rb ):

 class UserDashboard < Administrate :: BaseDashboard
  # ..
  FILTER_ATTRIBUTES = [
    :first_name ,
    :last_name ,
    :email ,
    :created_at
  ] . freeze
  # ..
end

Menyesuaikan templat filter

Dimungkinkan untuk menyesuaikan template filter (misalnya mengubah ikon tombol filter, dll). Anda dapat melakukan ini dengan mengganti template default di aplikasi Anda, cukup buat file baru bernama _index_filter.html.erb di folder sumber daya yang Anda inginkan.

Misalnya, jika Anda ingin mengganti template filter untuk sumber daya users , Anda perlu membuat file di app/views/admin/users/_index_filter.html.erb . Kemudian salin dan tempel konten dari template default di sini dan modifikasi sesuai kebutuhan Anda.

Saluran Aset

Jika Anda menggunakan saluran aset, Anda perlu menyertakan aset permata ini di file app/assets/config/manifest.js Anda:

 // ... other code here ...

//= link administrate_filterable/application.css
//= link administrate_filterable/application.js

Jalankan rails assets:precompile jika aset tidak dimuat.

Pemecahan masalah

Templat pencarian default diganti

Secara default, permata ini akan menambahkan tombol filter ke sebagian views/admin/application/_search.html.erb . Namun jika Anda telah mengganti sebagian itu di aplikasi Anda, Anda dapat menambahkan tombol secara manual dengan menambahkan baris berikut:

 <%= render 'index_filter' %>

Contoh ( app/views/admin/users/_search.html.erb ):

 < form class =" search " role =" search " >
  ... other code here ...
</ form >

<%= render 'index_filter' %>

Metode scoped_resource diganti

Permata ini menggunakan metode scoped_resource untuk memfilter sumber daya dengan mengesampingkan perilaku defaultnya. Jika Anda kebetulan juga mengganti metode ini di pengontrol aplikasi, Anda juga akan mengganti fungsi filter dan itu tidak akan berfungsi.

Untuk memperbaikinya, Anda perlu menambahkan kode berikut di baris terakhir metode scoped_resource yang diganti:

 filtered_resources ( your_scoped_resource )

Misalnya:

 def scoped_resource
  # Your custom filter logic here
  resources = super . where ( status : 'active' )
  # Add this line to make the filter work
  filtered_resources ( resources )
end

Tombol filter tidak muncul

Karena saya menggunakan sebagian _search.html.erb untuk menambahkan tombol filter, tombol ini mungkin tidak muncul jika Anda mengubah semua atribut yang dapat dicari menjadi false di dasbor model. Jadi, pastikan Anda memiliki setidaknya satu atribut yang dapat dicari agar tombol filter muncul.

Alasan saya menggunakan parsial adalah karena:

1. Tombol ini jarang diganti oleh pengguna, jadi dalam banyak kasus, Anda tidak perlu menambahkan tombol secara manual.
2. Sebelumnya saya menggunakan sebagian _index_header.html.erb , tetapi bertentangan dengan tombol ekspor dari administrate_exportable. Menggunakan kedua permata mengakibatkan satu tombol hilang, karena penggantian sebagian.

Yang Harus Dilakukan

Masih banyak hal yang harus dilakukan untuk menjadikan permata ini lebih baik. Berikut beberapa di antaranya (diurutkan berdasarkan prioritas tertinggi terlebih dahulu):

• Tambahkan dukungan untuk filter relasional (misalnya filter berdasarkan asosiasi belongs_to , dll)
• Tambahkan dukungan untuk menyesuaikan daftar dropdown (misalnya menambahkan opsi prompt , menambahkan opsi include_blank , dll)
• Kecualikan kotak centang, radio, atau nilai pilih dari parameter filter jika tidak ada tindakan yang dilakukan terhadapnya
• Cari tahu cara yang lebih baik untuk mengimplementasikan fungsionalitas filter (saat ini saya mengganti metode scoped_resource )
• Temukan cara yang lebih baik untuk meneruskan atribut filter ke formulir (saat ini saya menggunakan variabel instan dalam metode scoped_resource yang diganti)
• Tambahkan kemampuan untuk menyesuaikan perilaku filter (misalnya pencarian berdasarkan pencocokan tepat, pencarian berdasarkan pencocokan sebagian, dll seperti pada filter ActiveAdmin)
• Tingkatkan pengalaman pengguna tombol sakelar (misalnya, tambahkan animasi buka/tutup, tambahkan judul buka/tutup dinamis, dll)

Jika Anda memiliki ide atau saran, beri tahu saya dengan membuat masalah atau permintaan tarik.

Berkontribusi

Anda dapat membantu saya meningkatkan permata ini dengan berkontribusi pada proyek ini. Bantuan apa pun sangat dihargai.

1. Garpu repo ini dan buat permintaan tarik
2. Silakan uji kode Anda: bundle exec rspec
3. Harap dokumentasikan kode Anda jika diperlukan

Lisensi

Lisensi MIT

Kredit

Terima kasih banyak atas sumber daya berikut yang banyak membantu saya dalam membuat permata ini:

• administrate_exportable: Saya cukup menyalin dan menempelkan kode dari permata ini dan memodifikasinya sesuai kebutuhan saya, sangat disarankan jika Anda perlu mengekspor data Anda dari Administrate.
• Menu di Luar Kanvas: Saya menemukan kode ini dari Gambar Google ketika saya sedang mencari cara untuk membuat komponen filter di luar kanvas. Saya memodifikasinya sedikit agar sesuai dengan kebutuhan saya. Tapi sepertinya CodePen sudah tidak tersedia lagi, jadi saya taruh versi arsipnya di sini. Jika ada di antara Anda yang mengetahui penulis aslinya, harap beri tahu saya agar saya dapat memberikan penghargaan yang sesuai.