Skip to content
SurfaceDocs
FRGet started
DocsModel reference

WorkspaceHomePresentation · types

Interfaces, values and named contracts for WorkspaceHomePresentation.

The following types define named objects and their relationships. Tables include inherited properties. Schema-derived types refer to their validated structures; a TypeScript declaration does not replace the compiler’s semantic checks.

WorkspaceHomePresentationV1

Historical application wires retain their original Home declaration.

export type WorkspaceHomePresentationV1 = z.infer<typeof workspaceHomePresentationSchema>;

WorkspaceHomePresentation

Home metadata has no execution authority and owns no content or operational state.

export type WorkspaceHomePresentation =
  WorkspaceHomePresentationV1 | z.infer<typeof workspaceHomePresentationV2Schema>;

All references

Applied examples : Organize destinations

Choose the Clients collection in navigation and offer the next actions on the home.

Configuration

Fragment placed in composition.navigation[]. Properties and accepted values.

{
  "key": "clients",
  "label": "Clients",
  "icon": "users",
  "kind": "collection",
  "spaceKey": "clients",
  "definitionPaths": [
    "workspace/clients/surface/client"
  ],
  "queryKey": "clients",
  "formKey": null
}

Variation and connection

Fragment placed in homePresentation. Properties and accepted values.

{
  "contract": "WorkspaceHomePresentation@1",
  "header": {
    "intro": "Clients and quotes",
    "primaryNavigation": {
      "destinationKey": "clients",
      "label": "Open clients"
    }
  },
  "launchers": {
    "title": "Move work forward",
    "description": "Choose an action",
    "icons": [
      {
        "actionKey": "create-client",
        "icon": "users"
      },
      {
        "actionKey": "prepare-quote",
        "icon": "document"
      }
    ]
  },
  "blocks": [
    {
      "kind": "section",
      "sectionKey": "recent-quotes",
      "variant": "collection",
      "placement": "main",
      "maximumVisible": 4,
      "viewAll": {
        "destinationKey": "quotes",
        "label": "All quotes"
      }
    }
  ]
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

  1. Clients · Data
  2. References · Knowledge
  3. Preparation · Work
  4. Quotes · Product
ILLUSTRATIVE LAYOUTClients / Quotes app
SurfaceClients / North StudioExample
WorkspaceHomePresentation · typesOrganize destinations
Clients
01Clients · Data

Records and reference information

02References · Knowledge

Pricing, procedure and sources

03Preparation · Work

Steps, decisions and results

04Quotes · Product

Durable deliverable and revisions

Search for a concept, field or action.Esc