administrate_filterable

管理自訂過濾器

一個管理插件，用於將自訂過濾器新增到索引頁。該濾鏡將呈現為畫布外元件，因此它不會在索引頁上佔用太多空間。深受 ActiveAdmin 濾鏡的啟發。

為什麼需要這個？

我們一致認為，管理團隊在預設搜尋或過濾功能方面做得非常出色。它已經支援多個搜尋字段和關係表搜尋。它很容易自訂（例如啟用/停用搜尋、定義自訂搜尋欄位等）。

但我發現有一些缺點：

1. 由於它使用單一搜尋框，因此其背後的搜尋過程相當繁重。它將搜尋模型的所有屬性，如果資料很多，它會更慢。
2. 同樣，由於它搜尋所有屬性，因此很難搜尋特定屬性。例如，如果您有registration_status和employment_status ，並且您只想搜尋「active」註冊狀態，您將獲得所有「active」記錄，包括就業狀態。
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中建立檔案。然後只需將預設模板中的內容複製並貼上到此處並進行修改以滿足您的需求。

資產管道

如果您使用資產管道，則需要在app/assets/config/manifest.js檔案中包含此 gem 的資產：

 // ... 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部分來新增篩選器按鈕，因此如果您在模型儀表板中將所有可搜尋屬性設為 false，它可能不會顯示。因此，請確保您至少有一個可搜尋屬性來顯示篩選器按鈕。

我使用部分的原因是因為：

1. 它很少被用戶覆蓋，因此在大多數情況下您不必手動添加按鈕。
2. 以前，我使用了_index_header.html.erb部分，但它與 administrate_exportable 中的匯出按鈕衝突。由於部分覆蓋，使用這兩個寶石會導致缺少一個按鈕。

待辦事項

要讓這顆寶石變得更好，還有很多事情要做。以下是其中的一些（按優先順序最高的順序排列）：

• 新增對關係過濾器的支援（例如透過belongs_to關聯進行過濾等）
• 新增支援自訂下拉清單（例如新增prompt選項、新增include_blank選項等）
• 如果沒有對它們執行任何操作，則從篩選器參數中排除複選框、單選或選擇值
• 找出更好的方法來實現過濾器功能（目前我重寫了scoped_resource方法）
• 找出一種更好的方法將過濾器屬性傳遞到表單（目前我在重寫的scoped_resource方法中使用實例變數）
• 添加自訂過濾器行為的功能（例如，透過完全匹配搜尋、透過部分匹配搜尋等，就像在 ActiveAdmin 過濾器中一樣）
• 改善切換按鈕的使用者體驗（例如新增開啟/關閉動畫、新增動態開啟/關閉標題等）

如果您有任何想法或建議，請透過建立問題或拉取請求讓我知道。

貢獻

您可以透過為這個專案做出貢獻來幫助我改進這個 gem。非常感謝任何幫助。

1. 分叉此儲存庫並建立拉取請求
2. 請測試您的程式碼： bundle exec rspec
3. 如果需要，請記錄您的代碼

執照

麻省理工學院許可證

製作人員

非常感謝以下資源在創建這個寶石時為我提供了很多幫助：

• administrate_exportable：我只是從這個 gem 複製並貼上程式碼並修改它以滿足我的需要，如果您需要從管理中匯出數據，強烈推薦。
• Off-Canvas 選單：當我尋找一種創建 Off-canvas 過濾器元件的方法時，我從 Google Images 中找到了這段程式碼。我對其進行了一些修改以滿足我的需要。但CodePen似乎不再可用，所以我把存檔版本放在這裡。如果你們當中有人知道原作者，請告訴我，以便我給予適當的認可。