Twilight.json Twilight Documentation

The twilight.json file is included within the Twilight theme, and it is placed in the root directory. This setup file contains the main theme's information, features and components for the rendering purpose that occurs on the Theme. Use Salla Partners Portal to conduct visual modifications that includes Theme settings, Theme features, and Theme components.
In this article, we will explore the different parts of the twilight.json file.

📙 What you'll learn

Author settings

Theme settings

Theme features

Theme components

Author settings

These settings contain both the theme owner and the theme basic information. That includes details about the version, theme_name, repo_url, and theme support_url, which is also included in the settings:

{
  "version": "1.0.0",
  "theme_name": "Theme One",
  "repo_url": "https://github.com/SallaApp/theme-raed",
  "support_url": "https://salla.dev"
  ...
}

Educational Clip

Theme settings

The theme settings store information about global values that can be used anywhere in the theme. These values can be defined by their type, label, id, and format.

In the following example, there are two setting definitions:

The first is for a boolean value with a switch format, which by default is not selected.

The second setting is for a string value that represents the path to the theme's default image placeholder for any image.

{
  ...
  "settings": [
      {
        "type": "boolean",
        "label": "شريط علوي داكن",
        "id": "topnav_is_dark",
        "format": "switch",
        "selected": false
      },
      {
        "type": "string",
        "id": "placeholder",
        "format": "hidden",
        "value": "images/img_placeholder.png"
      }
    ],
  ...
}

Retrive the theme setting values

There are several methods to retrieve, or get, the stored values of any of the theme settings. For example, in the below code, we have a setting defined as topnav_is_dark. This setting can be accessed by using any of the following methods:

Educational Clip

Theme Features

This part of the twilight.json lists the theme features, which are pre-defined components. It is a group of built-in components that come with Twilight for the Home Page.

Note

As a best practice, ensure to use the Theme features which brings a smoother experience for all Salla merchants.

The Theme features components' names have the prefix component- inside twilight.json, and include only the components that are supported in your theme.

{
  ...
  "features": [
      ...
      "component-featured-products",
      "component-fixed-banner",
      "component-fixed-products",
      "component-photos-slider",
      "component-products-slider",
      "component-parallax-background",
      "component-random-testimonials",
      "component-testimonials",
      "component-square-photos",
      "component-store-features",
      "component-youtube",
      "filters"
    ]
  ...
}

Educational Clip

Theme components

In addition to the Theme features, which are the pre-defined components, the twilight.json file lists a group of Theme Component(s). These components are custom-built by the developer for the Home Page. The developer has the option to use own, new, and custom component as per the store’s requirements.

The following is an example of a newly created Theme component, aka custom component, named custom-slider.
As per the example, the path of this new component is mentioned in "path": "home.custom-slider".
This means that the new component is located inside views\components\home\custom-slider.twig.
The developer has the option of creating components anywhere within the views\components\folder.

{
  ...
  "components": [
    {
      "name": "custom-slider",
      "title": "صور متحركة (مخصص)",
      "icon": "sicon-image-carousel",
      "path": "home.custom-slider",
      "fields": [
        {
          "id": "images",
          "type": "collection",
          "format": "collection",
          "required": true,
          "minLength": 1,
          "maxLength": 10,
          "fields": [
            {
              "id": "image",
              "type": "string",
              "format": "image"
            },
            {
              "id": "title",
              "type": "string",
              "label": "عنوان رئيسي (إختياري)"
            },
            {
              "id": "sub_title",
              "type": "string",
              "format": "textarea",
              "label": "نص توضيحي (إختياري)"
            }
          ]
        }
      ]
    },
  ...
}

Educational Clip

Twilight.json

📙 What you'll learn#

Author settings#

Theme settings#

Retrive the theme setting values#

Theme Features#

Theme components#

📙 What you'll learn

Author settings

Theme settings

Retrive the theme setting values

Theme Features

Theme components