Frontitude Developer Docs
FrontitudeGuidesWhat's new
  • 👋Hello, developer
  • 🔢Quick start
  • Deverloper CLI
    • Installation
    • Authentication
    • Commands
    • Example app
    • Supported client-side frameworks
    • File formats
      • JSON (Web)
      • XLIFF
      • Android XML
      • Apple Strings (.strings)
      • ARB (Flutter)
  • Webhooks
    • Introduction
    • Setting up Webhooks
    • Using Webhooks
    • Events
    • Example webhook handler
  • Security and Compliance
    • Security statement
    • Data collection statement
  • Useful links
    • Demo React app
    • Figma plugin
    • Frontitude guides
    • Product updates
Powered by GitBook
On this page
  • Flat
  • Nested
  • Metadata
  • Translations (Single file)
  • Translations (Separate files)

Was this helpful?

  1. Deverloper CLI
  2. File formats

JSON (Web)

Frontitude supports multiple JSON formats.

Format is automatically detected based on the file extension, so there’s no need to specify the format type when using it. ✨

Flat

Example

{
  "info_tooltip.title": "No worries, you won’t be charged",
  "info_tooltip.paragraph": "You can review this order before it's final"
}

Nested

Example

{
  "info_tooltip": {
    "title": "No worries, you won’t be charged",
    "paragraph": "You can review this order before it's final"
  }
}

Metadata

Frontitude supports an extended JSON format, called Metadata, which basically includes all metadata stored in Frontitude for each copy item.

Example

{
  "info_tooltip.title": {
    "value": "No worries, you won’t be charged",
    "status": "Final",
    "tags": ["Title", "Info tooltip", "Payment flow"],
    "isMixedStyle": false,
    "note": "A tooltip title, should grab attention and give users more information about next step",
    "createdAt": "2021-11-24T11:37:44.896Z",
    "updatedAt": "2021-11-25T10:12:34.131Z",
    "lastEditedBy": "Owen Fogel",
    "frontitudeLink": "https://app.frontitude.com/project/becaf236-53e7-473a-be41-3d6f7fc66168?edit=10278ce3-e802-4750-9b33-ef31f70e7bd0"
  },
  "info_tooltip.paragraph": {
    "value": "No worries, you won’t be charged",
    "status": "Final",
    "tags": ["Title", "Info tooltip", "Payment flow"],
    "isMixedStyle": false,
    "note": "A tooltip title, should grab attention and give users more information about next step",
    "createdAt": "2021-11-24T11:37:44.896Z",
    "updatedAt": "2021-11-25T10:12:34.131Z",
    "lastEditedBy": "Owen Fogel",
    "frontitudeLink": "https://app.frontitude.com/project/becaf236-53e7-473a-be41-3d6f7fc66168?edit=10278ce3-e802-4750-9b33-ef31f70e7bd0"
  }
}

Translations (Single file)

This format assumes that translations in all languages are defined in a single file. This is usually the case in small/medium applications.

Example

strings.json
{
  "en": {
    "info_tooltip.title": "No worries, you won’t be charged",
    "info_tooltip.paragraph": "You can review this order before it's final"
  },
  "es": {
    "info_tooltip.title": "No te preocupes, no se te cobrará",
    "info_tooltip.paragraph": "Puedes revisar este pedido antes de que sea definitivo"
  },
  "de": {
    "info_tooltip.title": "Keine Sorge, es entstehen Ihnen keine Kosten",
    "info_tooltip.paragraph": "Sie können diese Bestellung überprüfen, bevor sie endgültig ist"
  },
  "ja": {
    "info_tooltip.title": "請求されませんのでご安心ください",
    "info_tooltip.paragraph": "この注文を確定する前に確認できます"
  }
}

Translations (Separate files)

This format assumes that translations are stored in separated files, each dedicated for a specific language. This is usually the case in large applications.

Example

strings.json
{
  "info_tooltip.title": "No worries, you won’t be charged",
  "info_tooltip.paragraph": "You can review this order before it's final"
}
strings-es.json
{
  "info_tooltip.title": "No te preocupes, no se te cobrará",
  "info_tooltip.paragraph": "Puedes revisar este pedido antes de que sea definitivo"
}
strings-fr_CA.json
{
  "info_tooltip.title": "Ne t'inquiète pas, tu ne seras pas facturé",
  "info_tooltip.paragraph": "Tu peux revoir cette commande avant qu'elle soit définitive"
}‍
PreviousFile formatsNextXLIFF

Last updated 10 months ago

Was this helpful?