Resource
Déclarer une ressource.
La fonction ne transforme rien : elle sert à ce que TypeScript vérifie la déclaration au moment où on l'écrit, plutôt qu'au moment où on la passe à CrudPage. Le message d'erreur y gagne dix lignes de lisibilité.
Installation
sia-ui add resourceOu par le paquet, sans rien copier :
import { defineResource, resourceColumns, resourceDetailColumns, resourceFormFields, resourceValidator, resourceSearchKeys, resourceDefaults, resourceRowKey } from "@sia-ui/react-web";Utilisation
const factures = defineResource<Facture>({
name: "facture",
label: { singular: "Facture", plural: "Factures" },
fields: {
reference: { label: "Référence", required: true },
client: { label: "Client", required: true },
montant: { type: "currency", currency: "XOF", align: "end" },
statut: {
type: "select",
options: [{ value: "payee", label: "Payée" }],
tones: { payee: "success" },
},
},
});Props de defineResource
| Prop | Type | Défaut | Description |
|---|---|---|---|
formColumns | number | — | Colonnes de la grille du formulaire. |
Props de resourceColumns
Les colonnes du tableau, dans l'ordre de déclaration.
| Prop | Type | Défaut | Description |
|---|---|---|---|
formColumns | number | — | Colonnes de la grille du formulaire. |
Props de resourceDetailColumns
Les lignes de la vue de détail.
Tenues à part des colonnes : une note de trois phrases n'a pas sa place dans une cellule, mais c'est précisément au détail qu'on va la lire. Les dériver du tableau priverait la vue de détail de tout ce qui est long, ce qui est exactement ce qu'elle existe pour montrer.
| Prop | Type | Défaut | Description |
|---|---|---|---|
formColumns | number | — | Colonnes de la grille du formulaire. |
Props de resourceSearchKeys
Les clés que la recherche locale parcourt.
| Prop | Type | Défaut | Description |
|---|---|---|---|
formColumns | number | — | Colonnes de la grille du formulaire. |
Props de resourceDefaults
Les valeurs de départ d'une création : les champs du mode create.
| Prop | Type | Défaut | Description |
|---|---|---|---|
formColumns | number | — | Colonnes de la grille du formulaire. |
Props de resourceRowKey
Comment lire la clé d'une ligne.
| Prop | Type | Défaut | Description |
|---|---|---|---|
formColumns | number | — | Colonnes de la grille du formulaire. |
Voir aussi
- Le composant dans le catalogue — états, variantes, et bac à sable.
- La référence complète — tous les composants.