You are here

Home » API reference » Ajax facets 7.3

README.txt in Ajax facets 7.3

Same filename and directory in other branches
  1. 7 README.txt
  2. 7.2 README.txt
--------------------------------------------------------------------------------
  ajax_facets module Readme
  https://www.drupal.org/project/ajax_facets
--------------------------------------------------------------------------------

Contents:
=========
1. ABOUT
2. INSTALLATION
3. REQUIREMENTS
4. CONFIGURATION
5. MODES OF WORK
6. CREDITS

1. ABOUT
========

This module allows you to create facet filters which working by AJAX.
Filters and search results will be updated by AJAX.

Widgets:

Ajax range slider
Ajax multiple checkboxes
Ajax selectbox
Ajax links

2. INSTALLATION
===============

Install as usual, see http://drupal.org/node/70151 for further information.
Contact me with any questions.

3. REQUIREMENTS
===============

This module requires:
Module views - http://drupal.org/project/views
Module facetapi - http://drupal.org/project/facetapi
Module search_api - http://drupal.org/project/search_api

This module was well tested with modules search_api_solr and search_api_db

4. CONFIGURATION
================

Can be a lot of cases, how to configure and use this module.
But the simplest way is the next:
1. Install modules search_api, facetapi, search_api_solr/search_api_db and search_api_views
2. Create and configure Search server in Drupal.
3. Create Search Index, configure it. Add some fields into index and select few of them as facets.
  Select one of four ajax widgets for your facets. Enable option "Update results by ajax" for your facet.
4. Create view based on your search index. Fastest way is select type of display "Page".
  Setting "Access" should be configured for your views display if you want to use them with ajax facets.
  It shouldn't have value "none". Otherwise, user will receive error "Search results cannot be filtered, please
  contact site administrator." each time, when he would try to filter results.
  Also, you should enable Ajax for your views display.
5. Put block of your facet on the page where will be placed your view with search results.
  Important - view should be processed earlier than facet block will be rendered. Otherwise facets will not work.
6. Put "Ajax facets block" block on the page if you want to have buttons "Reset all facets" and "Submit all facets".

Module has integration with HTML5 browser history API. If you want to get this feature work for HTML4 browsers
you should install libraries module (https://www.drupal.org/project/libraries)
and download history.js (https://github.com/browserstate/history.js) library.

5. MODES OF WORK
================
Mode of immediate updating of the results - enabled by default.
When you will put blocks of the ajax facets on the page with search results,
but do not put the block with ajax facets buttons, the facets will be updated immediately.

Mode of updating by demand - disabled by default.
If you will put blocks of the ajax facets and block with ajax facets buttons on the page with search results,
the facets will be updated right after any filtering. But search results will be updated only after
 the click on the button "Submit all facets".

6. CREDITS
==========

Project page: http://drupal.org/project/ajax_facets

Maintainers:
Eugene Ilyin - https://www.drupal.org/user/1767626

File

README.txt
View source 
  1. --------------------------------------------------------------------------------

  2.   ajax_facets module Readme

  3.   https://www.drupal.org/project/ajax_facets

  4. --------------------------------------------------------------------------------

  5. 

  6. Contents:

  7. =========

  8. 1. ABOUT

  9. 2. INSTALLATION

  10. 3. REQUIREMENTS

  11. 4. CONFIGURATION

  12. 5. MODES OF WORK

  13. 6. CREDITS

  14. 

  15. 1. ABOUT

  16. ========

  17. 

  18. This module allows you to create facet filters which working by AJAX.

  19. Filters and search results will be updated by AJAX.

  20. 

  21. Widgets:

  22. 

  23. Ajax range slider

  24. Ajax multiple checkboxes

  25. Ajax selectbox

  26. Ajax links

  27. 

  28. 2. INSTALLATION

  29. ===============

  30. 

  31. Install as usual, see http://drupal.org/node/70151 for further information.

  32. Contact me with any questions.

  33. 

  34. 3. REQUIREMENTS

  35. ===============

  36. 

  37. This module requires:

  38. Module views - http://drupal.org/project/views

  39. Module facetapi - http://drupal.org/project/facetapi

  40. Module search_api - http://drupal.org/project/search_api

  41. 

  42. This module was well tested with modules search_api_solr and search_api_db

  43. 

  44. 4. CONFIGURATION

  45. ================

  46. 

  47. Can be a lot of cases, how to configure and use this module.

  48. But the simplest way is the next:

  49. 1. Install modules search_api, facetapi, search_api_solr/search_api_db and search_api_views

  50. 2. Create and configure Search server in Drupal.

  51. 3. Create Search Index, configure it. Add some fields into index and select few of them as facets.

  52.   Select one of four ajax widgets for your facets. Enable option "Update results by ajax" for your facet.

  53. 4. Create view based on your search index. Fastest way is select type of display "Page".

  54.   Setting "Access" should be configured for your views display if you want to use them with ajax facets.

  55.   It shouldn't have value "none". Otherwise, user will receive error "Search results cannot be filtered, please

  56.   contact site administrator." each time, when he would try to filter results.

  57.   Also, you should enable Ajax for your views display.

  58. 5. Put block of your facet on the page where will be placed your view with search results.

  59.   Important - view should be processed earlier than facet block will be rendered. Otherwise facets will not work.

  60. 6. Put "Ajax facets block" block on the page if you want to have buttons "Reset all facets" and "Submit all facets".

  61. 

  62. Module has integration with HTML5 browser history API. If you want to get this feature work for HTML4 browsers

  63. you should install libraries module (https://www.drupal.org/project/libraries)

  64. and download history.js (https://github.com/browserstate/history.js) library.

  65. 

  66. 5. MODES OF WORK

  67. ================

  68. Mode of immediate updating of the results - enabled by default.

  69. When you will put blocks of the ajax facets on the page with search results,

  70. but do not put the block with ajax facets buttons, the facets will be updated immediately.

  71. 

  72. Mode of updating by demand - disabled by default.

  73. If you will put blocks of the ajax facets and block with ajax facets buttons on the page with search results,

  74. the facets will be updated right after any filtering. But search results will be updated only after

  75.  the click on the button "Submit all facets".

  76. 

  77. 6. CREDITS

  78. ==========

  79. 

  80. Project page: http://drupal.org/project/ajax_facets

  81. 

  82. Maintainers:

  83. Eugene Ilyin - https://www.drupal.org/user/1767626