Skip to Content
Documentation
Bien démarrer

Installation

Installez Yayaw Table, la table de donnees React open source pour Shadcn UI et TanStack Table, via la registry Shadcn

L’instantané v3.1.0 correspond aux exemples de cette documentation ; seuls les instantanés plus anciens, comme v3.0.0, précèdent la consultation de fiches et le Gantt dérivé des lignes de la table. Voir compatibilité. Le registre Vue installe les sources et styles copiés ; @yayaw/table-vue est un package privé du workspace, pas le chemin d’installation public.

Installation

Yayaw Table est distribué via une registry Shadcn. La CLI copie le code complet dans votre projet, vous gardez donc une maîtrise locale totale.

Choisissez votre framework ci-dessous, puis suivez son guide de démarrage.

Prérequis

  • Un projet déjà configuré avec Shadcn UI

  • Un components.json avec l'alias ui configuré (recommandé : "ui": "@/components/ui")

  • Un client TanStack Query partagé unique, via QueryClientProvider en React ou VueQueryPlugin en Vue

  • Un build ESM ciblant ES2022 ou une version plus récente pour TanStack Table 9

Installation avec la CLI Shadcn

Depuis la racine de votre projet :

npx shadcn@latest add https://table.yayaw.app/r/yayaw-table.json
Terminal
npx shadcn-vue@latest add https://table.yayaw.app/r/yayaw-table-vue.json

Pour cibler une version précise, utilisez un snapshot de release :

npx shadcn@latest add https://table.yayaw.app/r/v3.37.1/yayaw-table.json

Si votre projet a le namespace registry Yayaw configuré (@yayaw), vous pouvez aussi lancer :

npx shadcn@latest add @yayaw/yayaw-table

La CLI va :

  • Ajouter les composants Shadcn manquants dont nous dépendons

  • Copier les fichiers Yayaw Table sous votre alias ui (exemple : @/components/ui/yayaw-table)

  • Installer les dépendances npm nécessaires (@tanstack/react-table, jotai, lucide-react, etc.)

Migrer depuis TanStack Table 8

Les registres Yayaw Table actuels utilisent TanStack Table 9.2.4. Réinstallez le registre afin de mettre à jour ensemble l'adaptateur local components/ui/yayaw-table/tanstack.ts et la dépendance.

Importez depuis cet adaptateur les types TanStack liés à la table lorsque vous étendez les composants copiés. Si le code de l'application importe TanStack directement, migrez ces intégrations personnalisées vers l'API v9. TanStack 9 utilise start et end pour son état de pinning interne ; Yayaw Table continue de sérialiser left et right dans les vues enregistrées et les URLs. Les vues persistées existantes ne demandent donc aucune migration de données.

Mettre à jour les états vides

Le registre courant inclut la dépendance Shadcn empty. Réinstallez le registre pour récupérer les changements de la table et leurs dépendances ensemble. Si vous copiez les fichiers de la table manuellement, installez aussi Empty :

npx shadcn@latest add empty

Conservez le thème Shadcn et les extensions locales de votre application lors de la revue de mise à jour. Vue inclut ses composants Empty et leurs styles dans le registre shadcn-vue ; mettez les deux à jour ensemble. Cette mise à jour ne demande aucune migration des vues enregistrées.

Items CLI v4 optionnels

Pour les nouveaux projets qui veulent une base Shadcn prête pour Yayaw, installez l'item optionnel :

npx shadcn@latest add @yayaw/yayaw-table-base

Cet item configure base-vega, lucide, TypeScript, les React Server Components, la couleur de base neutral, le namespace registry @yayaw, la font Yayaw Sans optionnelle et Yayaw Table.

Vous pouvez aussi installer uniquement le preset de font :

npx shadcn@latest add @yayaw/font-yayaw-sans

Ces items sont additifs. Les projets existants peuvent continuer à installer yayaw-table directement.

Inspecter avant installation

La CLI shadcn v4 permet d'inspecter le payload registry avant d'écrire des fichiers :

npx shadcn@latest add https://table.yayaw.app/r/yayaw-table.json --dry-run
npx shadcn@latest add https://table.yayaw.app/r/yayaw-table.json --diff
npx shadcn@latest add https://table.yayaw.app/r/yayaw-table.json --view

Vous pouvez aussi inspecter ou découvrir les items de registry :

npx shadcn@latest view @yayaw/yayaw-table
npx shadcn@latest search @yayaw
npx shadcn@latest list @yayaw

Pour capturer le contexte du projet local pendant le debug ou les workflows avec agents :

npx shadcn@latest info --json

Premier usage

Suivez le démarrage React ou le démarrage Vue pour construire une table de produits complète et typée : enregistrements, configuration, action de liste et providers. Chaque guide fournit tous les fichiers locaux importés.

React demande un QueryClient partagé et l’adaptateur Nuqs correspondant à votre routeur. Vue utilise VueQueryPlugin. Placez ces providers à la racine de l’application lorsque vous affichez plusieurs tables.

Exigence QueryClient (breaking change)

Les détails suivants concernent React. Les providers et styles Vue sont décrits dans le démarrage Vue.

Yayaw Table ne crée plus automatiquement de QueryClient interne.

Vous devez maintenant fournir exactement un client partagé :

  • soit via votre QueryClientProvider au niveau app,

  • soit via la prop queryClient (la même instance que le provider si vous utilisez les deux).

Si aucun QueryClient n'est disponible, Yayaw Table lève une erreur développeur explicite au runtime.

CSS / Tailwind

Yayaw Table utilise Tailwind CSS. Vérifiez que Tailwind est bien configuré dans votre projet.

Thème

Yayaw Table suit le thème Shadcn de l'application hôte : les composants copiés utilisent ses variables CSS (background, foreground, muted, border).

Couleurs de statut et de fichier

Depuis la v3.36.0, les composants de table, de tableau de bord, de calendrier, de graphique et de carte n'écrivent aucune couleur en propre : chaque état lit les tokens de votre thème (primary, destructive, muted, chart-1 à chart-5). Les quelques états qu'aucun token Shadcn ne nomme lisent une variable optionnelle, chacune avec une valeur de repli : rien n'est à définir pour commencer.

VariableUtilisée pourRepli
--yayaw-successLes statuts positifs : tags success, comparaison d'un nombre qui s'améliore, connecteur synchronisé.Vert
--yayaw-warningLes statuts qui demandent de l'attention : tags warning, avertissements des formulaires et des connecteurs, modifications non enregistrées.Ambre
--yayaw-infoLes statuts informatifs : tags info (depuis la v3.37.0).Le --primary du thème
--yayaw-highlightLe terme recherché surligné dans l'arborescence.--yayaw-warning, sinon jaune
--yayaw-file-folder, --yayaw-file-image, --yayaw-file-video, --yayaw-file-audio, --yayaw-file-document, --yayaw-file-archive, --yayaw-file-codeLes icônes de l'arborescence, par type de fichier.Les --chart-1 à --chart-5 du thème

Définissez-les à côté des tokens de votre thème, une fois par thème :

:root {
  --yayaw-success: oklch(0.55 0.15 150);
  --yayaw-warning: oklch(0.7 0.16 70);
  --yayaw-highlight: oklch(0.85 0.17 90);
}

.dark {
  --yayaw-success: oklch(0.72 0.2 150);
  --yayaw-warning: oklch(0.8 0.15 80);
}

Les tags danger et les états destructifs lisent --yayaw-danger, qui se replie sur le --destructive du thème. React et Vue lisent les mêmes variables.

Depuis la v3.37.0, tout ce qui est sélectionné partage une même surface du thème : un nombre lié enfoncé, l'onglet de vue sélectionné et les lignes sélectionnées sont dessinés sur accent avec accent-foreground, et la barre d'actions groupées est une pilule sur primary avec primary-foreground. Deux autres variables optionnelles façonnent tous les tags : --yayaw-tag-radius (0.35rem par défaut ; 9999px dessine des pilules) et --yayaw-tag-font-weight (400 par défaut).

TypeScript

Yayaw Table est entièrement typé et fournit des helpers de configuration type-safe dans le code copié.