Make fields read-only when Collect external app functionality is configured

Open
#928 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript
Domain
frontend, web-dev

Research direction

Start by reading the linked Collect external-app documentation to understand the single-value appearance and multiple-value intent attribute configurations, then locate how Web Forms determines field editability. Done means affected fields are read-only when either configuration is present, with coverage for both cases in the test plan requested by the issue.

Written by the indexing model from the issue text.

Description

Description

Collect has two ways to configure external app launch: an appearance for returning a single value and an intent attribute for returning multiple values.

We don't have any plans to support these in Web Forms but one thing we could do to better match the intent of the form is to make the affected field(s) read-only. That would be more useful for both cross-platform forms and edits. For cross-platform forms, users may use query parameter defaults for Web Forms to push values in where they would call out to an app with Collect.


Checklist
  • Does it need UI/UX design?
    • Yes. Describe the UI/UX requirements or attach a Figma link in the "Design" section.
    • No
  • Does it need API design?
    • Yes. Specify the endpoints, methods, or data structures needed.
    • No
  • Does it need design around state flow?
    • Yes. Outline the state flow requirements.
    • No
  • Does it need a test plan?
    • Yes. Add the test plan as a comment in this task or attach the document.
    • No

User Stories
  • As a [user type],
    I want [functionality],
    so that [benefit].

Design
  • Figma: [Insert URL]
  • Design Docs: [Insert URL]

Dependencies

Additional Notes

Related Issues
Dominant language
TypeScript
Stars
38
Forks
24
PR merge metrics
No merged PRs in 30d

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getodk/web-forms

All issues in getodk/web-forms

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.