RatingItem

Item displaying a star rating.

Rating is determined by the value of the configured field. A max rating can be configured using the max config.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

editor : String/Objectnull

Widget type or config to use as the editor for this item. Used in the inline task editor.

RatingItems are un-editable by default.

max : Number

Max rating.

const taskBoard = new TaskBoard({
   bodyItems : {
      grade : { type : 'ratingitem', max : 5 }
   },

   project : {
       tasks : [
           { id : 1, name : 'Task #1', grade : 3 }
       ]
   }
});

// Card for task #1 will render 3 full stars and 2 faded,
// for a total of 5 stars

Properties

Properties are getters/setters or publicly accessible variables on this class

isRatingItem : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of RatingItem class, or subclass thereof.

isRatingItem : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of RatingItem class, or subclass thereof.

CSS variables

CSS variables that can be set to adjust appearance

Name	Description
--b-task-board-rating-item-color	Unfilled rating item color
--b-task-board-rating-item-filled-color	Filled rating item color

type: rating

Source path

TaskBoard/view/item/RatingItem.js

RatingItem

Configs

Properties

CSS variables

Source path

Inheritance tree2

Contents