devot:eeDevoted to ExpressionEngine

Star:EE allows you to easily style a star rating system on your channel entries. You are not limited to a particular number for your ratings and you are able to style the stars to your own liking so that they can match your site’s design.

Use Star:EE to capture how users feel about your site’s content at a glance. We left out a control panel page and focused on usable features for designers and developers instead. Tweak the output of Star:EE statistics to work with any format you need for your project. Don’t get limited with a “one style fits all” solution.

USAGE

At its’ core, Star:EE is simple to initiate. You just drop the tag in and pass your {entry_id}.

The Star:EE Form

 
• Star:EE Form: {exp:staree:form}
         
  • Parameters:
                 
    • entry_id - Required - This is the only required parameter.
                 
    • site_id - Allows you to use Star:EE on multiple sites.
                 
    • form_id - Allows you to provide a form ID attribute to the Star:EE form.
                 
    • form_class - Allows you to provide a form Class attribute to the Star:EE form.
                 
    • allow_duplicates - By default this is set to false. If you would like to allow multiple submissions by the same visitor, you can change this to true.
                 
    • add_styles - By default this is set to true. Use this when you include the styles using the {exp:staree:staree_style} tag to add your CSS elsewhere.
                 
    • add_script - By default this is set to true. This tag allows you to keep the javascript from being loaded. Use this when you include the javascript using the {exp:staree:staree_script} tag to add your javascript elsewhere.
                 
    • size - Options: [blank=normal] | mini | small | giant - Allows you to modify the size of the form (stars) being displayed.
                 
    • stars - By default, Star:EE is set to a 5 star rating system. You may change this here by entering any number you wish.
                 
    • color - Star:EE comes pre-styled but this option allows you to add a hex value color that you would like to display data with. The subtle drop shadows and hover states are auto-magically created based off of your hex input provided here.
                 
    • shadows - By default this is set to true. Star:EE comes pre-styled with drop shadow stars. However, if your site is a flat design, simply change this to false and you will be flat as a pancake.
                 
    • clear - By default this is set to true as the row of stars auto clears. If you would like to run the form in-line, you may set this flag to false.
                 
    • show_messages - By default this is set to true. Star:EE displays detailed error messages and a Success message. You may set this to false if you wish to not see these or you can specify your messages using the error_message and success_message parameters.
                 
    • error_message - Allows you to provide a custom error message to display if something goes wrong. This field accepts a string argument. eg: OOPS! Something went wrong.
                 
    • success_message - Allows you to provide a custom success message to display when finished. eg: Thanks!
                 
    • limit_user - By default this is set to false. Setting this to true will require a membership and for that member to be logged in for them to vote.
                 
    • limit_ip - By default this is set to false. Setting this to true will require a valid IP address in order to vote.
             

The Star:EE Style Tag

The Star:EE style tag allows you to add the required styles to your template for the module. This is handy if you would like to use multiple Star:EE tags or simply want to add it to the head of your document.

 
• Star:EE Style: {exp:staree:staree_style}
         
  • Parameters:
                 
    • shadows - Like the shadows parameter for the {exp:staree:form} tag, you can change the stars to render as a flat design by changing this to false.
                 
    • color - Like the color parameter for the {exp:staree:form} tag, you can specify a custom hex color for your Star:EE implementation.
                 
    • NOTE: If you add a custom color this tag outputs the entire stylesheet link. If you use it without a color, it will just render the path.
                 
    • {exp:staree:staree_style} will output (actual_path)
                 
    • {exp:staree:staree_style color="#0089cf"} will output <link rel="stylesheet" type="text/css" href="actual_path">
             

The Star:EE Script Tag

The Star:EE script tag allows you to add the required javascript to your template for the module. This is handy if you would like to render the script tags in the head/footer of your document.

 
• Star:EE Script: {exp:staree:staree_script}
         
  • Parameters:
                 
    • NA - If you use this script output tag then you must set the add_script parameter to false in the {exp:staree:form} tag.
             

The Star:EE Rate Count Tag

The Star:EE rate count tag allows you to output the number of times an entry_id had been rated.

 
• Star:EE Rate Count: {exp:staree:rate_count}
         
  • Parameters:
                 
    • entry_id (Required) - You must pass in the entry_id of the item you want the count for.
             

The Star:EE Rate Average Tag

The Star:EE rate average tag allows you to output the numeric rating of an entry_id that you specify.

 
• Star:EE Rate Average: {exp:staree:rate_avg}
         
  • Parameters:
                 
    • entry_id (Required) - You must pass in the entry_id of the item you want the rating for.
             

The Star:EE Average Stars Tag

The Star:EE average stars tag allows you to output the visual rating of an entry_id that you specify in stars.

 
• Star:EE Average Stars: {exp:staree:avg_stars}
         
  • Parameters:
                 
    • entry_id (Required) - You must pass in the entry_id of the item you want the rating for.
                 
    • add_styles - By default this is set to true. You must set this to false if you have already added the styles for Star:EE in an earlier usage.
                 
    • color - Like the color parameter for the {exp:staree:form} tag, you can specify a custom hex color for your Star:EE implementation.
                 
    • shadows - Like the shadows parameter for the {exp:staree:form} tag, you can change the stars to render as a flat design by changing this to false.
                 
    • stars - Like the {exp:staree:form} tag, Star:EE is, by default, a 5 stars rating system. You may change this here to match your rating if you changed your rating count initially.