family.pardy.familytime.card.defs

pardy.at

Documentation

binding object

No description available.

Properties

path string Optional

JSON pointer.

maxLength: 300 bytes
source string Required

A source name, or $item in a list template.

maxLength: 64 bytes
View raw schema 
{
  "properties": {
    "path": {
      "description": "JSON pointer.",
      "maxLength": 300,
      "type": "string"
    },
    "source": {
      "description": "A source name, or $item in a list template.",
      "maxLength": 64,
      "type": "string"
    }
  },
  "required": [
    "source"
  ],
  "type": "object"
}
gestures object

Touch gesture → action name. Tap works without scripts; the rest come from the app's shared script.

Properties

doubleTap string Optional

No description available.

maxLength: 64 bytes
drop string Optional

No description available.

maxLength: 64 bytes
longPress string Optional

No description available.

maxLength: 64 bytes
tap string Optional

No description available.

maxLength: 64 bytes
View raw schema 
{
  "description": "Touch gesture → action name. Tap works without scripts; the rest come from the app's shared script.",
  "properties": {
    "doubleTap": {
      "maxLength": 64,
      "type": "string"
    },
    "drop": {
      "maxLength": 64,
      "type": "string"
    },
    "longPress": {
      "maxLength": 64,
      "type": "string"
    },
    "tap": {
      "maxLength": 64,
      "type": "string"
    }
  },
  "type": "object"
}
heading object

Big text, with optional smaller text under it.

Properties

bind object Optional

Bound properties replace literal ones.

grow integer Optional

Share of a row's width.

minimum: 0maximum: 12
id string Optional

Names the block in action intents. Required on items that answer gestures.

maxLength: 64 bytes
size string Optional

No description available.

Known values: small
subtext string Optional

No description available.

maxLength: 200 bytes
text string Optional

No description available.

maxLength: 200 bytes
when ref #binding Optional

Only show the block when this binding is truthy.

View raw schema 
{
  "description": "Big text, with optional smaller text under it.",
  "properties": {
    "bind": {
      "description": "Bound properties replace literal ones.",
      "properties": {
        "subtext": {
          "ref": "#binding",
          "type": "ref"
        },
        "text": {
          "ref": "#binding",
          "type": "ref"
        }
      },
      "type": "object"
    },
    "grow": {
      "description": "Share of a row's width.",
      "maximum": 12,
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "description": "Names the block in action intents. Required on items that answer gestures.",
      "maxLength": 64,
      "type": "string"
    },
    "size": {
      "knownValues": [
        "small"
      ],
      "type": "string"
    },
    "subtext": {
      "maxLength": 200,
      "type": "string"
    },
    "text": {
      "maxLength": 200,
      "type": "string"
    },
    "when": {
      "description": "Only show the block when this binding is truthy.",
      "ref": "#binding",
      "type": "ref"
    }
  },
  "type": "object"
}
item object

An icon and text. Answers touch gestures with actions sent to the host.

Properties

accepts string Optional

The kind of dragged item this accepts (with on.drop).

maxLength: 32 bytes
bind object Optional

Bound properties replace literal ones.

color string Optional

No description available.

maxLength: 64 bytes
drag string Optional

Makes the item draggable; names the kind of thing it is.

maxLength: 32 bytes
grow integer Optional

Share of a row's width.

minimum: 0maximum: 12
icon string Optional

No description available.

maxLength: 32 bytes
id string Optional

Names the block in action intents. Required on items that answer gestures.

maxLength: 64 bytes
image string Optional

A picture from this app's own image paths (event photos, theme art); shown instead of the icon. Outside URLs are ignored.

maxLength: 300 bytes
level integer Optional

For look "meter".

minimum: 0maximum: 100
look string Optional

No description available.

Known values: sticker, face, tile, slot, chip, banner, clock, yes, no, back, swatch, meter, countdown, face-big, together, goal, claim
on ref #gestures Optional

No description available.

status string Optional

No description available.

Known values: pending, done, selected, error
subtext string Optional

No description available.

maxLength: 200 bytes
text string Optional

No description available.

maxLength: 200 bytes
value string Optional

Sent with the item's gestures.

maxLength: 1000 bytes
when ref #binding Optional

Only show the block when this binding is truthy.

View raw schema 
{
  "description": "An icon and text. Answers touch gestures with actions sent to the host.",
  "properties": {
    "accepts": {
      "description": "The kind of dragged item this accepts (with on.drop).",
      "maxLength": 32,
      "type": "string"
    },
    "bind": {
      "description": "Bound properties replace literal ones.",
      "properties": {
        "color": {
          "ref": "#binding",
          "type": "ref"
        },
        "icon": {
          "ref": "#binding",
          "type": "ref"
        },
        "image": {
          "ref": "#binding",
          "type": "ref"
        },
        "level": {
          "ref": "#binding",
          "type": "ref"
        },
        "look": {
          "ref": "#binding",
          "type": "ref"
        },
        "marks": {
          "ref": "#binding",
          "type": "ref"
        },
        "status": {
          "ref": "#binding",
          "type": "ref"
        },
        "subtext": {
          "ref": "#binding",
          "type": "ref"
        },
        "text": {
          "ref": "#binding",
          "type": "ref"
        },
        "value": {
          "ref": "#binding",
          "type": "ref"
        }
      },
      "type": "object"
    },
    "color": {
      "maxLength": 64,
      "type": "string"
    },
    "drag": {
      "description": "Makes the item draggable; names the kind of thing it is.",
      "maxLength": 32,
      "type": "string"
    },
    "grow": {
      "description": "Share of a row's width.",
      "maximum": 12,
      "minimum": 0,
      "type": "integer"
    },
    "icon": {
      "maxLength": 32,
      "type": "string"
    },
    "id": {
      "description": "Names the block in action intents. Required on items that answer gestures.",
      "maxLength": 64,
      "type": "string"
    },
    "image": {
      "description": "A picture from this app's own image paths (event photos, theme art); shown instead of the icon. Outside URLs are ignored.",
      "maxLength": 300,
      "type": "string"
    },
    "level": {
      "description": "For look \"meter\".",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "look": {
      "knownValues": [
        "sticker",
        "face",
        "tile",
        "slot",
        "chip",
        "banner",
        "clock",
        "yes",
        "no",
        "back",
        "swatch",
        "meter",
        "countdown",
        "face-big",
        "together",
        "goal",
        "claim"
      ],
      "type": "string"
    },
    "on": {
      "ref": "#gestures",
      "type": "ref"
    },
    "status": {
      "knownValues": [
        "pending",
        "done",
        "selected",
        "error"
      ],
      "type": "string"
    },
    "subtext": {
      "maxLength": 200,
      "type": "string"
    },
    "text": {
      "maxLength": 200,
      "type": "string"
    },
    "value": {
      "description": "Sent with the item's gestures.",
      "maxLength": 1000,
      "type": "string"
    },
    "when": {
      "description": "Only show the block when this binding is truthy.",
      "ref": "#binding",
      "type": "ref"
    }
  },
  "type": "object"
}
list object

Repeats the template for each element of a bound array; the element is the source $item.

Properties

empty string Optional

No description available.

maxLength: 200 bytes
emptyIcon string Optional

No description available.

maxLength: 32 bytes
grow integer Optional

Share of a row's width.

minimum: 0maximum: 12
id string Optional

Names the block in action intents. Required on items that answer gestures.

maxLength: 64 bytes
items ref #binding Required

No description available.

layout string Optional

No description available.

Known values: stack, row, grid
when ref #binding Optional

Only show the block when this binding is truthy.

View raw schema 
{
  "description": "Repeats the template for each element of a bound array; the element is the source $item.",
  "properties": {
    "empty": {
      "maxLength": 200,
      "type": "string"
    },
    "emptyIcon": {
      "maxLength": 32,
      "type": "string"
    },
    "grow": {
      "description": "Share of a row's width.",
      "maximum": 12,
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "description": "Names the block in action intents. Required on items that answer gestures.",
      "maxLength": 64,
      "type": "string"
    },
    "items": {
      "ref": "#binding",
      "type": "ref"
    },
    "layout": {
      "knownValues": [
        "stack",
        "row",
        "grid"
      ],
      "type": "string"
    },
    "template": {
      "items": {
        "refs": [
          "family.pardy.familytime.card.defs#stack",
          "family.pardy.familytime.card.defs#row",
          "family.pardy.familytime.card.defs#section",
          "family.pardy.familytime.card.defs#heading",
          "family.pardy.familytime.card.defs#list",
          "family.pardy.familytime.card.defs#item"
        ],
        "type": "union"
      },
      "maxLength": 20,
      "type": "array"
    },
    "when": {
      "description": "Only show the block when this binding is truthy.",
      "ref": "#binding",
      "type": "ref"
    }
  },
  "required": [
    "items",
    "template"
  ],
  "type": "object"
}
moduleSource object

Computed by the card's own module.

This object has no properties defined.

View raw schema 
{
  "description": "Computed by the card's own module.",
  "properties": {},
  "type": "object"
}
row object

Children side by side, wrapping.

Properties

grow integer Optional

Share of a row's width.

minimum: 0maximum: 12
id string Optional

Names the block in action intents. Required on items that answer gestures.

maxLength: 64 bytes
when ref #binding Optional

Only show the block when this binding is truthy.

View raw schema 
{
  "description": "Children side by side, wrapping.",
  "properties": {
    "blocks": {
      "items": {
        "refs": [
          "family.pardy.familytime.card.defs#stack",
          "family.pardy.familytime.card.defs#row",
          "family.pardy.familytime.card.defs#section",
          "family.pardy.familytime.card.defs#heading",
          "family.pardy.familytime.card.defs#list",
          "family.pardy.familytime.card.defs#item",
          "family.pardy.familytime.card.defs#slot"
        ],
        "type": "union"
      },
      "maxLength": 50,
      "type": "array"
    },
    "grow": {
      "description": "Share of a row's width.",
      "maximum": 12,
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "description": "Names the block in action intents. Required on items that answer gestures.",
      "maxLength": 64,
      "type": "string"
    },
    "when": {
      "description": "Only show the block when this binding is truthy.",
      "ref": "#binding",
      "type": "ref"
    }
  },
  "type": "object"
}
section object

A titled group.

Properties

aside string Optional

No description available.

maxLength: 100 bytes
bind object Optional

Bound properties replace literal ones.

grow integer Optional

Share of a row's width.

minimum: 0maximum: 12
id string Optional

Names the block in action intents. Required on items that answer gestures.

maxLength: 64 bytes
title string Optional

No description available.

maxLength: 100 bytes
when ref #binding Optional

Only show the block when this binding is truthy.

View raw schema 
{
  "description": "A titled group.",
  "properties": {
    "aside": {
      "maxLength": 100,
      "type": "string"
    },
    "bind": {
      "description": "Bound properties replace literal ones.",
      "properties": {
        "aside": {
          "ref": "#binding",
          "type": "ref"
        },
        "title": {
          "ref": "#binding",
          "type": "ref"
        }
      },
      "type": "object"
    },
    "blocks": {
      "items": {
        "refs": [
          "family.pardy.familytime.card.defs#stack",
          "family.pardy.familytime.card.defs#row",
          "family.pardy.familytime.card.defs#section",
          "family.pardy.familytime.card.defs#heading",
          "family.pardy.familytime.card.defs#list",
          "family.pardy.familytime.card.defs#item",
          "family.pardy.familytime.card.defs#slot"
        ],
        "type": "union"
      },
      "maxLength": 50,
      "type": "array"
    },
    "grow": {
      "description": "Share of a row's width.",
      "maximum": 12,
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "description": "Names the block in action intents. Required on items that answer gestures.",
      "maxLength": 64,
      "type": "string"
    },
    "title": {
      "maxLength": 100,
      "type": "string"
    },
    "when": {
      "description": "Only show the block when this binding is truthy.",
      "ref": "#binding",
      "type": "ref"
    }
  },
  "type": "object"
}
slot object

Where the board's own cards go (filled by the host).

Properties

name string Optional

No description available.

Known values: home.top, home.bottom
View raw schema 
{
  "description": "Where the board's own cards go (filled by the host).",
  "properties": {
    "name": {
      "knownValues": [
        "home.top",
        "home.bottom"
      ],
      "type": "string"
    }
  },
  "type": "object"
}
source object

No description available.

Properties

name string Required

No description available.

maxLength: 64 bytes
View raw schema 
{
  "properties": {
    "name": {
      "maxLength": 64,
      "type": "string"
    },
    "ref": {
      "refs": [
        "#viewSource",
        "#moduleSource"
      ],
      "type": "union"
    }
  },
  "required": [
    "name",
    "ref"
  ],
  "type": "object"
}
stack object

Children top to bottom.

Properties

grow integer Optional

Share of a row's width.

minimum: 0maximum: 12
id string Optional

Names the block in action intents. Required on items that answer gestures.

maxLength: 64 bytes
when ref #binding Optional

Only show the block when this binding is truthy.

View raw schema 
{
  "description": "Children top to bottom.",
  "properties": {
    "blocks": {
      "items": {
        "refs": [
          "family.pardy.familytime.card.defs#stack",
          "family.pardy.familytime.card.defs#row",
          "family.pardy.familytime.card.defs#section",
          "family.pardy.familytime.card.defs#heading",
          "family.pardy.familytime.card.defs#list",
          "family.pardy.familytime.card.defs#item",
          "family.pardy.familytime.card.defs#slot"
        ],
        "type": "union"
      },
      "maxLength": 50,
      "type": "array"
    },
    "grow": {
      "description": "Share of a row's width.",
      "maximum": 12,
      "minimum": 0,
      "type": "integer"
    },
    "id": {
      "description": "Names the block in action intents. Required on items that answer gestures.",
      "maxLength": 64,
      "type": "string"
    },
    "when": {
      "description": "Only show the block when this binding is truthy.",
      "ref": "#binding",
      "type": "ref"
    }
  },
  "type": "object"
}
viewSource object

A view the app computes for the screen.

Properties

day integer Optional

No description available.

minimum: 0maximum: 1
mine boolean Optional

No description available.

view string Required

No description available.

Known values: board, weather, day, members, subject, ideas, pending, activity, slots, screen, themes, countdowns, focus, highlight, together, stars, give
View raw schema 
{
  "description": "A view the app computes for the screen.",
  "properties": {
    "day": {
      "maximum": 1,
      "minimum": 0,
      "type": "integer"
    },
    "mine": {
      "type": "boolean"
    },
    "view": {
      "knownValues": [
        "board",
        "weather",
        "day",
        "members",
        "subject",
        "ideas",
        "pending",
        "activity",
        "slots",
        "screen",
        "themes",
        "countdowns",
        "focus",
        "highlight",
        "together",
        "stars",
        "give"
      ],
      "type": "string"
    }
  },
  "required": [
    "view"
  ],
  "type": "object"
}

Lexicon Garden

@