Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Component groups: allowedComponents by component name, and what an empty list means

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#96 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
nuxt, typescript
Área
documentation

Línea de trabajo

Comienza con la documentación del grupo de componentes y usa los ejemplos de CwaComponentGroup en este issue como referencia para la sintaxis recomendada. Documenta CwaComponentNames, los tres estados posibles de allowed-components, las implicaciones para la validación y el comportamiento de actualización de los grupos sin una lista almacenada. La tarea se considera terminada cuando la documentación cubre correctamente cada caso indicado y la nota sobre la actualización.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

Source: components-web-app/cwa-nuxt-module#352 and #351.

What changed

Component names (#352). <CwaComponentGroup :allowed-components> accepts component names as well as collection IRIs:

<CwaComponentGroup reference="main" :location="publishedIri" :allowed-components="[CwaComponentNames.HtmlContent, CwaComponentNames.WatchPastConference]" />
<!-- identical -->
<CwaComponentGroup reference="main" :location="publishedIri" :allowed-components="['HtmlContent', 'WatchPastConference']" />
  • CwaComponentNames (constant) and CwaComponentName (type) are generated from each app/cwa/components/<Name>/<Name>.vue and auto-imported. Editors complete them, and vue-tsc rejects a typo or a removed component.
  • Names are resolved to endpoints at runtime from the API docs. If a name matches no API component, a warning is logged and the group is not synced.
  • Collection IRIs ('/component/html_contents') still work, alone or mixed with names.

Groups with no stored list (#351). Groups created by fixtures or the REST API without a list now receive the template's list on the first signed-in load.

To document

  • Names as the recommended form in the component group docs, with the constant.
  • The three states of the prop:
    • a complete list — must name every type already placed in the group, plus any #[ExplicitAllowOnly] type to offer. A placed type missing from the list fails validation on its next save.
    • omitted — leaves the stored list as it is.
    • null or [] — unrestricted (explicit-only types stay hidden).
  • Upgrade note: groups that never had a list will be PATCHed with the template's list on the first admin load, so check the lists are complete first.
Lenguaje dominante
Vue
Estrellas
0
Forks
0
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de components-web-app/docs

Todos los issues de components-web-app/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.