Add-on Style & Guidelines

Add-on Style

You can rely on the base styles in sdk.css. There’s no need to override things like buttons, inputs, tables, headers, font styles, and code blocks that aren’t core to your Add-on.

<head>
  <link rel="stylesheet" href="https://platform.servicem8.com/sdk/1.0/sdk.css">
  ...
</head>

sdk.css includes normalize.css, a CSS reset which “makes browsers render all elements more consistently and in line with modern standards”. You don’t need to include anything similar in your CSS.

Add-on Guidelines

  • Don't embed your site
  • Quality over quantity

Job & Client Actions

Do:

  • Use this for actions which related to a particular Job or Client

Don't:

  • Use more actions than is necessary. Space for action buttons is limited.

Add-on Menu Items

Do:

  • Use this for actions which need a large UI
  • Use this for actions or UI which is not related to a particular Job or Client

Don't:

  • Add a menu item just to edit settings that can be represented by manifest preferences. For ServiceM8-hosted Simple Function Add-ons, use the account's Settings → Preferences → Add-ons page.

Preference labels and help text

Supply plain-text names, descriptions and option labels. ServiceM8 generates the controls and applies the Preferences page's standard headings, typography and spacing. Do not supply HTML, Markdown formatting or custom CSS; these are displayed literally. Keep descriptions concise and within the 250-character limit. See the Manifest Reference for supported controls, hosting eligibility and limits.


Did this page help you?