Scale Intelligence■ Docs
Docs / The model / PlatformReveal

PlatformReveal.

One control on a kind of page that shows more without leaving it, or leads to the page that holds the rest: what a person clicks, what opens, where what opens is drawn from (the page's own data, another page of the domain, an API object the click calls, or nothing kept), the fields and lists read inside it, and…

Figure 1PlatformRevealspecified
PLATFORMREVEALvalue at none scopea page of the domainpagetextthe control's label as the platform shows it, such as Show all or N reactionstriggertexthow the reader finds the controlselectortextoptionalopensenum:dialog|menu|expanded|page|vie…where what opens is drawn fromsourceenum:the page|a page|an API object…the page or API object of the domain, when the source is onesource_nametextoptionalread inside what opens, when it is drawn from the pagefields[FieldSpec]the lists what opens carries, such as the people who reactedlists[PlatformList]needsenum:anyone|signed in|connected|me…notetextoptionalFIELDSPECthrough fieldsPLATFORMLISTthrough lists
PlatformReveal is a value at none scope. The drawing shows its fields and the objects that they point at.
kind
value
scope
none
key
none
store
none
family
sources

Fields#

fieldtyperequirednote
pagetextyesa page of the domain
triggertextyesthe control’s label as the platform shows it, such as Show all or N reactions
selectortextnohow the reader finds the control
opensone of dialog | menu | expanded | page | vieweryes
sourceone of the page | a page | an API object | noneyeswhere what opens is drawn from
source_nametextnothe page or API object of the domain, when the source is one
fieldsFieldSpecyesread inside what opens, when it is drawn from the page
listsPlatformListyesthe lists what opens carries, such as the people who reacted
needsone of anyone | signed in | connected | member | admin | premium | licensedyes
notetextno

Routes that use it#

No route takes or returns PlatformReveal directly. The record holds it, and the objects that point at it reach it.