angular: propagate the enabled state to detail renderers instead of modifying their UI schema

Abierto
  • ¿Algo no está bien?
#2,630 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
68/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
angular, typescript
Área
frontend

Línea de trabajo

Start with packages/angular-material/src/library/util/detail-uischema.ts and the jsonforms-outlet, LayoutChildrenRenderPropsPipe, LayoutRenderer, array layout, object control, list-with-detail, and table renderer entry points named in the issue. Trace how enabled currently reaches React and Vue equivalents, then compare Angular's cloneDeep/setReadonly paths. Done means enabled state reaches nested detail renderers while the supplied UI schema remains unchanged.

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

Descripción

angular material
Is your feature request related to a problem? Please describe.

Follow-up to #2628.

The Angular Material array layout, object control and list with detail disable their detail by calling setReadonly on its UI schema, which writes options.readonly: true into every control. That UI schema is the result of findUISchema, i.e. the user's options.detail or a UI schema from the uischemas registry. #2628 stopped modifying the user's object by deep cloning it first (createDetailUiSchemaResolver in packages/angular-material/src/library/util/detail-uischema.ts), but the renderers still render a modified copy instead of the given UI schema.

The other renderer sets never modify a given schema or UI schema. React and Vue hand the parent's state down as the enabled own prop of JsonFormsDispatch / DispatchRenderer, and isInherentlyEnabled (packages/core/src/mappers/util.ts) falls back to ownProps.enabled.

Downsides of the current Angular approach:

  • The detail UI schema is deep cloned whenever one of its inputs changes, and the renderers need memoization so that this does not happen on every state emission.
  • Toggling the enabled state produces a different UI schema. jsonforms-outlet compares UI schemas with isEqual, so it destroys and re-creates the whole detail, losing any view state inside it, e.g. the selected tab of a nested categorization.
  • Nested and custom renderers receive a UI schema containing readonly options the user never wrote.
Describe the solution you'd like

Propagate the enabled state through the Angular bindings like React and Vue do, and render the detail UI schema as-is:

  • jsonforms-outlet: accept enabled (already part of OwnPropsOfRenderer) in renderProps and hand it to the created renderer, e.g. as disabled on JsonFormsAbstractControl, which getOwnProps already maps to ownProps.enabled.
  • Layout renderers: forward the enabled state to their children, e.g. via LayoutChildrenRenderPropsPipe, so it reaches controls nested in layouts inside a detail. LayoutRenderer currently only takes label and visible from mapStateToLayoutProps.
  • Array layout, object control and list with detail: pass enabled: this.isEnabled() along with the detail's render props and drop the cloneDeep + setReadonly.
  • Table renderer: same for its generated cell UI schemas, which also get setReadonly today.
Describe alternatives you've considered
  • Keep cloning the detail UI schema (current state since #2628). It works and no longer modifies the user's UI schema, but keeps the costs and the view re-creation described above, and stays inconsistent with the other renderer sets.
  • Resolve the readonly state centrally in @jsonforms/core (e.g. a parent-enabled lookup by path) instead of passing props down. This would avoid touching every layout, but has no precedent in the other bindings.
Package

Angular Bindings, Angular Material Renderers

Additional context
  • Once nothing in Angular Material uses them anymore, setReadonly and unsetReadonly in @jsonforms/core (packages/core/src/util/uischema.ts) have no remaining users and could be deprecated.
  • This is a behaviour change for Angular users: controls inside a detail would be disabled via the inherited enabled state instead of a readonly option. For example, an enable rule on a control inside a disabled array keeps taking precedence in both approaches, but custom renderers reading uischema.options.readonly would no longer see it.
Lenguaje dominante
TypeScript
Estrellas
2.8k
Forks
423
Merge medio
5 d 16 h
PR fusionados (30 d)
9

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 eclipsesource/jsonforms

Todos los issues de eclipsesource/jsonforms

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.