Skip to main content

Design guidelines

In this page you will make your embedded pages feel part of the platform. The first section lists what the platform enforces; the rest are our recommendations.

What the platform gives you, and its limits​

ElementWhereLimit
Menu entriesnavigation in the manifest, under the platform's Apps menuUp to 10; a label in English (required) and in French (optional), at most 40 characters each
Page titletitle()100 characters
Progress bar under the headerloading(true) and loading(false)
Loading placeholderShown until you call ready()
Toaststoast(), kind info, success or error200 characters
Confirmation dialogconfirm()Message 500 characters, button 30
Product tab frameproduct.details.tab600 px high by default, from 200 to 2000
Organization overview cardorganization.overview.card200 px high by default, from 80 to 600

Your page receives the user's language in the locale query parameter and in the session token.

Look like the platform​

  • Use the platform's design library. The platform is built with fooDS; its components, colours and type are in its Storybook. Match its spacing, typography and colours rather than your own brand.
  • No second header. The platform draws its own header and menu around your page: do not add a logo bar or a global navigation. Use title() for the page name.
  • Use the platform's feedback. Show results with toast() and ask with confirm() instead of your own banners and modals: they look and behave like the rest of the platform.
  • Fit the frame. Your page lives in a frame of variable width: no fixed widths, no horizontal scroll.

Behave like the platform​

  • Call ready() early, as soon as the first meaningful content is shown, so the placeholder does not linger. For longer work afterwards, use loading().
  • Speak the user's language. At least English and French, from locale.
  • Say what happens. After an action, a toast; before a destructive one, a confirmation; when data is not available, a short sentence, not a blank area.
  • Respect permissions. If the installation does not cover an organization, say so plainly instead of showing an error.

Extensions are small​

  • One idea per extension. A product tab shows what your app knows about this product; an overview card shows one figure or status and links to your full page.
  • Follow your content's height with autoResize(), within the slot's range.
  • Load fast. The extension appears inside a page the user opened for something else.

Accessibility​

  • Text reaches a contrast of 4.5:1 against its background, controls 3:1.
  • Every action is reachable with the keyboard and shows where the focus is.
  • Images that carry meaning have a text alternative.