Skip to content

Companies

Jump to bottom
Koen Van Looveren edited this page May 10, 2023 · 8 revisions

Assets

Assets will be use to populate the UI

Required assets:

  • assets/img/logo.webp

Folder Structure for a company

companies/your_company_name
├── assets/img/logo.webp
├── (assets/img/logo.svg)
├── info.json

Json Documentation

This JSON object is structured as follows:

Example

{
    "name": "Example Company",
    "description": "This is an example company description.",
    "useLogoInsteadOfTextTitle": false,
    "links": {
        "website": "https://example-company.com"
    }
}

Properties

name

  • Data type: string (required)
  • Description: Represents the name of the company.
  • Constraints: This should be precisely the same as its parent folder.

description

  • Data type: string (optional)
  • Description: Represents a description of the object.
  • Default: null
  • Constraints: None.

useLogoInsteadOfTextTitle

  • Data type: boolean (optional)
  • Description: If set to true, the company logo will be used as the title instead of text.
  • Default: false
  • Constraints: None.

links

  • Data type: object (optional)
  • Description: Represents all links related to the company.
  • Default: null
  • Constraints: None.

website

  • Data type: string (optional)
  • Description: Represents the marketing website of the company
  • Default: null
  • Constraints: Should start with https://

madein.flutterbelgium.be

Clone this wiki locally