Κατανόηση του αρχείου και της μορφής components.json

Γενική μορφή

Η γενική μορφή του αρχείου components.json ακολουθεί:

• Οι ιδιότητες για τα συστατικά στοιχεία καθορίζονται εντός κάθε συστατικού στοιχείου. Οι ιδιότητες ανωτάτου επιπέδου "components" ή "apps" έχουν καταργηθεί.

• Κάθε συστατικό στοιχείο έχει μια ιδιότητα "type". Τα συστατικά στοιχεία μπορεί να έχουν μόνο συγκεκριμένες τιμές (όλες οι πιθανές τιμές παρατίθενται στον πίνακα για τα προεπιλεγμένα συστατικά στοιχεία).

• Κάθε συστατικό στοιχείο έχει μια ιδιότητα "id", η οποία πρέπει να είναι μοναδική. Αυτή η ιδιότητα χρησιμοποιείται για τη διάκριση μεταξύ συστατικών στοιχείων με το ίδιο "type". Προηγούμενα, οι εφαρμογές είχαν την ιδιότητα "appName". Παρόλο που η ιδιότητα "appName" εξακολουθεί να λειτουργεί αν η ιδιότητα "id" δεν είναι διαθέσιμη, η ιδιότητα "appName" έχει καταργηθεί.

• Κάθε συστατικό στοιχείο έχει μια ιδιότητα "name" που είναι το εμφανιζόμενο όνομα στο περιβάλλον εργασίας. Αν δεν έχουν καθοριστεί εναλλακτικές τιμές, για τα συστατικά στοιχεία η τιμή είναι το όνομα του αντίστοιχου προεπιλεγμένου συστατικού στοιχείου και για τα απομακρυσμένα συστατικά στοιχεία η τιμή είναι το αναγνωριστικό.

Ακολουθεί ένα παράδειγμα ενός αρχείου components.json :

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

Η γενική δομή είναι ένας πίνακας JSON με αντικείμενα κατηγορίας. Κάθε αντικείμενο κατηγορίας έχει μια ιδιότητα "name" και μια ιδιότητα "list". Η ιδιότητα "name" μπορεί να είναι ένα κλειδί που αντιστοιχεί σε μια τοπικοποιημένη συμβολοσειρά. Αν αυτές οι προεπιλεγμένες κατηγορίες δεν επαρκούν, μπορείτε να παρέχετε το δικό σας όνομα κατηγορίας, η οποία δεν θα τοπικοποιηθεί. Ο ακόλουθος πίνακας παραθέτει τις διαθέσιμες προεπιλεγμένες κατηγορίες και τα αντίστοιχα κλειδιά.

Η ιδιότητα "list" σε κάθε αντικείμενο κατηγορίας περιέχει έναν πίνακα αντικειμένων συστατικών στοιχείων. Κάθε συστατικό στοιχείο ή αντικείμενο πρέπει να έχει τις ιδιότητες "type" και "id". Οι άλλες ιδιότητες είναι προαιρετικές.

• Η ιδιότητα "type" πρέπει να είναι ίση με έναν από τους τύπους που βρίσκονται στα προεπιλεγμένα συστατικά στοιχεία. Αν η ιδιότητα "type" δεν υπάρχει ήδη, το συστατικό στοιχείο δεν θα εμφανιστεί.

• Η ιδιότητα "id" πρέπει να είναι μοναδική σε όλα τα συστατικά στοιχεία. Αν η ιδιότητα "id" βρεθεί να υπάρχει ήδη, το συστατικό στοιχείο δεν θα εμφανιστεί.

• Η ιδιότητα "name" είναι το εμφανιζόμενο όνομα για το συστατικό στοιχείο στο περιβάλλον εργασίας. Αυτή αντικαθιστά την προηγούμενη ιδιότητα "appName" για εφαρμογές (τώρα απομακρυσμένα συστατικά στοιχεία).

• Όλες οι άλλες ιδιότητες αντιμετωπίζονται το ίδιο με τις προηγούμενες εκδόσεις.

Προσθήκη νέων συστατικών στοιχείων στο αρχείο components.json

Δεν επιτρέπεται να τροποποιήσετε τα προεπιλεγμένα συστατικά στοιχεία. Ωστόσο, μπορείτε να δημιουργήσετε ένα νέο συστατικό στοιχείο με βάση ένα υπάρχον προεπιλεγμένο συστατικό στοιχείο. Για παράδειγμα, μπορείτε να δημιουργήσετε ένα νέο συστατικό στοιχείο με βάση το συστατικό στοιχείο "scs-title", το οποίο ορίζει ένα προεπιλεγμένο κείμενο. Το ελάχιστο που απαιτείται για την προσθήκη ενός νέου συστατικού στοιχείου είναι να καθορίσετε τις ιδιότητες "type" και "id".

• Η ιδιότητα "type" πρέπει να είναι ίση με έναν από τους τύπους που βρίσκονται στα προεπιλεγμένα συστατικά στοιχεία. Αν η ιδιότητα "type" δεν υπάρχει ήδη, το συστατικό στοιχείο δεν θα εμφανιστεί.

• Η ιδιότητα "id" πρέπει να είναι μοναδική σε όλα τα συστατικά στοιχεία. Αν η ιδιότητα "id" βρεθεί να υπάρχει ήδη, το συστατικό στοιχείο δεν θα εμφανιστεί.

Ακολουθεί ένα παράδειγμα κώδικα για την προσθήκη ενός νέου συστατικού στοιχείου Τίτλου. Αυτό το συστατικό στοιχείο θα εμφανίζεται μαζί με το προεπιλεγμένο συστατικό στοιχείο τίτλου.

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

Ακολουθεί ένα παράδειγμα κώδικα για την προσθήκη ενός νέου συστατικού στοιχείου Τίτλου με ένα εμφανιζόμενο όνομα και προεπιλεγμένο κείμενο.

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

Σημειώστε ότι το συστατικό στοιχείο τίτλου παίρνει όλες τις ιδιότητες του προεπιλεγμένου συστατικού στοιχείου Τίτλου ως βάση και εφαρμόζει τροποποιήσεις επιπέδου θέματος πάνω από αυτό για τη δημιουργία του νέου συστατικού στοιχείου.

Συμβατότητα με προηγούμενες εκδόσεις

Τα αρχεία components.json στην προηγούμενη μορφή μπορούν να διαβαστούν ακόμα.

• Αρχεία με ιδιότητες ανωτάτου επιπέδου "components" ή "apps".

• Αν το αρχείο περιέχει μια ιδιότητα "apps", τα απομακρυσμένα συστατικά στοιχεία που ορίζονται από τον χρήστη κάτω από αυτήν την ιδιότητα εξακολουθούν να φορτώνονται.

• Αν το αρχείο περιέχει μια ιδιότητα ανωτάτου επιπέδου "apps", τότε θεωρείται ότι όλα τα απομακρυσμένα συστατικά στοιχεία που παρατίθενται από κάτω από αυτή έχουν τύπο "scs-app".

• Αν υπάρχει η ιδιότητα "appName", καθορίστε στην ιδιότητα "id" την τιμή "appName". Το εμφανιζόμενο όνομα θα είναι το ίδιο με το "name", αν έχει καθοριστεί, ή επιστρέφει στην τιμή "id".