administrate_filterable

จัดการตัวกรองแบบกำหนดเอง

ปลั๊กอินผู้ดูแลระบบเพื่อเพิ่มตัวกรองที่กำหนดเองลงในหน้าดัชนีของคุณ ตัวกรองจะแสดงผลเป็นองค์ประกอบนอกพื้นที่ ดังนั้นจึงไม่ใช้พื้นที่บนหน้าดัชนีของคุณมากเกินไป ได้รับแรงบันดาลใจอย่างมากจากตัวกรองของ ActiveAdmin

ทำไมคุณถึงต้องการสิ่งนี้?

ยอมรับว่าทีมผู้ดูแลระบบทำงานได้ดีมากด้วยฟังก์ชันการค้นหาหรือตัวกรองเริ่มต้น รองรับช่องค้นหาหลายช่องและการค้นหาตารางเชิงสัมพันธ์แล้ว ปรับแต่งได้ง่าย (เช่น เปิด/ปิดการค้นหา กำหนดช่องค้นหาที่กำหนดเอง ฯลฯ)

แต่ฉันพบข้อเสียบางประการ:

1. เนื่องจากมันใช้ช่องค้นหาเดียว กระบวนการค้นหาเบื้องหลังจึงค่อนข้างหนัก มันจะค้นหาคุณลักษณะทั้งหมดของโมเดล และจะช้าลงถ้าคุณมีข้อมูลจำนวนมาก
2. ขอย้ำอีกครั้ง เนื่องจากจะค้นหาคุณลักษณะทั้งหมด จึงเป็นการยากที่จะค้นหาคุณลักษณะเฉพาะเจาะจง ตัวอย่างเช่น หากคุณมี registration_status และ employment_status และคุณต้องการค้นหาเฉพาะสถานะการลงทะเบียน "ใช้งานอยู่" เท่านั้น คุณจะได้รับบันทึก "ใช้งานอยู่" ทั้งหมด รวมถึงสถานะการจ้างงานด้วย
3. มันไม่เป็นมิตรต่อผู้ใช้เมื่อพูดถึงรายการค้นหาที่กำหนดไว้ (เช่น รายการแบบเลื่อนลง) ผู้ใช้จะต้องพิมพ์ค่าด้วยตนเอง ซึ่งไม่ดีต่อประสบการณ์ผู้ใช้

โปรดแบ่งปันความคิดของคุณหากคุณมีเหตุผลอื่นใด

ความต้องการ

• Ruby on Rails เวอร์ชัน >= 5.0
• เวอร์ชันผู้ดูแลระบบ >= 0.2.2

การติดตั้ง

เพิ่ม administrate_filterable ให้กับ Gemfile ของคุณ:

 gem 'administrate_filterable'

แล้วดำเนินการ:

 $ bundle install

หรือเพียงแค่เรียกใช้:

 $ bundle add administrate_filterable

การใช้งาน

เปิดใช้งานตัวกรอง

สำหรับแต่ละทรัพยากรที่คุณต้องการเพิ่มตัวกรองแบบกำหนดเอง ให้เพิ่มบรรทัดต่อไปนี้ในตัวควบคุมการดูแลระบบตามลำดับ

 include AdministrateFilterable :: Filterer

ตัวอย่าง:

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

  # ...
end

การปรับแต่งฟิลด์ตัวกรอง

ตามค่าเริ่มต้น คุณลักษณะทั้งหมดจาก COLLECTION_ATTRIBUTES จะถูกแสดงผลเป็นฟิลด์ตัวกรอง คุณสามารถแทนที่สิ่งนี้ได้โดยเพิ่ม FILTER_ATTRIBUTES ลงในไฟล์แดชบอร์ดของผู้ดูแลระบบ

ตัวอย่าง ( app/dashboards/user_dashboard.rb ):

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

การปรับแต่งเทมเพลตตัวกรอง

คุณสามารถปรับแต่งเทมเพลตตัวกรองได้ (เช่น การเปลี่ยนไอคอนปุ่มตัวกรอง ฯลฯ) คุณสามารถทำได้โดยการแทนที่เทมเพลตเริ่มต้นในแอปพลิเคชันของคุณ เพียงสร้างไฟล์ใหม่ชื่อ _index_filter.html.erb ในโฟลเดอร์ทรัพยากรที่คุณต้องการ

ตัวอย่างเช่น หากคุณต้องการแทนที่เทมเพลตตัวกรองสำหรับทรัพยากร users คุณต้องสร้างไฟล์ใน app/views/admin/users/_index_filter.html.erb จากนั้นเพียงคัดลอกและวางเนื้อหาจากเทมเพลตเริ่มต้นที่นี่ และแก้ไขให้เหมาะกับความต้องการของคุณ

ไปป์ไลน์สินทรัพย์

หากคุณใช้ไปป์ไลน์สินทรัพย์ คุณจะต้องรวมเนื้อหาของ Gem นี้ไว้ในไฟล์ app/assets/config/manifest.js ของคุณ:

 // ... other code here ...

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

เรียกใช้ rails assets:precompile หากไม่ได้โหลดเนื้อหา

การแก้ไขปัญหา

เทมเพลตการค้นหาเริ่มต้นที่ถูกแทนที่

ตามค่าเริ่มต้น Gem นี้จะเพิ่มปุ่มตัวกรองให้กับ views/admin/application/_search.html.erb บางส่วน แต่ถ้าคุณได้แทนที่บางส่วนนั้นในแอปพลิเคชันของคุณ คุณสามารถเพิ่มปุ่มด้วยตนเองโดยเพิ่มบรรทัดต่อไปนี้:

 <%= render 'index_filter' %>

ตัวอย่าง ( app/views/admin/users/_search.html.erb ):

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

<%= render 'index_filter' %>

เมธอด scoped_resource ที่ถูกแทนที่

Gem นี้ใช้เมธอด scoped_resource เพื่อกรองทรัพยากรโดยการแทนที่พฤติกรรมเริ่มต้น หากคุณบังเอิญแทนที่วิธีนี้ในตัวควบคุมแอปพลิเคชันของคุณ คุณจะแทนที่ฟังก์ชันตัวกรองด้วย และมันจะไม่ทำงาน

ในการแก้ไขปัญหานี้ คุณต้องเพิ่มโค้ดต่อไปนี้ในบรรทัดสุดท้ายของเมธอด scoped_resource ที่ถูกแทนที่:

 filtered_resources ( your_scoped_resource )

ตัวอย่างเช่น:

 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

ปุ่มตัวกรองไม่แสดง

เนื่องจากฉันใช้ _search.html.erb บางส่วนเพื่อเพิ่มปุ่มตัวกรอง จึงอาจไม่แสดงหากคุณเปลี่ยนแอตทริบิวต์ที่ค้นหาได้ทั้งหมดเป็นเท็จในแดชบอร์ดโมเดล ดังนั้นตรวจสอบให้แน่ใจว่าคุณมีแอตทริบิวต์ที่สามารถค้นหาได้อย่างน้อยหนึ่งรายการเพื่อให้ปุ่มตัวกรองปรากฏขึ้น

เหตุผลที่ฉันใช้บางส่วนเป็นเพราะ:

1. ผู้ใช้ไม่ค่อยถูกแทนที่ ดังนั้นคุณจึงไม่จำเป็นต้องเพิ่มปุ่มด้วยตนเองในกรณีส่วนใหญ่
2. ก่อนหน้านี้ ฉันใช้ _index_header.html.erb บางส่วน แต่มันขัดแย้งกับปุ่มส่งออกจาก administrate_exportable การใช้อัญมณีทั้งสองจะทำให้ปุ่มหายไปเพียงปุ่มเดียว เนื่องจากการแทนที่บางส่วน

สิ่งที่ต้องทำ

ยังมีอีกหลายสิ่งที่ต้องทำเพื่อทำให้อัญมณีนี้ดีขึ้น นี่คือบางส่วน (เรียงตามลำดับความสำคัญสูงสุดก่อน):

• เพิ่มการสนับสนุนสำหรับตัวกรองเชิงสัมพันธ์ (เช่น ตัวกรองตามการเชื่อมโยง belongs_to ฯลฯ )
• เพิ่มการสนับสนุนเพื่อปรับแต่งรายการแบบเลื่อนลง (เช่น เพิ่มตัวเลือก prompt เพิ่มตัวเลือก include_blank ฯลฯ )
• ไม่รวมช่องทำเครื่องหมาย ตัวเลือก หรือค่าที่เลือกจากพารามิเตอร์ตัวกรอง หากไม่มีการดำเนินการใดๆ กับพารามิเตอร์เหล่านั้น
• หาวิธีที่ดีกว่าในการใช้ฟังก์ชันตัวกรอง (ปัจจุบันฉันแทนที่วิธี scoped_resource )
• หาวิธีที่ดีกว่าในการส่งแอตทริบิวต์ตัวกรองไปยังแบบฟอร์ม (ปัจจุบันฉันใช้ตัวแปรอินสแตนซ์ในเมธอด scoped_resource ที่ถูกแทนที่)
• เพิ่มความสามารถในการปรับแต่งพฤติกรรมตัวกรอง (เช่น ค้นหาด้วยการจับคู่แบบตรงทั้งหมด ค้นหาด้วยการจับคู่บางส่วน ฯลฯ เช่นเดียวกับในตัวกรอง ActiveAdmin)
• ปรับปรุงประสบการณ์ผู้ใช้ปุ่มสลับ (เช่น เพิ่มภาพเคลื่อนไหวเปิด/ปิด เพิ่มชื่อเปิด/ปิดแบบไดนามิก ฯลฯ)

หากคุณมีความคิดหรือข้อเสนอแนะใด ๆ โปรดแจ้งให้เราทราบโดยสร้างปัญหาหรือดึงคำขอ

มีส่วนร่วม

คุณสามารถช่วยฉันปรับปรุงอัญมณีนี้ได้โดยการมีส่วนร่วมในโครงการนี้ ความช่วยเหลือใด ๆ ที่ได้รับความนิยมอย่างสูง

1. แยก repo นี้และสร้างคำขอดึง
2. โปรดทดสอบโค้ดของคุณ: bundle exec rspec
3. กรุณาบันทึกรหัสของคุณหากจำเป็น

ใบอนุญาต

ใบอนุญาตเอ็มไอที

เครดิต

ขอบคุณมากสำหรับแหล่งข้อมูลต่อไปนี้ที่ช่วยฉันได้มากในการสร้างอัญมณีนี้:

• administrate_exportable: ฉันเพียงแค่คัดลอกและวางโค้ดจาก Gem นี้และแก้ไขให้เหมาะกับความต้องการของฉัน ขอแนะนำอย่างยิ่งหากคุณต้องการส่งออกข้อมูลของคุณจาก Administrate
• เมนูนอกแคนวาส: ฉันพบโค้ดนี้จาก Google Images เมื่อฉันกำลังมองหาวิธีสร้างส่วนประกอบตัวกรองนอกแคนวาส ฉันแก้ไขมันเล็กน้อยเพื่อให้เหมาะกับความต้องการของฉัน แต่ดูเหมือนว่า CodePen จะไม่มีจำหน่ายอีกต่อไป ดังนั้นฉันจึงใส่เวอร์ชันที่เก็บถาวรไว้ที่นี่ ท่านใดรู้จักผู้เขียนต้นฉบับ กรุณาแจ้งให้ผมทราบด้วยนะครับ ผมจะได้ให้เครดิตตามสมควร