@sia-ui/headless
v0.8.0
Published
Platform-agnostic behaviour behind the SIA UI components.
Maintainers
Readme
@sia-ui/headless
Le comportement des composants SIA UI, sans plateforme.
pnpm add @sia-ui/headlessCe paquet utilise React — useState existe aussi en React Native — mais
jamais le DOM, jamais react-dom, jamais une feuille de style.
import {
useSliderState, // pas, bornes, pourcentages, poignées
useDisclosureState, // ouverture, fermeture, phase de sortie
overlayStack, // empilement des couches, qui est au-dessus
computeFloatingPosition, // placement, retournement, clamp
createSessionStore, // session : vérification, connexion, expiration
useCan, // droits, évaluateur injecté
useTableQuery, // état d'une liste, synchronisable avec l'URL
useRealtimeStatus, // état d'une connexion temps réel
FRENCH, ENGLISH, // les textes des composants, en deux langues
} from "@sia-ui/headless";FRENCH et ENGLISH suivent le format SiaLocale : la langue des dates et
nombres, le vocabulaire commun et un groupe typé par composant. Une
application qui a sa propre i18n remplit le même format ; formatMessage et
plural gèrent {count} et les pluriels _one / _other.
La règle : si le code mesure ou rend, il reste dans la plateforme; s'il calcule ou décide, il descend ici. C'est ce qui évitera d'écrire deux fois chaque composant le jour où le mobile arrivera.
Place dans SIA UI
@sia-ui/tokens valeurs : couleurs, espacements, mouvement, vocabulaire
@sia-ui/utils fonctions sans dépendance
@sia-ui/api client HTTP — indépendant de l'interface
@sia-ui/headless comportement, avec React, sans plateforme
@sia-ui/react primitives de runtime DOM
@sia-ui/react-web composants DOM
@sia-ui/react-native composants natifs, à venirUne chose s'écrit au niveau le plus bas où elle a du sens, et une seule fois. Voir la documentation.
Contribuer
Le code source principal de SIA UI est privé pour le moment. Les retours publics passent par le dépôt BeatJo/sia-ui-site : bugs, demandes de composants, corrections de documentation et questions d'usage.
- Signaler un bug : https://github.com/BeatJo/sia-ui-site/issues
- Lire la documentation : https://beatjo.github.io/sia-ui-site/
- Voir la démonstration : https://beatjo.github.io/sia-ui-site/preview/
Les contributions directes au code des packages se font sur invitation dans le dépôt source privé.
Journal des changements
Le contenu ci-dessous reprend intégralement CHANGELOG.md pour rester visible sur npm.
@sia-ui/headless
0.8.0
Minor Changes
- Français et anglais livrés, temps réel, calendrier réécrit, suivi d'opérations.
- Deux langues —
FRENCHetENGLISH(@sia-ui/headless), au formatSiaLocale: la langue de formatage (language), le vocabulaire commun et un groupe typé par composant. Plus aucun texte en dur dans les composants,aria-labelcompris ; dates, nombres et pluriels suiventlanguage. Une application qui a sa propre i18n remplit le même format.formatMessageetplural({count}, clés_one/_other).ENGLISH_STATUS_MESSAGES(@sia-ui/api) à côté deFRENCH_STATUS_MESSAGES. Seul changement de forme :EventCalendarLabels.more, qui était une fonction, devientmore_one/more_otheravec{count}. SiaProviderseul fournisseur — il prendlocaleetdefaults, et s'imbrique pour une section.SiaConfigProviderest obsolète.- Temps réel —
createRealtimeBinding,socketIoSource,eventSourceSource(@sia-ui/api),useRealtimeStatus,LiveIndicator. EventCalendarréécrit — vues mois, semaine, jour, agenda ; variantes ; mode étroit.EventManager: créer, consulter, modifier, supprimer.- Nouveaux composants —
AccountMenu,ColorModeToggle,LogStream,JsonView,JobProgress,BrandIcon;SunIcon,MoonIcon. - Formulaires —
validateAsyncpar champ,submitProps.disabledrespecté ;controlPropssur une propriété de ressource. - Tons lisibles en mode sombre —
--sia-<ton>-foreground, calculés pour le contraste ; noms de variables CSS en kebab-case. - Couches en portail — menus, calendriers, boîtes et toasts, rendus hors
de
[data-sia-root], reprennent la police et la couleur de texte du système au lieu de celles du navigateur. DraweretModal— la fermeture est signalée tout de suite ; un double clic à l'ouverture ne referme plus.- Documentation — la présentation décrit chaque brique métier (session, greffons d'API, ressources, formulaires, temps réel, langues, utilitaires) avec son scénario et un exemple.
- Props des sous-composants — chaque composant composé expose celles de
ce qu'il utilise (
…Props) ;pnpm check:slot-propsle vérifie.
- Deux langues —
Patch Changes
- Updated dependencies
- @sia-ui/[email protected]
0.7.1
Patch Changes
- Aligne les packages publics de SIA UI sur la version 0.7.1 afin que les huit packages restent sur une version commune.
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.7.0
Patch Changes
Adaptateur TanStack Router, mises à jour en
PATCH, etsecretChanges.useDataTableQuery({ router })— adaptateur TanStack Router livré et testé (createTanStackRouterStorage). La recette de la documentation mettaitpage=2entre guillemets (page=%222%22) et la page retombait à 1 ; les nombres passent désormais comme nombres, sans perte pour les filtres.- Un tableau n'écrit plus que ses propres clés (
mergeTableQuerydans@sia-ui/headless) : deux tableaux préfixés sur une page, ou un onglet dans l'URL, ne s'effacent plus l'un l'autre — avec l'URL du navigateur comme avec un routeur. createQueryResource(service, { updateMethod: "PATCH" })— pour une API qui n'accepte que des mises à jour partielles.secretChanges(entries, storedKeys)— ce qu'il faut envoyer après une saisie dansSecretFields:{ set, remove, missing }.
Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.6.0
Minor Changes
- Rôles, requêtes serveur, ressources par mode, et deux blocs de console.
- Rôles — la couche d'accès lit les rôles de la session sous la forme
role:<nom>(role("admin")), avec les trois évaluateurs. - Tableaux servis par le serveur —
useDataTableQueryaccepte unstorage(TanStack Router, React Router) etserverParamspour les noms attendus (limit,sort+order,ASC/DESC).toServerParamsdans@sia-ui/headless. - TanStack Query —
createQueryResource(service): clés emboîtées, options de requête avec annulation, mutations qui invalident ce qu'elles rendent périmé. Aucune dépendance à TanStack. - Ressources —
inFormetrequiredpar mode ("create","edit"),valuepour une colonne calculée. - En-têtes —
PageHeaderlevel,CrudPageheadingLevel. Le repli suit la place disponible ; les actions ne s'écrasent plus. - Nouveaux —
SecretFields(secrets en écriture seule),ActivityLog(journal filtré par le serveur),StatusBadgeettoneOf, dix icônes de console. - Les icônes des boutons de
CrudPageetDataTablepassent parleftIcon: elles ne se collent plus au libellé.
- Rôles — la couche d'accès lit les rôles de la session sous la forme
Patch Changes
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.5.0
Minor Changes
Erreurs serveur dans les formulaires, client HTTP plus sûr, registre vérifié.
Défauts
- Registre
drawer—context.tset la dépendanceiconsmanquaient :sia-ui add app-shellproduisait un projet qui ne compilait pas. Un test vérifie désormais que chaque import relatif de chaque entrée est apporté par son installation. sia-ui.cssposebox-sizing: border-box(spécificité nulle). Sans reset côté projet,AppShelldébordait de 32 px.@sia-ui/apine rejoue plus d'office queGETetHEAD(retryMethods). Une écriture n'est rejouée que si l'appel poseretry.- Plus aucun avertissement
react-hooks/exhaustive-depsdans les composants.
Formulaires et erreurs serveur
Formintercepte un envoi rejeté : erreurs de champ sous les champs, le reste dans une alerte.onSubmitpeut aussi rendre{ champ: message }(FormSubmitResult), dansuseLocalForm,Form,CrudPageet l'adaptateur react-hook-form.CrudPagegarde alors sa boîte ouverte.- Les erreurs posées par
setErrorssurvivent à la validation locale jusqu'à la modification de leur champ. HttpError.toFormErrors(), optionfieldErrorsdu client et préréglagenestFieldErrors(class-validator).readSubmitErrorethasFormErrorsdans@sia-ui/headless.- La pagination à plat
{ data, total, page, limit }est reconnue, etgetne déballe plusdataquand l'objet porte une pagination.
Tableaux
searchDelaysurDataTableetCrudPage.CrudPageplace lesextraRowActionsavant « Supprimer ».
- Registre
Pagination, téléphone et recherche du
Select.Paginationpropose le nombre de lignes par page :pageSize,onPageSizeChange,pageSizeOptions,pageSizeLabel, etrenderPageSizepour remplacer le contrôle.CrudPagetransmet les trois premières. Nouvelle clé de libelléperPage(« Par page »).- La page courante de
Paginationn'est plus blanche sur blanc au survol. PhoneInputchoisit l'indicatif dans leSelectdu système, avec recherche, à la place du<select>natif.Select:variant="embedded"etrenderValue; recherche insensible aux accents ; Entrée choisit le premier résultat après un filtrage.
Patch Changes
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.4.0
Minor Changes
- Aligne tous les packages publics SIA UI sur la version 0.4.0 afin de fournir un ensemble cohérent à installer, documenter et maintenir.
Patch Changes
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.3.2
Patch Changes
- Ajoute l’identité visuelle officielle de SIA UI et améliore la documentation publique, les changelogs et les ressources de contribution.
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.3.1
Patch Changes
- Expose public contribution flow on npm
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.3.0
Minor Changes
Une ressource se déclare une fois, cinq composants refondus, et une documentation qui décrit le produit plutôt que son développement.
Déclarer une ressource
defineResourcedécrit un objet métier une seule fois. Les colonnes du tableau, les champs du formulaire, les lignes de la vue de détail, la validation, les clés de recherche et les quatre règles de droits en sont dérivés — et chaque dérivation reste remplaçable par la prop correspondante.<CrudPage resource={FACTURE} data={factures} can={can} onSubmit={…} onDelete={…} />Le rendu se déduit du type : un
currencys'affiche formaté et aligné à droite, unselectavec sestonesdevient une pastille, unedatepasse par le format local.permissions: "auto"applique la convention<nom>.<verbe>.Les quatre opérations ouvrent leurs propres boîtes
CrudPagen'appelle plus seulement un gestionnaire : déclarerfieldsetonSubmitsuffit à obtenir un formulaire vide en création, le même prérempli en modification, et une vue de détail.onCreate,onEditetonViewrestent la porte de sortie vers une page dédiée — fournis, ils passent devant la boîte.Les boîtes n'inventent rien :
Modalpour la boîte,Formpour la saisie,Descriptionspour la lecture.Cinq composants refondus
Sidebar— le rail réduit n'enferme plus ses sous-menus : ils sortent en volet. Profondeur illimitée, droits en cascade, trois variantes.AppShell— se branche sur n'importe quel routeur par une seule chaîne, l'adresse courante. Trois états de barre, tiroir ou onglets bas sur mobile, filtrage des droits fait une seule fois.Avatar— teinte dérivée du nom, repli peint sous l'image, quatre états de présence, et des piles qui résument leur surplus.DataTable— actions de ligne avec droits et confirmation, sélection et barre groupée, vue en cartes, trois densités, états de chargement, d'erreur et de vide.CrudPage— réécrit : il tenait en neuf lignes et n'offrait aucune des quatre opérations qui lui donnent son nom.
Ruptures
CrudPage:actionsportait des nœuds d'en-tête, ils vont dansheaderActions.dataest requis, etcolumnsl'est aussi à moins qu'uneresourcene les fournisse.SidebaretAppShell: les props ont changé. Voir La navigation latérale et La coquille d'application.
Documentation
Les cent trois composants ont désormais une page de référence — ce qu'ils font, comment les installer, et toutes leurs props avec type et valeur par défaut. Ces pages sont écrites par le code : les props viennent des types, les descriptions de leurs commentaires, la commande d'installation du registre.
Le catalogue est passé de seize sections en deux langues à neuf, ordonnées du plus général au plus assemblé. Les comptes rendus de développement ont été retirés de la documentation : ils décrivaient un chemin parcouru, pas un produit.
Patch Changes
- Updated dependencies
- @sia-ui/[email protected]
- @sia-ui/[email protected]
0.2.0
Minor Changes
e4e4a72: Annonces, session et droits, formulaires sans dépendance, et vingt entrées de registre de plus.
Composants
- Annonces —
toast()s'appelle hors de React, varianteloading, boutons d'action, six coins réglables par annonce, balayage pour écarter, suivi de promesse. - Session et droits —
createSessionStoreavec sa machine à quatre états,createAccessLayerà évaluateur injecté,RequireSessionsans routeur. - Formulaires — le contrat
FormAdapteretuseLocalForm, sans dépendance.Formest écrit sur le contrat : il n'importe ni react-hook-form ni zod, et se câble à l'un ou l'autre par un adaptateur. - Vingt entrées de registre de plus —
progress,dropdown-menu,accordion,sidebar,breadcrumb,steps,toggle,scroll-area,hover-card,aspect-ratio,input-number,password-input,phone-input,chart,require-session,form… - Thème — mode
system, persistance et script anti-clignotement dansSiaProvider, en remplacement denext-themes.
@sia-ui/apiLe client HTTP typé est un paquet à part : ni React, ni DOM, ni tokens. Il s'installe seul, et copier un
Badgedepuis le registre ne l'entraîne pas.Utilitaires
@sia-ui/utilspasse de six à quatorze modules :query,async,collection,object,validation,file,clipboard,locale.Archives
- Plus de sourcemaps : elles pesaient environ soixante pour cent de chaque
archive —
@sia-ui/react-webpasse de 2,1 Mo à 759 Ko. - Chaque paquet porte enfin la licence MIT qu'il annonce.
Vitrine en ligne
Trois surfaces publiées sur GitHub Pages à chaque poussée sur
main: la documentation à la racine, le catalogue Storybook sous/storybook/, la démonstration sous/preview/. Le site de documentation est construit depuis les fichiers dedocs/eux-mêmes, qui restent du Markdown ordinaire.Le registre n'est plus une voie sans retour
Installer était jusqu'ici définitif : plus rien ne disait ce qu'on avait, ce qu'on avait retouché, ni ce qui avait bougé en amont — donc rien ne permettait de corriger ni de déprécier une entrée après coup.
sia-ui.lock.json, écrit à chaqueadd: version, date et empreinte de chaque fichier copié.- Quatre commandes :
diff,remove,doctor,list --outdated.removerefuse de casser un voisin ou d'effacer un fichier retouché. - Cycle de vie des entrées —
experimental,stable,deprecated,removed— avecreplacedBy.addrefuse ce qui est retiré,doctorsignale ce qui est déprécié chez qui l'a déjà installé. - Journal du registre, entrée par entrée, dont
pnpm check:changelogrefuse qu'il mente. - Registre servi en HTTP, versionné par l'URL :
…/r/v1/. Corriger une entrée n'oblige plus à republier la CLI.
Corrections
- La case à cocher et le bouton radio masquaient leur contrôle natif en
opacity:0. Le navigateur le peignait encore sous le visuel personnalisé, et ce dessin clignotait au clic. Les deux utilisent désormais la recette partagée.sia-visually-hidden, qui le découpe hors du rendu sans le retirer du clavier. - Une case à cocher non contrôlée ne se peignait jamais cochée : l'
<input>basculait, mais la classe qui dessine la case ne suivait pas. - Le curseur de survol des graphes était ovale, et le tracé de la courbe haché : les marqueurs sont sortis du SVG, qui est étiré sans conserver ses proportions.
- L'entrée
drawerdu registre était impossible à installer — elle importait deux dossiers que la CLI ne copie pas.
- Annonces —
Patch Changes
- Updated dependencies [e4e4a72]
- @sia-ui/[email protected]
- @sia-ui/[email protected]
Licence
MIT
