Render progress of a desired element or progress of a custom goal.
Common Attributes:
- from – Choose from progress will be calculated. Accepts:
points_type
,points
,achievement_type
,achievement
,rank_type
,rank
,current_rank
- current_user – Show progress of current logged in user. Default:
yes
- user_id – Show progress of a specific user.
Progress of a specific points type (from=”points_type”)
Setting from attribute to points_type will render the progress of the given points type.
Note: Points type selected requires to have setup a progress.
Attributes:
- points_type – The points type to render the progress from. Accepts: Any registered points type slug.
- Doesn’t requires progress style attributes since points type has configured his own progress style.
Example: [gamipress_progress from="points_type" points_type="credits"]
Progress based on a points amount (from=”points”)
Setting from attribute to points will render the progress of the user points balance compared with the given points amount of the specific points type you want.
Attributes:
- points – The points goal amount. Default:
100
- points_type – The points type of points amount. Accepts: Any registered points type slug.
- Accepts progress style attributes
Example: [gamipress_progress from="points" points="100" points_type="credits"]
Progress based on achievements earned of a type (from=”achievement_type”)
Setting from attribute to achievement_type will render the progress of the user earned achievements compared with all achievements available of the specific type you want.
Attributes:
- achievement_type – The achievement type to base progress. Accepts: Any registered achievement type slug.
- Accepts progress style attributes
Example: [gamipress_progress from="achievement_type" achievement_type="badges"]
Progress of a specific achievement (from=”achievement”)
Setting from attribute to achievement will render the progress of the given achievement.
Note: Achievement selected requires to have setup a progress.
Attributes:
- achievement – The achievement ID to render the progress from.
- Doesn’t requires progress style attributes since achievement has configured his own progress style.
Example: [gamipress_progress from="achievement" achievement="123"]
Progress based on current rank of a type (from=”rank_type”)
Setting from attribute to rank_type will render the progress of the user rank compared with all ranks available of the specific type you want.
Attributes:
- rank_type – The rank type to base progress. Accepts: Any registered rank type slug.
- Accepts progress style attributes
Example: [gamipress_progress from="rank_type" rank_type="levels"]
Progress of a specific rank (from=”rank”)
Setting from attribute to rank will render the progress of the given rank.
Note: Rank selected requires to have setup a progress.
Attributes:
- rank – The rank ID to render the progress from.
- Doesn’t requires progress style attributes since rank has configured his own progress style.
Example: [gamipress_progress from="rank" rank="123"]
Progress of user current rank (from=”current_rank”)
Setting from attribute to current_rank will render the progress of the user current rank.
Note: The rank requires to have setup a progress.
Attributes:
- rank_type – The rank type to base progress. Accepts: Any registered rank type slug.
- Doesn’t requires progress style attributes since rank has configured his own progress style.
Example: [gamipress_progress from="current_rank" rank_type="levels"]
Style attributes
[gamipress_progress] has support to render progress based on custom goals like a specific points amount or achievements earned.
For that, this shortcode includes style attributes to setup the progress style (text, bar, radial bar or images).
Common Style Attributes:
- type – Setup the progress type to display. Accepts:
text
,bar
,radial-bar
,image
Default:text
Text Style Attributes (type=”text”):
Attributes:
- text_pattern – Available template tags:
{current}
– Current progress
{total}
– Total progress Default:({current}/{total})
Bar Style Attributes (type=”bar”):
Attributes:
- bar_color – Color for the progress bar. Default:
#0098d7
- bar_background_color – Background color for the progress bar. Default:
#eeeeee
- bar_text – Add a progress text with progression percent or fraction. Accepts:
yes
,no
Default:no
- bar_text_color – Color for the progress bar text. Default:
#fff
- bar_text_format – Progress text format. Accepts:
percent
,fraction
Default:percent
- bar_stripe – Add stripe effect to the progress bar. Accepts:
yes
,no
Default:no
- bar_animate – Animate stype effect. Accepts:
yes
,no
Default:no
Radial Bar Style Attributes (type=”radial-bar”):
Attributes:
- radial_bar_color – Color for the radial bar. Default:
#0098d7
- radial_bar_background_color – Background color for the radial bar. Default:
#eeeeee
- radial_bar_text – Add a progress text with progression percent or fraction. Accepts:
yes
,no
Default:no
- radial_bar_text_color – Color for the radial bar text. Default:
#000
- radial_bar_text_format – Progress text format. Accepts:
percent
,fraction
Default:percent
- radial_bar_text_background_color – Background color for the radial bar text. Default:
#fff
- radial_bar_size – Maximum dimensions for the radial bar. Default:
100
Image Style Attributes (type=”image”):
Attributes:
- image_complete – Complete image URL.
- image_incomplete – Incomplete image URL.
- image_complete_width – Maximum width for the complete image. Default:
50
- image_complete_height – Maximum height for the complete image. Default:
50
- image_incomplete_width – Maximum width for the incomplete image. Default:
50
- image_incomplete_height – Maximum height for the incomplete image. Default:
50