Forstå filen og formatet for components.json

Generelt format

Dette er det generelle formatet for filen components.json:

• Egenskaper for komponenter er angitt med hver enkelt komponent. Toppnivåegenskapene components eller apps frarådes.

• Hver komponent har en type-egenskap. Komponenter kan bare ha bestemte verdier (alle mulige verdier vises i tabellen for standardkomponenter).

• Hver komponent har en id-egenskap, som må være unik. Denne egenskapen brukes til å skille mellom komponenter med samme type. Tidligere hadde apper egenskapen appName. Selv om appName fremdeles fungerer hvis egenskapen id ikke er tilgjengelig, frarådes egenskapen appName.

• Hver komponent har en name-egenskap som er visningsnavnet i brukergrensesnittet. Hvis det ikke er angitt reserveverdier for komponenter, er verdien navnet på den tilsvarende standardkomponenten, og for eksterne komponenter er verdien ID-en.

Dette er et eksempel på en components.json-fil:

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

Den generelle strukturen er en JSON-matrise med kategoriobjekter. Hvert kategoriobjekt har en name-egenskap og en list-egenskap. Egenskapen name kan være en nøkkel som tilordnes til en lokalisert streng. Hvis det ikke er tilstrekkelig med disse standardkategoriene, kan du angi et eget kategorinavn, som ikke blir lokalisert. Følgende tabell viser tilgjengelige standardkategorier og tilsvarende nøkler.

Egenskapen list i hvert kategoriobjekt inneholder en matrise med komponentobjekter. Hver komponent eller hvert objekt må ha egenskapene type og id. Andre egenskaper er valgfrie.

• Egenskapen type må være lik én av typene som finnes i standardkomponentene. Hvis type ikke finnes allerede, vises ikke komponenten.

• Egenskapen id må være unik på tvers av komponenter. Hvis id allerede finnes, vises ikke komponenten.

• Egenskapen name er visningsnavnet for komponenten i brukergrensesnittet. Dette erstatter den tidligere appName-egenskapen for apper (nå eksterne komponenter).

• Alle andre egenskaper behandles på samme måte som i tidligere versjoner.

Legge til nye komponenter i components.json

Du har ikke tillatelse til å endre standardkomponentene. Du kan imidlertid opprette en ny komponent basert på en eksisterende standardkomponent. Du kan for eksempel opprette en ny komponent basert på komponenten scs-title, som definerer litt standardtekst. Det minste som kreves når det skal legges til en ny komponent, er å angi egenskapene type og id.

• type må være lik én av typene som finnes i standardkomponentene. Hvis type ikke finnes allerede, vises ikke komponenten.

• id må være unik på tvers av komponenter. Hvis id allerede finnes, vises ikke komponenten.

Dette er et eksempel på kode som brukes til å legge til en ny tittelkomponent. Denne komponenten vises sammen med standardtittelkomponenten.

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

Dette er et eksempel på kode som brukes til å legge til en ny tittelkomponent med et visningsnavn og standardtekst.

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

Vær oppmerksom på at tittelkomponenten tar alle egenskapene i standardtittelkomponenten som grunnlag, og bruker endringene på temanivå på toppen til å opprette den nye komponenten.

Bakoverkompatibilitet

components.json-filene i forrige format, kan fremdeles leses.

• Filer med egenskapene components eller apps på toppnivå.

• Hvis filen inneholder en apps-egenskap, lastes fremdeles brukerdefinerte eksterne komponenter under denne.

• Hvis filen inneholder en apps-egenskap på toppnivå, må du anta at hvilke som helst eksterne komponenter som vises nedenfor, har typen scs-app.

• Hvis egenskapen appName finnes, setter du id til verdien appName. Visningsnavnet vil være det samme som name hvis det er angitt, eller det har verdien id som reserve.