administrate_filterable

Benutzerdefinierten Filter verwalten

Ein Verwaltungs-Plugin zum Hinzufügen eines benutzerdefinierten Filters zu Ihrer Indexseite. Der Filter wird als Off-Canvas-Komponente gerendert, sodass er nicht zu viel Platz auf Ihrer Indexseite einnimmt. Stark inspiriert vom Filter von ActiveAdmin.

Warum brauchen Sie das?

Wir sind uns einig, dass das Team der Verwaltung mit der standardmäßigen Such- oder Filterfunktion hervorragende Arbeit geleistet hat. Es unterstützt bereits mehrere Suchfelder und relationale Tabellensuchen. Es lässt sich leicht anpassen (z. B. die Suche aktivieren/deaktivieren, benutzerdefinierte Suchfelder definieren usw.).

Es gibt jedoch einige Nachteile, die ich festgestellt habe:

1. Da ein einziges Suchfeld verwendet wird, ist der dahinter stehende Suchvorgang ziemlich aufwändig. Es durchsucht alle Attribute des Modells und ist langsamer, wenn Sie viele Daten haben.
2. Auch hier wird es schwierig sein, nach einem bestimmten Attribut zu suchen, da alle Attribute durchsucht werden. Wenn Sie beispielsweise über registration_status und employment_status verfügen und nur nach dem „aktiven“ Registrierungsstatus suchen möchten, erhalten Sie alle „aktiven“ Datensätze, einschließlich des Beschäftigungsstatus.
3. Es ist nicht benutzerfreundlich, wenn es um eine definierte Suchliste (z. B. Dropdown-Liste) geht. Der Benutzer muss den Wert manuell eingeben, was sich nicht positiv auf die Benutzererfahrung auswirkt.

Bitte teilen Sie uns Ihre Gedanken mit, wenn Sie andere Gründe haben.

Anforderungen

• Ruby on Rails-Version >= 5.0
• Version >= 0.2.2 verwalten

Installation

Fügen Sie administrate_filterable zu Ihrer Gemfile hinzu:

 gem 'administrate_filterable'

Und dann ausführen:

 $ bundle install

Oder führen Sie einfach Folgendes aus:

 $ bundle add administrate_filterable

Verwendung

Aktivieren Sie den Filter

Fügen Sie für jede Ressource, der Sie einen benutzerdefinierten Filter hinzufügen möchten, die folgende Zeile zu ihrem jeweiligen Administrate-Controller hinzu.

 include AdministrateFilterable :: Filterer

Beispiel:

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

  # ...
end

Anpassen der Filterfelder

Standardmäßig werden alle Attribute aus COLLECTION_ATTRIBUTES als Filterfelder gerendert. Sie können dies überschreiben, indem Sie FILTER_ATTRIBUTES zur Dashboard-Datei Ihres Administrators hinzufügen.

Beispiel ( app/dashboards/user_dashboard.rb ):

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

Anpassen der Filtervorlage

Es ist möglich, die Filtervorlage anzupassen (z. B. das Symbol der Filterschaltfläche usw. zu ändern). Sie können dies tun, indem Sie die Standardvorlage in Ihrer Anwendung überschreiben. Erstellen Sie einfach eine neue Datei mit dem Namen _index_filter.html.erb in Ihrem gewünschten Ressourcenordner.

Wenn Sie beispielsweise die Filtervorlage für die users überschreiben möchten, müssen Sie die Datei in app/views/admin/users/_index_filter.html.erb erstellen. Dann kopieren Sie einfach den Inhalt aus der Standardvorlage, fügen Sie ihn hier ein und passen Sie ihn an Ihre Bedürfnisse an.

Asset-Pipeline

Wenn Sie eine Assets-Pipeline verwenden, müssen Sie die Assets dieses Gems in Ihre Datei app/assets/config/manifest.js aufnehmen:

 // ... other code here ...

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

Führen Sie rails assets:precompile aus, wenn die Assets nicht geladen sind.

Fehlerbehebung

Überschriebene Standardsuchvorlage

Standardmäßig fügt dieses Gem teilweise eine Filterschaltfläche zu views/admin/application/_search.html.erb hinzu. Wenn Sie diesen Teil jedoch in Ihrer Anwendung überschrieben haben, können Sie die Schaltfläche manuell hinzufügen, indem Sie die folgende Zeile hinzufügen:

 <%= render 'index_filter' %>

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

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

<%= render 'index_filter' %>

scoped_resource -Methode überschrieben

Dieses Gem verwendet die Methode scoped_resource um die Ressourcen zu filtern, indem es sein Standardverhalten überschreibt. Wenn Sie diese Methode zufällig auch in Ihrem Anwendungscontroller überschreiben, überschreiben Sie auch die Filterfunktionalität und es wird nicht funktionieren.

Um dies zu beheben, müssen Sie in der letzten Zeile Ihrer überschriebenen scoped_resource -Methode den folgenden Code hinzufügen:

 filtered_resources ( your_scoped_resource )

Zum Beispiel:

 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

Filterschaltfläche wird nicht angezeigt

Da ich den Teil _search.html.erb verwende, um die Filterschaltfläche hinzuzufügen, wird sie möglicherweise nicht angezeigt, wenn Sie im Modell-Dashboard alle durchsuchbaren Attribute auf „false“ setzen. Stellen Sie daher sicher, dass Sie über mindestens ein durchsuchbares Attribut verfügen, damit die Filterschaltfläche angezeigt wird.

Der Grund, warum ich den Teil verwende, ist folgender:

1. Sie wird selten vom Benutzer überschrieben, sodass Sie die Schaltfläche in den meisten Fällen nicht manuell hinzufügen müssen.
2. Zuvor habe ich den Teil _index_header.html.erb verwendet, aber er steht im Konflikt mit der Exportschaltfläche von administrate_exportable. Die Verwendung beider Edelsteine ​​führt aufgrund der teilweisen Überschreibung dazu, dass eine Schaltfläche fehlt.

Zu tun

Es gibt noch viel zu tun, um dieses Juwel zu verbessern. Hier sind einige davon (sortiert nach höchster Priorität zuerst):

• Unterstützung für den relationalen Filter hinzufügen (z. B. Filter nach belongs_to usw.)
• Fügen Sie Unterstützung zum Anpassen der Dropdown-Liste hinzu (z. B. prompt hinzufügen, include_blank Option hinzufügen usw.)
• Schließen Sie Kontrollkästchen, Radio oder ausgewählte Werte aus den Filterparametern aus, wenn keine Aktion für sie ausgeführt wird
• Finden Sie eine bessere Möglichkeit, die Filterfunktionalität zu implementieren (derzeit überschreibe ich die Methode scoped_resource ).
• Finden Sie eine bessere Möglichkeit, die Filterattribute an das Formular zu übergeben (derzeit verwende ich eine Instanzvariable in der überschriebenen Methode scoped_resource ).
• Fügen Sie die Möglichkeit hinzu, das Filterverhalten anzupassen (z. B. Suche nach exakter Übereinstimmung, Suche nach Teilübereinstimmung usw., genau wie im ActiveAdmin-Filter).
• Verbessern Sie die Benutzererfahrung der Umschalttaste (z. B. Hinzufügen einer Animation zum Öffnen/Schließen, Hinzufügen eines dynamischen Titels zum Öffnen/Schließen usw.)

Wenn Sie Ideen oder Vorschläge haben, teilen Sie mir dies bitte mit, indem Sie ein Issue oder eine Pull-Anfrage erstellen.

Mitwirken

Sie können mir helfen, dieses Juwel zu verbessern, indem Sie zu diesem Projekt beitragen. Jede Hilfe wird sehr geschätzt.

1. Forken Sie dieses Repo und erstellen Sie eine Pull-Anfrage
2. Bitte testen Sie Ihren Code: bundle exec rspec
3. Bitte dokumentieren Sie Ihren Code bei Bedarf

Lizenz

MIT-Lizenz

Credits

Vielen Dank für die folgenden Ressourcen, die mir bei der Erstellung dieses Juwels sehr geholfen haben:

• administrate_exportable: Ich kopiere einfach den Code aus diesem Gem, füge ihn ein und passe ihn an meine Bedürfnisse an. Dies ist sehr empfehlenswert, wenn Sie Ihre Daten aus Administrate exportieren müssen.
• Off-Canvas-Menü: Ich habe diesen Code von Google Bilder gefunden, als ich nach einer Möglichkeit suchte, eine Off-Canvas-Filterkomponente zu erstellen. Ich habe es ein wenig an meine Bedürfnisse angepasst. Aber es scheint, dass der CodePen nicht mehr verfügbar ist, also habe ich die archivierte Version hier eingestellt. Wenn einer von Ihnen den ursprünglichen Autor kennt, lassen Sie es mich bitte wissen, damit ich ihn gebührend würdigen kann.