Difference between revisions of "Favorite Users Module"
| Line 1: | Line 1: | ||
| − | |||
| − | The | + | The Favorite Users Module displays a list of users who've added the listing being viewed to their favorites list. |
| − | + | If enabled, the module will display user avatars together with their names. The module works with avatars from EasySocial, JomSocial or Community Builder. | |
| + | The Favorite Users Module should be enabled only for listing detail pages. | ||
| − | + | '''Example of the module layout:''' | |
| − | [[File: | + | [[File:favorite-users-module.png]] |
| − | + | ||
| − | + | ||
| + | == Favorite Users Module Parameters == | ||
| − | + | [[File:favorite-users-module-params1.png]] | |
| − | + | '''JReviews Theme Suffix''' - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs. | |
| − | + | ||
| − | + | ||
| − | + | '''Only users with avatars''' - users that haven't uploaded their custom avatars will be hidden. | |
| − | + | ||
| − | + | [[File:favorite-users-module-params2.png]] | |
| − | + | ||
| − | + | '''Positioning of Pagination''' - choose the position of slider arrows when the module has multiple slider pages. | |
| − | *''' | + | |
| + | '''Page Transition''' - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect). | ||
| + | |||
| + | '''Enable Slideshow''' - if enabled, the module will automatically advance slider pages. | ||
| + | |||
| + | '''Slideshow Interval (sec.)''' - time between pages in seconds. | ||
| + | |||
| + | '''Max. number of results''' - total number of results that will be displayed. | ||
| + | |||
| + | '''Results per page''' - how many results will be displayed per slider page. If you enter the same number as for ''Max. number of results'', then the module slider will be disabled and all results will be displayed at once. | ||
| + | |||
| + | '''Number of columns''' - choose how many results per row to show. | ||
| + | |||
| + | == Customizing the Favorite Users Module == | ||
| + | |||
| + | If you want to customize the theme file of the Favorite Users Module, this is its default location: | ||
| + | |||
| + | *<span style="color: blue">/com_jreviews/jreviews/views/themes/default/modules/favorite_users.thtml</span> | ||
| + | |||
| + | Before you start customizing the theme files, make sure you read about [[JReviews Code Overrides]] functionality and create a custom theme. | ||
| + | |||
| + | You can create multiple custom copies of the Favorite Users Module theme file and enter their suffixes in the '''Theme Suffix''' parameter. Remember to clear JReviews File Registry when creating new theme files. | ||
| Line 31: | Line 49: | ||
[[Category:JReviews]] | [[Category:JReviews]] | ||
[[Category:Community]] | [[Category:Community]] | ||
| + | [[Category:Favorites]] | ||
[[Category:Modules]] | [[Category:Modules]] | ||
Latest revision as of 14:18, 9 January 2014
The Favorite Users Module displays a list of users who've added the listing being viewed to their favorites list.
If enabled, the module will display user avatars together with their names. The module works with avatars from EasySocial, JomSocial or Community Builder.
The Favorite Users Module should be enabled only for listing detail pages.
Example of the module layout:
Favorite Users Module Parameters
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
Only users with avatars - users that haven't uploaded their custom avatars will be hidden.
Positioning of Pagination - choose the position of slider arrows when the module has multiple slider pages.
Page Transition - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).
Enable Slideshow - if enabled, the module will automatically advance slider pages.
Slideshow Interval (sec.) - time between pages in seconds.
Max. number of results - total number of results that will be displayed.
Results per page - how many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.
Number of columns - choose how many results per row to show.
Customizing the Favorite Users Module
If you want to customize the theme file of the Favorite Users Module, this is its default location:
- /com_jreviews/jreviews/views/themes/default/modules/favorite_users.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Favorite Users Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.