administrate_filterable

Administrer le filtre personnalisé

Un plugin d'administration pour ajouter un filtre personnalisé à votre page d'index. Le filtre sera rendu en tant que composant hors canevas, il ne prendra donc pas trop de place sur votre page d'index. Fortement inspiré du filtre d'ActiveAdmin.

Pourquoi as-tu besoin de ça ?

Admettons que l'équipe d'administration a fait un excellent travail avec la fonctionnalité de recherche ou de filtrage par défaut. Il prend déjà en charge plusieurs champs de recherche et recherches de tables relationnelles. Il est facile à personnaliser (comme activer/désactiver la recherche, définir des champs de recherche personnalisés, etc.).

Mais j'ai trouvé quelques inconvénients :

1. Puisqu’il utilise un seul champ de recherche, le processus de recherche derrière celui-ci est assez lourd. Il recherchera tous les attributs du modèle, et ce sera plus lent si vous disposez de beaucoup de données.
2. Encore une fois, comme il recherche tous les attributs, il sera difficile de rechercher un attribut spécifique. Par exemple, si vous disposez registration_status et employment_status et que vous souhaitez rechercher uniquement le statut d'inscription « actif », vous obtiendrez tous les enregistrements « actifs », y compris le statut d'emploi.
3. Ce n'est pas convivial lorsqu'il s'agit d'une liste de recherche définie (par exemple une liste déroulante). L'utilisateur devra saisir la valeur manuellement, ce qui n'est pas bon pour l'expérience utilisateur.

Veuillez partager vos réflexions si vous avez d'autres raisons.

Exigences

• Version Ruby on Rails >= 5.0
• Administrer la version >= 0.2.2

Installation

Ajoutez administrate_filterable à votre Gemfile :

 gem 'administrate_filterable'

Et puis exécutez :

 $ bundle install

Ou bien, exécutez simplement :

 $ bundle add administrate_filterable

Usage

Activer le filtre

Pour chaque ressource à laquelle vous souhaitez ajouter un filtre personnalisé, ajoutez respectivement la ligne suivante à leur contrôleur d'administration.

 include AdministrateFilterable :: Filterer

Exemple:

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

  # ...
end

Personnalisation des champs de filtre

Par défaut, tous les attributs de COLLECTION_ATTRIBUTES seront affichés sous forme de champs de filtre. Vous pouvez remplacer cela en ajoutant FILTER_ATTRIBUTES au fichier du tableau de bord de votre administration.

Exemple ( app/dashboards/user_dashboard.rb ) :

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

Personnalisation du modèle de filtre

Il est possible de personnaliser le modèle de filtre (par exemple en changeant l'icône du bouton de filtre, etc.). Vous pouvez le faire en remplaçant le modèle par défaut dans votre application, créez simplement un nouveau fichier appelé _index_filter.html.erb dans le dossier de ressources souhaité.

Par exemple, si vous souhaitez remplacer le modèle de filtre pour la ressource users , vous devez créer le fichier dans app/views/admin/users/_index_filter.html.erb . Ensuite, copiez et collez simplement le contenu du modèle par défaut ici et modifiez-le en fonction de vos besoins.

Pipeline d'actifs

Si vous utilisez un pipeline d'actifs, vous devez inclure les actifs de cette gem dans votre fichier app/assets/config/manifest.js :

 // ... other code here ...

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

Exécutez rails assets:precompile si les actifs ne sont pas chargés.

Dépannage

Modèle de recherche par défaut remplacé

Par défaut, cette gemme ajoutera un bouton de filtre à views/admin/application/_search.html.erb partiel. Mais si vous avez remplacé ce partiel dans votre application, vous pouvez ajouter le bouton manuellement en ajoutant la ligne suivante :

 <%= render 'index_filter' %>

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

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

<%= render 'index_filter' %>

Méthode scoped_resource remplacée

Cette gemme utilise la méthode scoped_resource pour filtrer les ressources en remplaçant son comportement par défaut. Si, par hasard, vous remplacez également cette méthode dans votre contrôleur d'application, vous remplacerez également la fonctionnalité de filtre et cela ne fonctionnera pas.

Pour résoudre ce problème, vous devez ajouter le code suivant dans la dernière ligne de votre méthode scoped_resource remplacée :

 filtered_resources ( your_scoped_resource )

Par exemple:

 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

Le bouton de filtre ne s'affiche pas

Étant donné que j'utilise le partiel _search.html.erb pour ajouter le bouton de filtre, il se peut qu'il ne s'affiche pas si vous définissez tous les attributs de recherche sur false dans le tableau de bord du modèle. Assurez-vous donc d'avoir au moins un attribut consultable pour faire apparaître le bouton de filtre.

La raison pour laquelle j'utilise le partiel est parce que :

1. Il est rarement remplacé par l'utilisateur, vous n'aurez donc pas besoin d'ajouter le bouton manuellement dans la plupart des cas.
2. Auparavant, j'utilisais le partiel _index_header.html.erb , mais il entre en conflit avec le bouton d'exportation d'administrate_exportable. L'utilisation des deux gemmes entraîne l'absence d'un bouton, en raison de la substitution partielle.

Faire

Il y a encore beaucoup de choses à faire pour améliorer ce joyau. En voici quelques-uns (triés par priorité la plus élevée) :

• Ajouter la prise en charge du filtre relationnel (par exemple filtrer par association belongs_to , etc.)
• Ajouter un support pour personnaliser la liste déroulante (par exemple, ajouter une option prompt , ajouter une option include_blank , etc.)
• Excluez la case à cocher, la radio ou sélectionnez une valeur dans les paramètres de filtre si aucune action n'est effectuée sur eux
• Trouvez une meilleure façon d'implémenter la fonctionnalité de filtre (actuellement, je remplace la méthode scoped_resource )
• Trouvez une meilleure façon de transmettre les attributs du filtre au formulaire (actuellement, j'utilise une variable d'instance dans la méthode scoped_resource remplacée)
• Ajoutez la possibilité de personnaliser le comportement du filtre (par exemple, recherche par correspondance exacte, recherche par correspondance partielle, etc., tout comme dans le filtre ActiveAdmin)
• Améliorer l'expérience utilisateur du bouton bascule (par exemple, ajouter une animation d'ouverture/fermeture, ajouter un titre d'ouverture/fermeture dynamique, etc.)

Si vous avez des idées ou des suggestions, faites-le-moi savoir en créant un problème ou une pull request.

Contribuer

Vous pouvez m'aider à améliorer ce joyau en contribuant à ce projet. Toute aide est très appréciée.

1. Forkez ce dépôt et créez une pull request
2. Veuillez tester votre code : bundle exec rspec
3. Veuillez documenter votre code si nécessaire

Licence

Licence MIT

Crédits

Un grand merci pour les ressources suivantes qui m'ont beaucoup aidé dans la création de ce joyau :

• administrate_exportable : je copie et colle simplement le code de cette gemme et je le modifie en fonction de mes besoins, fortement recommandé si vous devez exporter vos données depuis Administrate.
• Menu hors toile : j'ai trouvé ce code sur Google Images lorsque je cherchais un moyen de créer un composant de filtre hors toile. Je l'ai un peu modifié pour l'adapter à mes besoins. Mais il semble que le CodePen ne soit plus disponible, j'ai donc mis la version archivée ici. Si l'un d'entre vous connaît l'auteur original, merci de me le faire savoir afin que je puisse lui attribuer le crédit approprié.