administrate_filterable

Administrar filtro personalizado

Un complemento de administración para agregar un filtro personalizado a su página de índice. El filtro se representará como un componente fuera del lienzo, por lo que no ocupará demasiado espacio en su página de índice. Altamente inspirado en el filtro de ActiveAdmin.

¿Por qué necesitas esto?

Aceptemos que el equipo de Administración ha hecho un gran trabajo con la función de búsqueda o filtro predeterminada. Ya admite múltiples campos de búsqueda y búsquedas en tablas relacionales. Es fácil de personalizar (como habilitar/deshabilitar la búsqueda, definir campos de búsqueda personalizados, etc.).

Pero hay algunos inconvenientes que encontré:

1. Dado que utiliza un único cuadro de búsqueda, el proceso de búsqueda detrás de él es bastante pesado. Buscará todos los atributos del modelo y será más lento si tiene muchos datos.
2. Nuevamente, debido a que busca todos los atributos, será difícil buscar un atributo específico. Por ejemplo, si tiene registration_status y employment_status y desea buscar solo el estado de registro "activo", obtendrá todos los registros "activos", incluido el estado laboral.
3. No es fácil de usar cuando se trata de una lista de búsqueda definida (por ejemplo, lista desplegable). El usuario tendrá que escribir el valor manualmente y no es bueno para la experiencia del usuario.

Comparta sus pensamientos si tiene otras razones.

Requisitos

• Versión de Ruby on Rails >= 5.0
• Administrar versión >= 0.2.2

Instalación

Agregue administrate_filterable a su Gemfile:

 gem 'administrate_filterable'

Y luego ejecuta:

 $ bundle install

O simplemente ejecute:

 $ bundle add administrate_filterable

Uso

Habilitar el filtro

Para cada recurso al que desee agregar un filtro personalizado, agregue la siguiente línea a su controlador de administración, respectivamente.

 include AdministrateFilterable :: Filterer

Ejemplo:

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

  # ...
end

Personalizando los campos de filtro

De forma predeterminada, todos los atributos de COLLECTION_ATTRIBUTES se representarán como campos de filtro. Puede anular esto agregando FILTER_ATTRIBUTES al archivo del panel de administración.

Ejemplo ( app/dashboards/user_dashboard.rb ):

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

Personalizando la plantilla de filtro

Es posible personalizar la plantilla de filtro (por ejemplo, cambiar el icono del botón de filtro, etc.). Puede hacer esto anulando la plantilla predeterminada en su aplicación, simplemente cree un nuevo archivo llamado _index_filter.html.erb en la carpeta de recursos que desee.

Por ejemplo, si desea anular la plantilla de filtro para el recurso users , debe crear el archivo en app/views/admin/users/_index_filter.html.erb . Luego simplemente copie y pegue el contenido de la plantilla predeterminada aquí y modifíquelo para adaptarlo a sus necesidades.

Canalización de activos

Si utiliza una canalización de activos, debe incluir los activos de esta gema en su archivo app/assets/config/manifest.js :

 // ... other code here ...

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

Ejecute rails assets:precompile si los activos no están cargados.

Solución de problemas

Plantilla de búsqueda predeterminada anulada

De forma predeterminada, esta gema agregará un botón de filtro a views/admin/application/_search.html.erb parcial. Pero si ha anulado ese parcial en su aplicación, puede agregar el botón manualmente agregando la siguiente línea:

 <%= render 'index_filter' %>

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

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

<%= render 'index_filter' %>

Método scoped_resource anulado

Esta gema utiliza el método scoped_resource para filtrar los recursos anulando su comportamiento predeterminado. Si por casualidad también anula este método en el controlador de su aplicación, también anulará la funcionalidad del filtro y no funcionará.

Para solucionar este problema, debe agregar el siguiente código en la última línea de su método scoped_resource anulado:

 filtered_resources ( your_scoped_resource )

Por ejemplo:

 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

El botón de filtro no se muestra

Dado que uso el parcial _search.html.erb para agregar el botón de filtro, es posible que no se muestre si cambia todos los atributos de búsqueda a falso en el panel del modelo. Así que asegúrese de tener al menos un atributo de búsqueda para que aparezca el botón de filtro.

La razón por la que uso el parcial es porque:

1. El usuario rara vez lo anula, por lo que no tendrá que agregar el botón manualmente en la mayoría de los casos.
2. Anteriormente, usé el parcial _index_header.html.erb , pero entra en conflicto con el botón de exportación de administrate_exportable. Al usar ambas gemas, falta un botón debido a la anulación parcial.

Hacer

Todavía quedan muchas cosas por hacer para mejorar esta joya. Éstos son algunos de ellos (ordenados primero por mayor prioridad):

• Agregue soporte para el filtro relacional (por ejemplo, filtro por asociación belongs_to , etc.)
• Agregue soporte para personalizar la lista desplegable (por ejemplo, agregue la opción prompt , agregue la opción include_blank , etc.)
• Excluir casilla de verificación, radio o valor de selección de los parámetros de filtro si no se realiza ninguna acción sobre ellos
• Encuentre una mejor manera de implementar la funcionalidad de filtro (actualmente anulo el scoped_resource )
• Encuentre una mejor manera de pasar los atributos de filtro al formulario (actualmente uso una variable de instancia en el método scoped_resource anulado)
• Agregue capacidad para personalizar el comportamiento del filtro (por ejemplo, búsqueda por coincidencia exacta, búsqueda por coincidencia parcial, etc., como en el filtro ActiveAdmin)
• Mejorar la experiencia del usuario del botón de alternancia (por ejemplo, agregar animación de apertura/cierre, agregar título dinámico de apertura/cierre, etc.)

Si tiene alguna idea o sugerencia, hágamelo saber creando un problema o una solicitud de extracción.

Contribuyendo

Puedes ayudarme a mejorar esta joya contribuyendo a este proyecto. Cualquier ayuda es muy apreciada.

1. Bifurca este repositorio y crea una solicitud de extracción
2. Pruebe su código: bundle exec rspec
3. Por favor documente su código si es necesario

Licencia

Licencia MIT

Créditos

Muchas gracias por los siguientes recursos que me ayudaron mucho a crear esta joya:

• administrate_exportable: Simplemente copio y pego el código de esta joya y lo modifico para adaptarlo a mis necesidades, muy recomendable si necesitas exportar tus datos desde Administrar.
• Menú fuera del lienzo: encontré este código en Google Imágenes cuando buscaba una manera de crear un componente de filtro fuera del lienzo. Lo modifiqué un poco para adaptarlo a mis necesidades. Pero parece que CodePen ya no está disponible, así que puse la versión archivada aquí. Si alguno de ustedes conoce al autor original, hágamelo saber para poder darle el crédito correspondiente.