Aller au contenu
SurfaceDocs
ENCommencer
DocsRéférence du Model

workspaceHomePresentationV2

Propriétés, variantes, types et limites de workspaceHomePresentationV2.

Cette référence décrit la structure complète de workspaceHomePresentationV2. Chaque chemin représente une propriété, y compris les objets imbriqués, les éléments de listes et les branches conditionnelles. Une branche identifiée par kind, contract ou mode n’admet que ses propres propriétés.

Structure et valeurs

Champ Options / valeurs attendues Description
contract "WorkspaceHomePresentation@2" Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée.
header closed object Requis. Définit « header » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
header.intro string; min length 1; max length 4000; null Requis. Définit « intro » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
header.primaryNavigation closed object; null Requis. Définit « primary Navigation » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
header.primaryNavigation.destinationKey string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité.
header.primaryNavigation.label string; min length 1; max length 4000 Requis. Libellé destiné à l’usager dans l’interface.
launchers closed object Requis. Définit « launchers » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
launchers.title string; min length 1; max length 4000 Requis. Titre de l’objet ou de la section dans l’interface.
launchers.description string; min length 1; max length 4000; null Requis. Explication du rôle, du contenu ou de l’effet de cet élément.
launchers.icons Array<closed object>; max length 30 Requis. Définit « icons » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
launchers.icons[].actionKey string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Requis. Référence à une Action déclarée; son affichage ne l’exécute pas.
launchers.icons[].icon "activity" | "alert" | "arrow-right" | "bot" | "briefcase" | "check" | "document" | "inbox" | "knowledge" | "marketplace" | "overview" | "portfolio" | "profile" | "search" | "users" | "map" | "graph" | "layers" | "settings" OR closed object Requis. Icône du catalogue admis pour cette variante de présentation.
launchers.icons[].icon.[variant 2].catalog Géré par Surface; fourni par les outils du Model. Requis. Définit « catalog » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
launchers.icons[].icon.[variant 2].revision "0.468.0" Requis. Définit « revision » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
launchers.icons[].icon.[variant 2].name string; min length 1; max length 120; semantic validation Requis. Nom lisible de l’élément dans le contexte qui le présente.
blocks Array<closed object OR closed object>; max length 20 Requis. Définit « blocks » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
blocks[].[kind=section].kind "section" Requis. Sélectionne la variante et les propriétés admises dans cette branche.
blocks[].[kind=section].sectionKey string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité.
blocks[].[kind=section].variant "collection" | "work-resume" Requis. Définit « variant » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
blocks[].[kind=section].placement "main" | "aside" Requis. Définit « placement » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
blocks[].[kind=section].maximumVisible integer; ≥ 1; ≤ 24 Requis. Nombre maximal d’éléments dans l’aperçu; la collection complète reste accessible séparément.
blocks[].[kind=section].viewAll closed object; null Requis. Définit « view All » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
blocks[].[kind=section].viewAll.destinationKey string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité.
blocks[].[kind=section].viewAll.label string; min length 1; max length 4000 Requis. Libellé destiné à l’usager dans l’interface.
blocks[].[kind=activity].kind "activity" Requis. Sélectionne la variante et les propriétés admises dans cette branche.
blocks[].[kind=activity].key string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité.
blocks[].[kind=activity].label string; min length 1; max length 4000 Requis. Libellé destiné à l’usager dans l’interface.
blocks[].[kind=activity].spaceKeys Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; min length 1; max length 20 Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité.
blocks[].[kind=activity].maximumVisible integer; ≥ 1; ≤ 50 Requis. Nombre maximal d’éléments dans l’aperçu; la collection complète reste accessible séparément.
blocks[].[kind=activity].placement "main" | "aside" Requis. Définit « placement » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.

Règles de lecture

Les chemins suffixés par [] décrivent chaque élément d’une liste; {key} décrit chaque valeur d’un dictionnaire. Le symbole ↻ renvoie à la même expression récursive. Un objet fermé refuse les propriétés supplémentaires. Les mentions de validation sémantique signalent un contrôle complémentaire : la conformité des types ne suffit pas à rendre une référence, une permission ou une transition valide. Les références doivent être résolues dans le Model et le contexte de l’usager.

La présence d’une ancienne variante ne permet pas d’y ajouter une propriété d’une variante plus récente. Le compilateur contrôle la version et la cohérence du Model complet.

Les paramètres d’implémentation de cette structure sont gérés par Surface. Utilisez les outils du Model pour les produire; ils ne sont pas des valeurs à saisir dans une fiche.

Références associées

Index complet du Model · Construire un Model

Exemples appliqués : Organiser les destinations

Choisissez la collection Clients dans la navigation et proposez les prochaines actions dans l’accueil.

Configuration

Valeur de la propriété header. Propriétés et valeurs admises.

{
  "intro": "Retrouvez votre manuscrit, vos références et les travaux à poursuivre.",
  "primaryNavigation": {
    "destinationKey": "manuscript",
    "label": "Ouvrir le manuscrit"
  }
}

Variante et raccordement

Fragment à placer dans homePresentation. Propriétés et valeurs admises.

{
  "contract": "WorkspaceHomePresentation@1",
  "header": {
    "intro": "Clients et soumissions",
    "primaryNavigation": {
      "destinationKey": "clients",
      "label": "Ouvrir les clients"
    }
  },
  "launchers": {
    "title": "Faire avancer le travail",
    "description": "Choisissez une 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": "Toutes les soumissions"
      }
    }
  ]
}

Exemple de disposition UI

La disposition illustrative ci-dessous situe cette configuration dans l’app Clients/Soumissions. Chaque fragment s’insère à l’emplacement indiqué; ses références aux Fields, Queries et Actions correspondent aux déclarations du Model.

  1. Clients · Data
  2. Références · Knowledge
  3. Préparation · Work
  4. Soumissions · Product
DISPOSITION ILLUSTRATIVEApp Clients / Soumissions
SurfaceClients / Atelier NordExemple
workspaceHomePresentationV2workspaceHomePresentationV2
Clients
CONTEXTE DU MODELAtelier NordConfiguration déclarative
intro
Retrouvez votre manuscrit, vos références et les travaux à poursuivre.
primaryNavigation
Objet déclaré

Les valeurs ci-dessus reprennent le fragment de configuration; les références se résolvent dans le Model complet.

Recherchez un concept, un champ ou une action.Esc