Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document maxComponents on component groups

Chiusa Adatta ai principianti
  • Qualcosa non va?
#243 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
nuxt, php
Ambito
api, documentation

Direzione di ricerca

Inizia da content/4.api/, accanto alla pagina esistente allowedComponents, e leggi la pull request 467 in api-components-bundle per conoscere le regole di conteggio reali e il comportamento 422 prima di scrivere. Copri i punti della issue: il valore predefinito null, cosa conta ai fini del limite, le creazioni e gli spostamenti rifiutati, l'abbassamento del limite e il controllo componentPositions. È completato quando ogni punto è documentato, l'esempio di fixture group('header', allow: [...], max: 1) corrisponde al bundle e il passaggio di aggiornamento è annotato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The bundle adds a maximum number of components per component group: https://github.com/components-web-app/api-components-bundle/pull/467 (issue https://github.com/components-web-app/api-components-bundle/issues/464; module half https://github.com/components-web-app/cwa-nuxt-module/issues/398).

To document (API, content/4.api/, next to allowedComponents):

  • maxComponents on ComponentGroup: null (default) is unlimited, otherwise a positive integer. Read and written with allowedComponents.
  • What counts: the positions the group lists. A dynamic page data position counts as one, a published component with its draft counts once, and a position hidden by allowedComponents does not count.
  • Creating a position in a full group, moving one into it, or creating a component with a position inside a full group is refused with a 422 naming the limit. Moving within the group is always allowed.
  • Lowering the limit below what a group holds deletes nothing. The group takes no more until it is under the limit.
  • A position written inside a component (componentPositions on a component POST) is now also checked against allowedComponents and #[ExplicitAllowOnly].
  • Fixtures: ->group('header', allow: [...], max: 1) on layout, page and component builders; generate-fixtures writes it.
  • Upgrade step: new max_components column on component_group; generate and run a migration.

When the module half lands, the module docs should cover the :max-components prop on <CwaComponentGroup>.

Lingua principale
Vue
Stelle
0
Fork
0
Merge medio
1h 20m
PR unite (30g)
1

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di components-web-app/docs

Tutte le issue di components-web-app/docs

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.