components.json-tiedoston ja -muodon esittely

Yleinen muoto

components.json-tiedoston yleinen muoto on seuraava:

• Komponenttien ominaisuudet määritetään kussakin komponentissa. Ylätason "components"- ja "apps"-ominaisuudet ovat vanhentuneet.

• Jokaisella komponentilla on "type"-ominaisuus. Komponenteilla voi olla vain tiettyjä arvoja (kaikki mahdolliset arvot luetellaan oletuskomponenttien taulukossa).

• Jokaisella komponentilla on "id"-ominaisuus, jonka on oltava yksilöivä. Tämän ominaisuuden avulla voidaan erottaa toisistaan komponentit, joilla on sama "type"-arvo. Sovelluksilla oli ennen "appName"-ominaisuus. "appName" toimii edelleen, jos "id"-ominaisuus ei ole saatavilla, mutta "appName"-ominaisuus on vanhentunut.

• Jokaisella komponentilla on "name"-ominaisuus, joka on käyttöliittymässä käytettävä näyttönimi. Jos varmistusarvoja ei ole määritetty, arvo on komponenteilla vastaavan oletuskomponentin nimi ja etäkomponenteilla tunnus.

Esimerkki components.json-tiedostosta:

[
    {
        "name": "COMP_CONFIG_TEXT_CATEGORY_NAME",
        "list": [
            {
                "type": "scs-title",
                "id": "my-headline",
                "name": "My Headline",
                ...
            },
            {
                ...
            },...
        ]
    },
    {
        "name": "My own category name",
        "list": [ ... ]
    }
]

Luokkaobjektien JSON-taulukon yleinen rakenne. Jokaisella luokkaobjektilla on "name"- ja "list"-ominaisuudet. "name"-ominaisuus voi olla avain, jolle on määritetty lokalisoitu merkkijono. Jos nämä oletusluokat eivät riitä, voit määrittää oman luokan nimen, jota ei lokalisoida. Seuraavassa taulukossa luetellaan käytettävissä olevat oletusluokat ja vastaavat avaimet.

Kunkin luokkaobjektin "list"-ominaisuus sisältää komponenttiobjektien taulukon. Jokaisella komponentilla tai objektilla on oltava "type"- ja "id"-ominaisuudet. Muut ominaisuudet ovat valinnaisia.

• "type"-ominaisuuden arvon on oltava jokin oletuskomponenttien tyypeistä. Jos "type"-arvo ei ole jo olemassa, komponenttia ei näytetä.

• "id"-ominaisuuden on oltava yksilöivä kaikkien komponenttien joukossa. Jos "id"-arvo on jo olemassa, komponenttia ei näytetä.

• "name"-ominaisuus on komponentin näyttönimi käyttöliittymässä. Tämä korvaa aiemman "appName"-ominaisuuden, jota käytettiin sovelluksille (jotka nyt ovat etäkomponentteja).

• Kaikki muut ominaisuudet toimivat samalla tavalla kuin aiemmissa versioissa.

Uusien komponenttien lisäys components.json-tiedostoon

Et voi muokata oletuskomponentteja. Voit kuitenkin luoda uuden komponentin, joka perustuu olemassa olevaan oletuskomponenttiin. Voit esimerkiksi luoda uuden "scs-title"-komponenttiin perustuvan komponentin, jossa on määritetty oletustekstiä. Uuden komponentin lisäys edellyttää vähintään "type"- ja "id"-ominaisuuksien määritystä.

• "type"-ominaisuuden arvon on oltava jokin oletuskomponenttien tyypeistä. Jos "type"-arvo ei ole jo olemassa, komponenttia ei näytetä.

• "id"-ominaisuuden on oltava yksilöivä kaikkien komponenttien joukossa. Jos "id"-arvo on jo olemassa, komponenttia ei näytetä.

Tämän esimerkin koodi lisää uuden Otsikko-komponentin. Tämä komponentti näytetään oletusarvoisen otsikkokomponentin rinnalla.

[
    {
        "name": "COMP_CONFIG_TEXT_CATEGORY_NAME",
        "list": [
            {
                "type": "scs-title",
                "id": "my-headline"
            }
        ]
    }
]

Tämän esimerkin koodi lisää uuden Otsikko-komponentin, jolla on näyttönimi ja jossa on oletusteksti.

[
    {
        "name": "COMP_CONFIG_TEXT_CATEGORY_NAME",
        "list": [
            {
                "type": "scs-title",
                "id": "my-headline",
                "name": "My Headline",
                "initialData": {
                    "userText": "This is a second title component"
                }
            }
        ]
    }
]

Huomaa, että otsikkokomponentissa käytetään kaikkia oletusarvoisen Otsikko-komponentin ominaisuuksia perustana. Uusi komponentti luodaan lisäämällä näiden ominaisuuksien päälle teematason muokkauksia.

Yhteensopivuus taaksepäin

Aiemman muodon mukaisia components.json-tiedostoja voidaan edelleen lukea.

• Tiedostot, joissa on ylätason "components"- tai "apps"-ominaisuuksia.

• Jos tiedosto sisältää "apps"-ominaisuuden, tähän ominaisuuteen sisältyvät käyttäjän määrittämät etäkomponentit ladataan edelleen.

• Jos tiedosto sisältää ylätason "apps"-ominaisuuden, alla lueteltujen etäkomponenttien tyypin voi olettaa olevan "scs-app".

• Jos "appName"-ominaisuus on olemassa, määritä "id"-arvoksi "appName"-arvo. Näyttönimi on sama kuin "name"-arvo, jos sellainen on määritetty. Jos sellaista ei ole määritetty, "id"-arvoa käytetään näyttönimenä.