Kudos card

Category: People. Tags: Recognition, Offices and workplaces, Social and audience.

Previews

Views and forms

Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.

Card views, themes and publishing. Browse the gallery.

Data and privacy

This card uses its configured properties and live card data.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

Name	Type	Default	Values and limits	Description
`title`	string	`"Kudos"`	maxLength: `30`
`pointsLabel`	string	`"pts"`	maxLength: `12`	The unit shown after points.
`rotateSec`	integer	`12`	minimum: `3`; maximum: `120`	Seconds each kudos is featured.

Dynamic properties

Name	Type	Default	Values and limits	Description
`items`	array	`[]`	maxItems: `50`	Recognitions, in any order; the newest by `at` lead the list. The card features one at a time, rotating on the wall clock.
`items[].id`	string	`""`	maxLength: `40`	Keys the kudos, so one already shown does not animate again.
`items[].to`	string		minLength: `1`; maxLength: `60`; Required	Who is recognised.
`items[].toPhoto`	string	`""`	maxLength: `120`	A media reference to the recipient's picture; empty shows their initials.
`items[].from`	string	`""`	maxLength: `60`	Who gave the kudos.
`items[].fromPhoto`	string	`""`	maxLength: `120`	A media reference to the giver's picture.
`items[].message`	string	`""`	maxLength: `240`
`items[].tag`	string	`""`	maxLength: `30`	The company value or hashtag, such as Customer first.
`items[].points`	number	`0`	minimum: `0`	Points awarded; empty or zero shows none.
`items[].at`	string	`""`	maxLength: `40`	When it was given, an ISO 8601 instant.

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "kudos",
  "primitive": "card",
  "card": "kudos",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "kudos-main"
}

Write live data

Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/kudos-main" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "ScreenRig-Project: $SCREENRIG_PROJECT" \
  --header "Content-Type: application/json" \
  --data '{"document":{"items":[]}}'