Lexicon Garden

org.hyperboards.board

Configuration record for a hyperboard, wrapping an underlying activity or collection with visual presentation settings. Stored in the creator's PDS.

Repository @hyperboards.org did:plc:g3j5fjrhhlfqepq4ncswzhhb namespace authority
Details · record, key tid
Kindrecord
Record keytid
Authorityhyperboards.org
Indexed
Compare Edit in builder → Fork →

Record

record · key tid

Properties

config

ref

Board-level visual configuration (background, colors, aspect ratio).

Reference

contributorConfigs

array

Per-contributor configuration entries for this board.

  • maxLength: 1000
itemsref
Reference

createdAt

requiredstring · datetime

Client-declared timestamp when this record was originally created.

signatures

ref

Optional cryptographic signatures attesting to this record's content.

Reference

subject

requiredref

Reference to the org.hypercerts.claim.activity or org.hypercerts.collection this board visualizes.

Reference

#boardConfig

object

Visual configuration for a hyperboard's background, colors, and layout.

Properties

aspectRatio

string

Display aspect ratio of the board.

  • maxLength: 10
  • knownValues: 16:9 | 4:3 | 1:1

backgroundColor

string

Background color as a hex string (e.g. '#ffffff').

  • maxLength: 20

backgroundGrayscale

boolean

Whether the background is rendered in grayscale. Default: true.

backgroundIframeUrl

string · uri

URI of the background iframe.

  • maxLength: 2048

backgroundImage

union

Background image as a URI or image blob.

One of

backgroundOpacity

integer

Background opacity as a percentage (0–100).

  • minimum: 0
  • maximum: 100

backgroundType

string

Type of background content.

  • maxLength: 10
  • knownValues: image | iframe

borderColor

string

Border color as a hex string (e.g. '#000000').

  • maxLength: 20

grayscaleImages

boolean

Whether contributor images are rendered in grayscale. Default: false.

imageShape

string

Shape used to crop contributor images on this board.

  • maxLength: 20
  • knownValues: circular | square

#contributorConfig

object

Configuration for a specific contributor within a board. Values serve as fallbacks when the contributor has not defined them on their profile. It can also be used to override contributor settings on this board without changing their global profile.

Properties

contributor

requiredunion

Identifies the contributor being styled. A strong reference to an org.hypercerts.claim.contributorInformation record, or a contributorIdentity (DID or identifier string) for contributors without a dedicated record.

One of

displayName

string

Display name for this contributor on this board.

  • maxLength: 640
  • maxGraphemes: 64

hoverIframeUrl

string · uri

Iframe overlay shown when hovering over this contributor.

  • maxLength: 2048

hoverImage

union

Image overlay shown when hovering over this contributor, as a URI or image blob.

One of

image

union

Avatar or face image for this contributor on this board, as a URI or image blob.

One of

override

boolean

When true, these values take precedence over the contributor's own profile and display settings. When false or omitted, they are only used as fallbacks if the contributor has not set their own settings.

url

string · uri

Click-through link URL for this contributor.

  • maxLength: 2048

video

union

Video for this contributor, as a URI (embed/direct link) or uploaded video blob.

One of

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • org.hyperboards.displayProfile

    record

    User-declared visual presentation defaults for how a contributor appears on hyperboards. Stored in the contributor's own PDS and reusable across multiple boards.