You are here

Home » API reference » Fivestar 8

fivestar.schema.yml in Fivestar 8

config/schema/fivestar.schema.yml

File

config/schema/fivestar.schema.yml
View source 
  1. field.value.fivestar:

  2.   type: mapping

  3.   label: 'Default value'

  4.   mapping:

  5.     rating:

  6.       type: integer

  7.       label: 'Star rating'

  8.     target:

  9.       type: integer

  10.       label: 'Target ID'

  11. 

  12. field.field_settings.fivestar:

  13.   type: mapping

  14.   label: 'Fivestar field settings'

  15.   mapping:

  16.     stars:

  17.       type: integer

  18.       label: 'Number of stars'

  19.     allow_clear:

  20.       type: boolean

  21.       label: 'Allow users to cancel their ratings'

  22.     allow_revote:

  23.       type: boolean

  24.       label: 'Allow users to re-vote on already voted content'

  25.     allow_ownvote:

  26.       type: boolean

  27.       label: 'Allow users to vote on their own content'

  28.     rated_while:

  29.       type: string

  30.       label: 'Select when rating is allowed: "viewing" or "editing"'

  31.     enable_voting_target:

  32.       type: boolean

  33.       label: 'Set voting target'

  34.     target_bridge_field:

  35.       type: string

  36.       label: 'Machine name of entity reference field that binds the current entity with the entity that contain target fivestar field'

  37.     target_fivestar_field:

  38.       type: string

  39.       label: 'Machine name of the fivestar field which should affect after vote.'

  40. 

  41. field.storage_settings.fivestar:

  42.   type: mapping

  43.   label: 'Fivestar field storage settings'

  44.   mapping:

  45.     vote_type:

  46.       type: string

  47.       label: 'Fivestar vote type'

  48. 

  49. field.formatter.settings.fivestar_stars:

  50.   type: mapping

  51.   label: 'Fivestar field formatter settings'

  52.   mapping:

  53.     text_format:

  54.       type: string

  55.       label: 'Text format'

  56.     display_format:

  57.       type: string

  58.       label: 'Display format'

  59.     fivestar_widget:

  60.       type: string

  61.       label: 'Widget ID'

  62. 

  63. field.widget.settings.fivestar_stars:

  64.   type: mapping

  65.   label: 'Fivestar field widget settings'

  66.   mapping:

  67.     text_format:

  68.       type: string

  69.       label: 'Text format'

  70.     display_format:

  71.       type: string

  72.       label: 'Display format'

  73.     fivestar_widget:

  74.       type: string

  75.       label: 'Widget ID'