Component · StartupBuilder

Properties

Property	Type	Required	Description
`name`	`string`	required	The name a Template places it by, such as `Pricing`.
`props`	`json`	required	The schema of the props it accepts.
`region`	`string`		Where it sits: `header`, `section`, `footer`, or `notice`.
`interactive`	`boolean`		True when it runs code in the browser; it still renders a static still without it.

Object

JSON

{
  "$id": "https://api.sb/patentpad.com/components/component_1",
  "$type": "Component",
  "name": "PatentPad",
  "props": {},
  "region": "header",
  "interactive": true
}

Relationships

A Component is placed by many Templates: a Template places named Components, such as Pricing, and fills their props from records. placedBy, inverse places.
A Component is used on many Pages: a Page is assembled from Components, each filled from records. usedOn, inverse uses.

Verbs

createCreates a Component.
POST /{namespace}/componentsdoComponent.created
getReturns one Component by id.
GET /{namespace}/components/{id}readNo Event
listReturns Components, newest first, one page at a time.
GET /{namespace}/componentsreadNo Event
updateChanges the given properties of a Component.
PATCH /{namespace}/components/{id}doComponent.updated
deleteDeletes a Component; its history is kept.
DELETE /{namespace}/components/{id}doComponent.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operation	`owner`	`admin`	`member`	`viewer`
`Component.create`	Yes	Yes	Yes	No
`Component.get`	Yes	Yes	Yes	Yes
`Component.list`	Yes	Yes	Yes	Yes
`Component.update`	Yes	Yes	Yes	No
`Component.delete`	Yes	Yes	Yes	No

Call it

Text

Add a component to ShiftNote.

Example

The pricing Page of a scheduling SaaS places a Pricing Component in its main region, fed by the published Offers. Publishing a $29 team Offer adds a column on every Page that uses the Component.

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

RelationshipsCopy Anchor Link

VerbsCopy Anchor Link

PermissionsCopy Anchor Link

Call itCopy Anchor Link

ExampleCopy Anchor Link