SolidOS / SolidOS/solid-ui

Proposal: Splitting modules into three types of modules - low-level, widgets, and controls

Abierto
#254 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

enhancement
Lenguaje dominante
TypeScript
Estrellas
153
Forks
46
Merge medio
1 d 8 h
PR fusionados (30 d)
7

Descripción

(I've spoken to @timbl about this earlier, and we think this is a good idea, but not written it down here, so thought I would create an issue to open it up for discussion.)

Currently the API of Solid UI is split up into modules that usually have a mix of low- and high-level functionality. To clear up these we propose a convention that splits modules into three types: low-level, widgets, and controls. The idea is that the types handle increasingly complex methods in terms of the DOM elements that are returned.

  1. The low-level methods do not deal with DOM elements at all, but deal with data manipulation and utility functions that are useful when working with Solid.
  2. Widgets return simple DOM elements, such as buttons and other elements that are meant to be woven into a larger compositions.
  3. Controls are complete DOM elements in the sense that they can work stand-alone and can expose complex interactions.

The modules would follow a name convention given their type, e.g. low-level modules would simply be named the functionality they expose, widget modules would be postfixed Widget, and control modules would be postfixed Control. This way a range of functionality that all reflect the same type of functionality could all start with the same name, but the two latter would expose higher complexity, e.g. acl, aclWidget, and aclControl.

We also propose that existing API endpoints that would be deprecated as part of this restructure to be deprecated slowly, giving people who depend on the existing API ample time to update their dependencies.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

Empieza revisando los módulos actuales de Solid UI API y catalogando qué endpoints mezclan utilidades de bajo nivel, widgets y controles. Compara los nombres existentes y las responsabilidades del DOM con las convenciones propuestas y documenta después el alcance de la migración y la deprecación. Se considera terminado cuando se hayan acordado los límites de los módulos, los cambios de nombres y el plan gradual de deprecación.

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

Evaluación

Stack tecnológico
typescript
Área
frontend
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.