-
Notifications
You must be signed in to change notification settings - Fork 187
feat(gui): author the Form View in place with an edit mode #8455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
71 changes: 71 additions & 0 deletions
71
frontend/src/app/common/formly/editable-label-wrapper/editable-label-wrapper.component.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| <!-- Authoring: the label is the input, so what you type is what the reader reads. --> | ||
| <div | ||
| class="lbl-row" | ||
| *ngIf="props.authoring"> | ||
| <input | ||
| class="lbl-input" | ||
| [value]="props.authorName" | ||
| [placeholder]="props.schemaLabel" | ||
| (change)="onRename($event)" | ||
| [attr.aria-label]="'Label shown above this input'" | ||
| [title]="'Shown above this box. Empty keeps ' + props.schemaLabel" /> | ||
| <!-- An input the reader can only lose by removing it altogether has no eye: offering | ||
| one here would be a second place to decide the same thing. --> | ||
| <button | ||
| *ngIf="props.canHide !== false" | ||
| type="button" | ||
| class="lbl-eye" | ||
| [class.off]="props.authorHidden" | ||
| (click)="onToggleHidden()" | ||
| [attr.aria-pressed]="props.authorHidden" | ||
| [attr.aria-label]="props.authorHidden ? 'Hidden from the form. Click to show' : 'Shown on the form. Click to hide'" | ||
| [title]="props.authorHidden ? 'Hidden from the form' : 'Shown on the form'"> | ||
| <i | ||
| nz-icon | ||
| [nzType]="props.authorHidden ? 'eye-invisible' : 'eye'" | ||
| nzTheme="outline"></i> | ||
| </button> | ||
| </div> | ||
|
|
||
| <!-- The name box above edits the label; it is not the label. The control below still needs a | ||
| programmatic name (decorate blanks formly's own), so it gets one that follows the current name, | ||
| present for assistive technology only. --> | ||
| <label | ||
| class="lbl-sr-only" | ||
| *ngIf="props.authoring" | ||
| [attr.for]="id"> | ||
| {{ props.authorName || props.schemaLabel }} | ||
| </label> | ||
|
|
||
| <!-- Everyone else just reads it. This wrapper blanks formly's own label (decorate sets label to ""), | ||
| so this one has to do that label's job in full: `for` ties it to the control (formly gives the | ||
| control the field id), or the reader's input would show a name and announce none. --> | ||
| <label | ||
| class="lbl-static" | ||
| *ngIf="!props.authoring && (props.authorName || props.schemaLabel)" | ||
| [attr.for]="id"> | ||
| {{ props.authorName || props.schemaLabel }} | ||
| </label> | ||
|
|
||
| <div [class.dimmed]="props.authoring && props.authorHidden"> | ||
| <ng-container #fieldComponent></ng-container> | ||
| </div> | ||
113 changes: 113 additions & 0 deletions
113
frontend/src/app/common/formly/editable-label-wrapper/editable-label-wrapper.component.scss
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| .lbl-row { | ||
| display: flex; | ||
| align-items: center; | ||
| gap: 6px; | ||
| margin-bottom: 2px; | ||
| } | ||
|
|
||
| /* A faint dashed box at rest signals the title is editable (authors could not tell it was | ||
| a field before); it firms up on hover and turns into a real input on focus. */ | ||
| .lbl-input { | ||
| flex: 1; | ||
| min-width: 0; | ||
| border: 1px dashed #dcdcdc; | ||
| border-radius: 4px; | ||
| background: none; | ||
| padding: 1px 5px; | ||
| font-size: 13px; | ||
| font-weight: 500; | ||
| color: rgba(0, 0, 0, 0.85); | ||
| outline: none; | ||
| cursor: text; | ||
|
|
||
| &::placeholder { | ||
| color: rgba(0, 0, 0, 0.45); | ||
| font-weight: 400; | ||
| } | ||
|
|
||
| &:hover { | ||
| border-style: solid; | ||
| border-color: #b0b0b0; | ||
| } | ||
|
|
||
| &:focus { | ||
| border-style: solid; | ||
| border-color: #1890ff; | ||
| background: #fff; | ||
| } | ||
| } | ||
|
|
||
| .lbl-eye { | ||
| flex: none; | ||
| border: 0; | ||
| background: none; | ||
| cursor: pointer; | ||
| line-height: 0; | ||
| padding: 3px; | ||
| border-radius: 4px; | ||
| color: rgba(0, 0, 0, 0.45); | ||
| font-size: 14px; | ||
|
|
||
| &:hover { | ||
| color: rgba(0, 0, 0, 0.85); | ||
| background: #f5f5f5; | ||
| } | ||
|
|
||
| &:focus-visible { | ||
| outline: 2px solid #1890ff; | ||
| outline-offset: 1px; | ||
| } | ||
|
|
||
| /* Hidden is a state worth seeing at a glance, so it keeps the accent rather than | ||
| fading like the rest of the row. */ | ||
| &.off { | ||
| color: #1890ff; | ||
| } | ||
| } | ||
|
|
||
| /* Present for assistive technology only: the visible name box is the label's editor, not the | ||
| control's label. Standard visually-hidden recipe: off-layout, clipped, never display:none (which | ||
| would remove it from the accessibility tree too). */ | ||
| .lbl-sr-only { | ||
| position: absolute; | ||
| width: 1px; | ||
| height: 1px; | ||
| padding: 0; | ||
| margin: -1px; | ||
| overflow: hidden; | ||
| clip: rect(0, 0, 0, 0); | ||
| white-space: nowrap; | ||
| border: 0; | ||
| } | ||
|
|
||
| .lbl-static { | ||
| display: block; | ||
| font-size: 13px; | ||
| color: rgba(0, 0, 0, 0.85); | ||
| margin-bottom: 2px; | ||
| } | ||
|
|
||
| /* A hidden field stays visible to its author, faded, so they can see what they removed | ||
| and put it back. The reader never renders it at all. */ | ||
| .dimmed { | ||
| opacity: 0.4; | ||
| } |
190 changes: 190 additions & 0 deletions
190
...end/src/app/common/formly/editable-label-wrapper/editable-label-wrapper.component.spec.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import { ComponentFixture, TestBed } from "@angular/core/testing"; | ||
| import { FormlyFieldConfig } from "@ngx-formly/core"; | ||
| import { EditableLabelWrapperComponent } from "./editable-label-wrapper.component"; | ||
|
|
||
| describe("EditableLabelWrapperComponent", () => { | ||
| let component: EditableLabelWrapperComponent; | ||
| let fixture: ComponentFixture<EditableLabelWrapperComponent>; | ||
|
|
||
| const state = (overrides: Partial<Parameters<typeof EditableLabelWrapperComponent.decorate>[1]> = {}) => ({ | ||
| authoring: true, | ||
| name: "My input", | ||
| hidden: false, | ||
| fallback: "File Key", | ||
| ...overrides, | ||
| }); | ||
|
|
||
| beforeEach(async () => { | ||
| await TestBed.configureTestingModule({ | ||
| imports: [EditableLabelWrapperComponent], | ||
| }).compileComponents(); | ||
| fixture = TestBed.createComponent(EditableLabelWrapperComponent); | ||
| component = fixture.componentInstance; | ||
| }); | ||
|
|
||
| describe("decorate", () => { | ||
| it("appends the wrapper after any existing ones", () => { | ||
| const config: FormlyFieldConfig = { key: "k", wrappers: ["form-field"] }; | ||
| EditableLabelWrapperComponent.decorate( | ||
| config, | ||
| state(), | ||
| () => {}, | ||
| () => {} | ||
| ); | ||
| expect(config.wrappers).toEqual(["form-field", "editable-label-wrapper"]); | ||
| }); | ||
|
|
||
| it("blanks formly's own label so the wrapper does not print it twice", () => { | ||
| const config: FormlyFieldConfig = { key: "k", props: { label: "File Key" } }; | ||
| EditableLabelWrapperComponent.decorate( | ||
| config, | ||
| state(), | ||
| () => {}, | ||
| () => {} | ||
| ); | ||
| expect(config.props?.["label"]).toBe(""); | ||
| }); | ||
|
|
||
| it("maps the naming state and callbacks into props", () => { | ||
| const rename = vi.fn(); | ||
| const setHidden = vi.fn(); | ||
| const config: FormlyFieldConfig = { key: "k" }; | ||
| EditableLabelWrapperComponent.decorate(config, state({ name: "Genes", hidden: true }), rename, setHidden); | ||
| expect(config.props?.["authoring"]).toBe(true); | ||
| expect(config.props?.["authorName"]).toBe("Genes"); | ||
| expect(config.props?.["authorHidden"]).toBe(true); | ||
| expect(config.props?.["schemaLabel"]).toBe("File Key"); | ||
| expect(config.props?.["renameField"]).toBe(rename); | ||
| expect(config.props?.["setFieldHidden"]).toBe(setHidden); | ||
| }); | ||
|
|
||
| it("defaults canHide to true, and honors an explicit false", () => { | ||
| const shown: FormlyFieldConfig = { key: "k" }; | ||
| EditableLabelWrapperComponent.decorate( | ||
| shown, | ||
| state(), | ||
| () => {}, | ||
| () => {} | ||
| ); | ||
| expect(shown.props?.["canHide"]).toBe(true); | ||
|
|
||
| const locked: FormlyFieldConfig = { key: "k" }; | ||
| EditableLabelWrapperComponent.decorate( | ||
| locked, | ||
| state({ canHide: false }), | ||
| () => {}, | ||
| () => {} | ||
| ); | ||
| expect(locked.props?.["canHide"]).toBe(false); | ||
| }); | ||
| }); | ||
|
|
||
| describe("handlers", () => { | ||
| it("onRename forwards the input's value to renameField", () => { | ||
| const rename = vi.fn(); | ||
| component.field = { props: { renameField: rename } } as unknown as FormlyFieldConfig; | ||
| component.onRename({ target: { value: "New name" } } as unknown as Event); | ||
| expect(rename).toHaveBeenCalledWith("New name"); | ||
| }); | ||
|
|
||
| it("onRename is inert on a reader mount, where decorate omitted rename", () => { | ||
| const config: FormlyFieldConfig = { key: "k", props: { label: "Predicates" } }; | ||
| EditableLabelWrapperComponent.decorate(config, { | ||
| authoring: false, | ||
| name: "Predicate", | ||
| hidden: false, | ||
| fallback: "Predicates", | ||
| canHide: false, | ||
| }); | ||
| component.field = config; | ||
|
|
||
| expect(config.props?.["label"]).toBe(""); | ||
| expect(() => component.onRename({ target: { value: "x" } } as unknown as Event)).not.toThrow(); | ||
| }); | ||
|
|
||
| it("onToggleHidden flips the current hidden state through setFieldHidden", () => { | ||
| const setHidden = vi.fn(); | ||
| component.field = { props: { authorHidden: false, setFieldHidden: setHidden } } as unknown as FormlyFieldConfig; | ||
| component.onToggleHidden(); | ||
| expect(setHidden).toHaveBeenCalledWith(true); | ||
| }); | ||
| }); | ||
|
|
||
| describe("template", () => { | ||
| it("while authoring, renders the name input seeded with authorName and the schema label as placeholder", () => { | ||
| component.field = { | ||
| props: { authoring: true, authorName: "Genes", schemaLabel: "File Key", canHide: true, authorHidden: false }, | ||
| } as unknown as FormlyFieldConfig; | ||
| fixture.detectChanges(); | ||
|
|
||
| const input = fixture.nativeElement.querySelector("input.lbl-input") as HTMLInputElement; | ||
| expect(input).toBeTruthy(); | ||
| expect(input.value).toBe("Genes"); | ||
| expect(input.placeholder).toBe("File Key"); | ||
| // the hide toggle is offered when canHide is not false | ||
| expect(fixture.nativeElement.querySelector("button.lbl-eye")).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("while authoring, still names the control for assistive technology, following the current name", () => { | ||
| // The visible box edits the label; it is not the control's label. decorate blanks formly's | ||
| // own, so without this the control below would have no accessible name while authoring. | ||
| component.field = { | ||
| id: "formly_3_genes", | ||
| props: { authoring: true, authorName: "Genes", schemaLabel: "File Key", canHide: true }, | ||
| } as unknown as FormlyFieldConfig; | ||
| fixture.detectChanges(); | ||
|
|
||
| const label = fixture.nativeElement.querySelector("label.lbl-sr-only") as HTMLLabelElement; | ||
| expect(label.getAttribute("for")).toBe("formly_3_genes"); | ||
| expect(label.textContent?.trim()).toBe("Genes"); | ||
| // The name box itself is labelled on its own and never points at the control. | ||
| expect(fixture.nativeElement.querySelector("input.lbl-input").getAttribute("aria-label")).toBeTruthy(); | ||
|
|
||
| component.field.props!["authorName"] = ""; | ||
| fixture.detectChanges(); | ||
| expect(label.textContent?.trim()).toBe("File Key"); | ||
| }); | ||
|
|
||
| it("hides the eye toggle when canHide is false", () => { | ||
| component.field = { | ||
| props: { authoring: true, authorName: "Genes", schemaLabel: "File Key", canHide: false }, | ||
| } as unknown as FormlyFieldConfig; | ||
| fixture.detectChanges(); | ||
| expect(fixture.nativeElement.querySelector("button.lbl-eye")).toBeNull(); | ||
| }); | ||
|
|
||
| it("for a reader, renders a plain static label from authorName, tied to the control by id", () => { | ||
| // decorate blanks formly's own label, so this one is the control's only label: without `for` | ||
| // the reader's input would show a name but have no accessible name at all. | ||
| component.field = { | ||
| id: "formly_3_genes", | ||
| props: { authoring: false, authorName: "Genes", schemaLabel: "File Key" }, | ||
| } as unknown as FormlyFieldConfig; | ||
| fixture.detectChanges(); | ||
|
|
||
| expect(fixture.nativeElement.querySelector("input.lbl-input")).toBeNull(); | ||
| const label = fixture.nativeElement.querySelector("label.lbl-static") as HTMLLabelElement; | ||
| expect(label.textContent?.trim()).toBe("Genes"); | ||
| expect(label.getAttribute("for")).toBe("formly_3_genes"); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.