...
| Table of Contents |
|---|
Context
Store app properties are used to customize the level of information displayed on screen for a given entity. OneStock's basic display is like this:
Pour les orders, parcels et line items
La structure de l'objet properties est la suivante:
properties (object) > page (object) > entity (array de taille 0 à 3) > propriétés (array de string)
| Code Block | ||
|---|---|---|
| ||
properties:
claim:
order: [
['id', 'delivery.type'], # Ligne 1
['date'] # Ligne 2
]
line_item: [...]
pack:
parcel: [...]
line_item: [...] |
Dans l'exemple ci-dessus, la première ligne d'order contiendra les propriétés order.id et order.delivery.type tels que récupérés en appelant l'OMS, et séparés par le caractère pipe |
Page avec multi parcel
Dans le cas des pages qui supportent le multi colisage ou multi empaquetage (bag et pack) il y a une entité appelé multi_order, qui corresponde à celle qu'est utilisé lorsque la store app est configuré pour faire de multi colisage empaquetage (clé You can find this configuration in the configuration -> store_app -> pages section of your admin backoffice (https://admin.onestock-retail.com/cXXX/config/store_app/pages).
Advanced customization
| Tip |
|---|
To view the default properties, use the test command |
Multi parcel
In the case of pages that support multi-packaging (bag and pack), there is an entity called multi_order, which corresponds to the one used when the store app is configured for multi-packaging (options.create_multi_parcels )
Pour les pop-ins
La pop-in affichée sur diverses pages peut également être personnalisée. Le format de la config est cependant un peu différent:
configurer la pop-in
| Code Block | ||
|---|---|---|
| ||
properties:
popin:
line_item: [
['features.name'], # Titre de la pop-in
['|rawstring:Référence', 'item_id'] # Ligne 1 Sous l'image
['|rawstring:Prix', 'payment.price'] # Ligne 2 Sous l'image
['|rawstring:Couleur', 'features.color'] # Ligne 3 Sous l'image
['|rawstring:Taille', 'features.size'] # Ligne 4 Sous l'image
]
|
Dans l'exemple ci-dessus, la première ligne définit le titre de la pop-in, et toutes les lignes suivantes seront affichées sous l'image. Les éléments ne seront pas séparés par le pipe |, mais divisés en colonnes (voir screenshot ci-dessus).
| Tip |
|---|
Pour voir les properties par défaut, utiliser la commande |
Formatter les propriétés
Souvent, les propriétés des objets nécessitent d'être formattés pour des raisons esthétiques.
Il est possible d'utiliser un ou plusieurs formatteurs avec la sytaxe suivante 'key).
Popins
The information level of the various popins can also be configured.
Properties Formatting
Object properties often need to be formatted for aesthetic reasons.
It is possible to use one or more formatters with the following syntax property|formatter:option|formatter|formatter'.Pour que la première lettre du type de livraison soit en majuscule, on utilisera '
| Tip |
|---|
Examples:
|
...
|
...
|
...
|
...
| Tip |
|---|
Parenthesis
A parenthesis syntax is available for the most complex expressions.
Properties that are nested within parentheses will be evaluated first. For example, the property parcels|forcount:line_item_ids|concatraw: / |concatraw: (line_items|length)
...
will display 1 / 2.
En l'absence de parenthèses, les formatteurs sont appliqués de gauche à droite.
...
formatter
...
effet
...
option
...
example
...
arrayelement
...
Récupère l'élément d'un tableau à l'index défini en option
...
In the absence of parentheses, formatters are applied from left to right.
All formatters availables
...
Défaut
...
Surcharge onboarding
...
Résultat
...
['id']
...
['label']
...
['label']
...
['id', 'label', 'delivery']
...
['date']
...
['date', 'label', 'delivery']
...
['id', 'label', 'delivery']
...
['date', '', '']
...
['date', '', ''], mais affiché commme ['date']
...
L'avantage: il est possible de rajouter une ligne à l'order de la façon suivante, sans que les deux premières lignes ne soient écrasées.
...
Name | Description | Option | Example → Render | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Retrieves the element of an array with index. | Element index |
| ||||||||
| Replace all letters with lower case, except the first, which is upper case. |
| |||||||||
| Concatène une autre Concatenates another property, sans espacePropriété à concaténerwithout spaces. | Property to concatenate |
| ||||||||
| Concatène une string définie dans l'option | String à concaténerConcatenates a string. | Defined string |
| currency | Formate un nombre en une currency, avec un symbole défini dans une autre propriété | La propriété contenant la | ||||
| Formats a number into a currency, with a symbol defined in another property. | Property containing the currency |
| ||||||||
| Formate un nombre en une currency, avec un symbole défini dans l'option | La currency à utiliserFormats a number into a currency, with a symbol defined in the expression. | The currency to use |
| |||||||
| Format a date range. | Property corresponding to end date |
| ||||||||
| Divise une valeur par une autre valeur passée en paramètre | Le chemin du diviseurDivides a value of a property by an another. | Divisor property |
| |||||||
| Renvoie une date dans la couleur envoyée si elle est expirée | la valeur de warning qui sera soustraite à la date du jour pour le calcul (en secondes) It is possible to pass a relative parameter (seconds to be subtracted from the expiry date). | The warning value to be subtracted from the current date for the calculation (in seconds) The color to be set if the date has expired. The value to be returned. |
(NB: la valeur avant le | sert pour les calculs de l'expiration (timestamp), la valeur dans les options sert à l'affichage (peut être formatée). | |||||||
filter | Parcourt un tableau et garde les éléments de ce tableau dont une propriété vaut une des valeurs fournies. | Une propriété=une liste de valeurs séparées par une virgule | Scans an array and keeps the elements of this array whose property is worth one of the values provided. | Comma-separated list of values |
| ||||||
| Parcourt un tableau et compte le nombre d'élèment de ce tableau dont une proprièté vaut une des valeurs fournies. (v5.5) | Une propriété=une liste de valeurs séparées par une virgule
| Scans an array and counts the number of elements in the array whose property has one of the provided values. | Comma-separated list of values |
| ||||||
| Parcourt un tableau et compte la taille d'une proprièté de chaque de ce tableau. (v5.5) | Une propriété
| Scans an array and counts the size of each property in the array. | Property |
| ||||||
| Parcourt un tableau et renvoie l'élément dont l'index est le plus faible dans le tableau défini en option . Si rien ne matche, ne fait rien. (v10.0) | Une liste de valeurs séparées par une virgule
| Scans an array and returns the element with the lowest index in the array defined in option . If nothing matches, does nothing. | Comma-separated list of values |
| ||||||
| Calculates the total quantity of indexes in the supplied index ranges. |
| |||||||||
| Returns the length attribute of an array or string. |
| |||||||||
| Formate le résultat sous forme de lien | Une propriétéFormats the result as a link. | Property |
| |||||||
| Formate le résultat sous forme de lien blank | Une propriétéFormats the result as a blank link. | Property |
| |||||||
| Replace all letters with lowercase letters. |
| |||||||||
| Formate un timestamp en utilisant un format de momentjs | Format de la dateFormat a timestamp using momentjs. | Date format |
| |||||||
Peut prendre en option des features ou des constante Pour rajouter une unité au résultat, il existe diffèrent formateurs ( concat, concatraw, currency, currencyraw..) On peut limiter le nombre de décimales en rajoutant un second argument sépare par une virgule, par défaut les résultas son limiter a 2 chiffres après la virgule | Multiplies two values. | Can take optional features or constants. You can limit the number of decimal places by adding a second argument separated by a comma. By default, results are limited to 2 digits after the decimal point. |
| ||||||||
| Concatène une autre property à gauche | Une propriétéConcatenates another property on the left. | Property |
| |||||||
| Concatène une string définie dans l'option, à gauche | String à afficherConcatenates a string on the left. | Defined string |
| |||||||
| Permet de remplacer le résultat par une string définie dans l'option | String à afficherReplaces the result with a string defined. | Defined string |
| |||||||
| Scans an array and sum | Parcourt un tableau et fais la somme de la propriété donnée en option | Une propriététhe given property in the array. | Property |
| ||||||
| le Displays tracking code s'il y en a, traduit la clé passée en paramètre sinonClé à traduire s'il n'y a pas de tracking codeif available, translates key passed in parameter otherwise. | Key to translate |
"XV265564654" ou "Colis sans information de tracking" s'il n'y a pas de tracking code | trans | Traduit le résultat (si la clé de traduction existe bien) → XV265564654 or Missing tracking | ||||||
| Translates the result (if the translation key exists). |
| |||||||||
| Prend un nombre en entrée et appelle une traduction avec pluralisation | Clé de traductionTakes a number as input and calls a translation with pluralization. | Key to translate |
| |||||||
|
Appelle une traduction avec pluralisation sur l'input. N'affiche rien si !input vaut false au sens de javascript. (v10.0) |
| Calls a translation with pluralization on the input. Displays nothing if !input is false in the javascript sense. | Key to translate |
avec with line_items = [] : | ||||||
| Parcourt un tableau et compte le nombre d’élément de ce tableau dont une proprièté ne vaut pas une des valeurs fournies. (v5.5) | Une propriété=une liste de valeurs séparées par une virgule
| Scans an array and counts the number of elements whose property is not one of the provided values. | Comma-separated list of values |
| ||||||
| Replace all letters with capital letters. |
| |||||||||
| Prend une date en entrée et retourne la difference a partir de maintenant dans la lang du site. (V11.0) | date|since |
...
Attention à la façon dont les propriétés sont surchargées. Un tableau de 2 éléments surchargé par un tableau vide reste un tableau de 2 éléments.
| Takes a date as input and returns the difference from now in the site's lang. |
|