getodk / getodk/web-forms

Explicit Engine/client form title API

Open
#75 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
38
Forks
22
PR merge metrics
No merged PRs in 30d

Description

The engine does not currently expose a clear way to access the title of a form. We will likely want to build on existing mechanisms to expose this, namely:

* The `TextRange` abstraction already used for conveying other aspects of text
* Exposed as a getter on the primary instance top level node’s `currentState` object

While we don’t presently support the dynamic aspects of these interfaces, reusing the common pattern will add helpful consistency now… and leave the door open for functionality we can anticipate adding in the future (such as potentially applying form translations to the title itself; or some limited amount of text formatting).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by tracing the existing TextRange abstraction and the primary instance top-level node’s currentState object, since the issue identifies these as the intended integration points. Confirm how other text properties are exposed and define completion as making the form title available through a consistent getter while preserving the existing interface pattern.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.