Repository navigation
Improve DX of element reference attributes by allowing relative references instead of only ids #10143
Description
Edit: Explainer Draft
Problem statement
Many HTML attributes need to reference one or more HTML elements in the document. This includes:
- Popovers (
popovertarget) - Invokers (
invoketarget) - A host of ARIA attributes (e.g.
aria-describedby,aria-labelledby,aria-activedescendant,aria-controls,aria-details,aria-flowto,aria-ownsetc.) for, in<label>and<output>listin<input>- the new
anchorattribute
It is also a frequent use case in author web components as well, with WC authors coming up with wildly inconsistent solutions because they are forced to choose between ergonomics and consistency with the web platform. Most copy HTML as a source of truth and good design decisions, which makes the problem worse.
Currently, the only way to specify such references is to give these elements ids (if they don't already have them) and using these ids to link to them in these attributes.
This imposes high friction (especially when not using tooling to generate HTML), as authors then need to come up with suitable ids for elements that wouldn't otherwise have one and manually do the linking (and as we know, naming things is one of the hardest things in Computer Science 😁 ). It also introduces error conditions, as it is a common authoring mistake to change an id and forgetting to change the id references to it, pasting a chunk of HTML and forgetting to edit all the references, or ending up with broken references due to accidental duplicate ids.
This is a very common author pain point, and authors are pretty vocal about it: DX-related complaints were the 3rd biggest a11y complaint in the preliminary State of HTML results. It especially hurts a11y, since the effects of broken references in the a11y tree are not always obvious, and the more friction it takes to make HTML accessible, the less likely authors are to do it. And while for <label> this is somewhat mitigated by the option to make the association implicitly by nesting the form control within the <label>, for the other cases there is no similar option.
Being able to link to elements in a way that is relative to the element the attribute is specified on would solve all of these issues, and make writing ARIA much more pleasant.
Some considerations are:
- The migration path for authors. It would introduce an undesirable cliff, if using a relative reference suddenly requires changing all of their existing absolute references. The more substantial the edit required, the sharper the cliff.
- Not all use cases require relative references, so ideally the syntax should allow mixing the two. While a11y-related use cases tend to primarily need relative references, attributes like
listneed both (e.g. a "country" field would need to autocomplete to the same list of countries everywhere).
Relative reference use cases
More research is needed here, but in my experience most relative use cases are pretty simple paths from the current element to the one being referenced. Things like:
- Go N levels up (usually 1-2) and get the first element with a class of
foo - Get the next/previous element
Proposed solutions
There are two components to coming up with a solution:
- Syntax: How to specify elements relative to the current element (i.e. the one the attribute is specified on)?
- Disambiguation: Assuming we don't want to add new attributes for this, how to disambiguate this syntax from the id references currently in use?
1. Disambiguation
In theory IDs can contain any character, though in practice they very rarely contain characters going beyond CSS idents. So how do we come up with a syntax that minimizes conflicts with ids used in the wild? There are two main categories here.
1a. Syntactic switch
This approach allows mixing absolute and relative references even on the same element by using a syntactic switch to say "this is not an id, it's a relative reference".
It would require a fair bit of web compat research to flesh out the details (I can reach out to the HTTP Archive folks), but the main paths here are:
- Imposing restrictions on the relative syntax so that it needs to contain certain characters that are very unlikely to appear in IDs, e.g. that the value needs to begin with
&or:. Ids can still be specified by escaping these characters.
Example:
<label for="& + *">Foo:</label>
<input name="foo" />- A functional syntax that wraps the relative reference (e.g.
selector(),path(),relative(),ref()etc.). This is more verbose, but has the added benefit of clarity and extensibility. If plain names likeselector()are not web-compatible, we could go the route of URL fragments and prepend these functions with a certain symbol to further minimize the odds of collision.
Example:
<label for="selector(+ *)">Foo:</label>
<input name="foo" />1b. Scoping attribute
Instead of a special syntax, this would introduce an additional attribute that switches how references work on an entire subtree.
Ideally, the attribute is not just an opt-in, but also adds value, e.g. by specifying the scope of matching so that references can be simplified. Scopes can be nested, and the parent scope is matched if the closest scope did not yield any results. The syntax of individual attributes need to provide ways to escape the scope, for the use cases where global matching is genuinely desirable.
A big downside of this approach is that because it affects references across a whole subtree, it makes migration more painful, unless we do weird things like "match as an id first, and if that doesn't match anything, try something different", which can be unpredictable and error-prone.
Example:
<li idscope>
<label for="foo">Foo:</label>
<input id="foo" />
</li>
<li idscope>
<label for="foo">Foo:</label>
<input id="foo" />
</li>2. Syntax
I see two avenues here:
- CSS selectors, potentially with severe restrictions, especially at first.
- Identifiers that an already be used on more than one element (e.g.
classorname)
An attribute to restrict scope (see 1b) would be useful for both, but while it is a convenience for 1, it is essential for 2 to be useful.
While a custom microsyntax might be tempting, I would advise against it (we even have a TAG principle in the works advising against custom microsyntaxes).
2a. CSS selectors
CSS has recently introduced relative selectors that start with a combinator and/or can use :scope or & to represent the current element (see 1 2).
If relative selectors could be allowed in these attributes, authors could do things like + .description or .description:has(+ &) etc. If the selector specified matches multiple elements, the first one will be used unless the attribute expects multiple elements.
Not the entirety of CSS selectors needs to be allowed.
In fact, I think an MVP could be as small as just <id-selector> | [<combinator>? [ <type-selector> | '*']? <class-selector>* ]+ (see below wrt combinators).
In syntaxes that involve a scoping attribute (see 1b), <id-selector> could still match globally, providing an escape hatch from the scoping.
Pros:
- Power. CSS selectors are an incredibly powerful querying language and new developments in CSS selectors will automatically make this syntax more powerful as well. Even if only a very restricted subset ships, it would be very easy to progressively enable add CSS selector syntax to the allowlist.
- Familiarity: CSS selectors are a syntax authors are already familiar with.
- Potential to solve more than ergonomics: there are many discussions about cross-root ARIA, as well as discussions about re-introducing some form of a Shadow DOM combinator. Something like this could be a piece of that puzzle.
The main downside seems to be performance. Having to specify "the previous element" with a :has(+ &) that searches the entire DOM tree is likely unacceptable. I would need to check with the rest of the CSS WG, but I suspect that if the WHATWG is interested in pursuing this, we might be open to exploring combinators that go backwards (previous sibling, parent) to facilitate common cases without :has(). Things like - for "previous sibling" and < for parent have been proposed before and add value to authors more generally as well. I suspect this would only be tenable if these kinds of backwards combinators are a possibility and/or combined with an attribute to limit scope. (edit: CSS WG issue filed)
2b. Identifiers
Even something as restricted as being able to specify an identifier and a root for the query would address the vast majority of use cases. So basically all we need is a way to express a non-unique identifier and a scoping attribute to mark the root of the matching.
Candidates for this could be:
- Class names
nameattributeitempropattributepropertyattribute
This produces a very concise, readable syntax for common cases, maintains the same syntax for the individual attributes, and removes the disambiguation problem. However, it is unclear whether a single hierarchy of scopes would be sufficient to cover use cases, and makes it harder to interpret individual values.
There are two strategies here, each with its own tradeoffs.
Only look at non-unique identifiers in subtrees with the scoping attribute
This means authors would have to opt-in to this kind of matching, by using a scoping attribute (e.g. namescope, or even something that specifies the identifier being scoped e.g. refscope="name").
This is more predictable, but makes migration costly. To enable referencing elements globally, the scoping attribute would need to be added to the root element as well, which makes it even harder to mix and match id references with relative references.
Match as id first, fall back to non-unique identifier if no element found with said id
This ensures that copying a chunk of HTML within another does not break, but it means that references can break by simply adding an id in another place in the document, which can be very hard to debug. There is also no precedent in the web platform where the same identifier can mean either id or something else (especially with different scopes!).
3. What if we could fix this without any new syntax?
This is a stretch, but might be worth exploring.
name is an existing attribute that identifies an element similarly to an id, but does not have the restriction of uniqueness.
The algorithm for resolving references could be redefined as:
- First, look for an element with that
id. If found, return that. - Let scopingRoot = referencing element
- While scopingRoot != document
- Look for an element with a
nameequal to the identifier provided inside scopingRoot. - If found, return it.
- Otherwise, let scopingRoot = parent of scopingRoot
- Look for an element with a
I wonder how web-compatible something like that would be. Since it would only make a difference if the reference is broken to begin with, maybe it's not too unrealistic?
I’m still unsure what the best solution is, but I’m leaning towards 3 if it's web-compatible, or 1a + 2a if not, perhaps with an optional scoping attribute.
Rationale:
- Attribute values are self-contained, and can be interpreted by simply looking at the attribute value
- It maintains the ability to copy-paste fragments of HTML without breakage
- Allows mixing absolute and relative references, avoiding cliffs
If there is consensus to pursue this, I could do the research of exploring what syntax could be web-compatible.
Activity
[-]Improve DX of IDREF attributes by allowing relative references instead of only ids[/-][+]Improve DX of element reference attributes by allowing relative references instead of only ids[/+]sashafirsov commentedon Feb 19, 2024
The scope perhaps can be less demanded when the root element for web components become a thing beyond CSS styling. But even with that, the relative selector is highly needed.
The selectors language perhaps need to be addressed in another proposal. As URL can have the protocol, selectors should as well.
CSS and XPath are natively supported by most of browser. Others or extensions of base ones would be polifilled.
LeaVerou commentedon Feb 19, 2024
They already do, as I discuss in the first post. 🙃 The syntax discussion here was about what subset of relative selectors to support, not to define relative selectors.
triskweline commentedon Feb 19, 2024
I can share some pains, design decisions and experiences we had with relative references over the years. This is from my work with Unpoly, an HTML extension where links update fragments instead of full pages. For this we needed a way to reliably target elements.
:has().:originto refer to the current element (:scopewasn't a thing when we named this).[up-layer=any]attribute. I feel this is already an issue in HTML since<dialog>was introduced.<label for="some-id">is that clicking will blindly focus the first element with thatid. Unintuitvely this may match elements in another form, or in another layer. We patch thelabel/inputmatching so elements within the same form are preferred.:has()and:origin, e.g.form:has(:origin) .other-input.formwould first look for the closest ancestorformand only then look through the rest of the page. Alsoform .other-inputwould first try to find.other-inputwithin the same form, before looking at other forms.We have not needed introduce new syntax aside from
:originand:has()(before browser support was there). However, a similiar library htmx uses custom selector synxtax likeclosest .foo.jimmyfrasche commentedon Feb 19, 2024
This is another area where it makes it hard to reason about server side template partials like I discussed re
hNtags in #5033 (comment)Another problem with
idother than uniqueness is that it does way too much.I would like something like this sketch:
A
refscopetag (or maybe it's an attribute) defines a new scope.:rootimplicitly defines a root scope.Elements have a
refattr to use instead ofid. Unlikeidit only defines a name and that name is local to the current scope. (If there are multiple identically named refs, then which one wins should be defined in the standard and browsers should print a warning in the debug console.)If something is referred to by name, the refs in the current scope are searched first. If there's no match, check the parent scope; repeating as necessary until reaching the root scope. If there's no match after all that, check for a matching
id.A tag could have both a
refandidand that may be confusing and certainly not recommended but everything works out.dginev commentedon Feb 19, 2024
The MathML 4 effort has some overlapping interest in improved DX for referencing. Exactly due to the difficulties of managing global ids, we have tentatively introduced a new
argattribute to anchor referencing in MathML Intent, targeting the feature of accessible navigation of math expressions:https://w3c.github.io/mathml/spec.html#intent_reference
Simple example:
We have had the constraint of keeping the traversal algorithm as simple as possible, which has so far kept us from introducing relative selectors (sibling, ancestor). Nevertheless, MathML has viable use cases where relative selectors are quite natural, such as accessible walks through tabular diagrams (realized via
<mtable>).The traversal algorithm for
intent/argreferencing is scoped to the current subtree (references can only point to descendant nodes). It also has an additional stopping condition at nodes carrying theintentorargattributes, to allow stacking of multiple math notations.As we have multi-format content (such as scientific diagrams via SVG+MathML, as well as block equations mixed with text), it would be a significant boost to DX if we could share a uniform referencing scheme.
sorvell commentedon Mar 1, 2024
Feedback
@LeaVerou
It may be worth distinguishing the problems describing 1-to-1 relationships with those describing 1-to-N. For example, ids are not used for
<input type="radio">but are, unfortunately, required for things likearia-controls.I suggest this be promoted to a core goal of the proposal. This is a bit spicy but arguably the current lack of a way to associate elements across scopes violates platform design principles.
I think the problem isn't clearly enough defined to determine if this is true. In particular, the id based system is independent of document structure, and most of the ideas here for a relative system depend on it. That just seems like a trade off that may be better or worse for the various different use cases.
The various options here are a little hard to understand. It'd be great to add some illustrating examples.
@jimmyfrasche
Totally agree, and this may even be the core problem to solve.
Thinking Aloud...
<input type="radio" name="a">since these are form scoped.for,popovertarget,invokertarget. Perhaps the other side should have them as well: e.g.popoverid, etc.idornameis valuable since it makes the naming easier, e.g.refs="popoverA invokerB"LeaVerou commentedon Mar 8, 2024
I just added another proposed idea to the first post:
Thanks for the thoughtful response @sorvell. Some replies:
Interesting. What do you think are the differences?
As an editor of the document you are referencing, I have no idea how that principle relates to this problem. 😁
That said, I'd be fine with making that a core goal of the proposal, though I'm not sure how that will materially affect the odds of it moving forwards.
Why is it a goal to have a referencing system that is independent of document structure? Document structure is not created in a vacuum, it typically reflects hierarchical relationships (and when it doesn't, that's a failing of some web platform technology — e.g. when authors have to put elements directly inside
<body>to make sure they're on top).Also, the id-based system is not going away. That wouldn't be web compatible. Any relative referencing system is in addition to it.
Agreed. I added a few examples, does this help? I could add more if you point me to specific sections that are still unclear.
+1000
Naming things is hard so let's add more naming tasks? 😁
What are some use cases where you may want to have a different name for e.g. popover use cases and a different one for e.g. forms?
Unless any ancestor container could potentially be the scope, and proximity determines where to look, see new option 3.
Shadow DOM is a very heavyweight scoping mechanism that does too much. Nobody would switch to Shadow DOM simply to use relative references, as the friction involved in that far, far outweighs the friction of assigning unique ids.
mayank99 commentedon Jul 4, 2024
A potential 4th (or 2c) option that might play nicely with HTML modules, DOM parts, and template instantiation: "Automatic generation of unique ids in each instance of the template".
Consider this template that uses the declarative DOM parts syntax (which might change):
Here,
uid()is like a built-in function that's available for use within DOM parts. It takes an optional key that is scoped to the template, and returns an IDREF that is guaranteed to be globally unique.When instantiated, this template would produce something like:
The optional key is only useful when you need to actually associate it with another element. It can be omitted when there's a simple need for a unique IDREF.
This probably wouldn't solve all cases, but I just wanted to put it out there. To me, it feels more flexible than something like
idscopebecause it's explicitly opt-in (meaning you can still use global ids in the same template). It is new syntax, but we'll need that new syntax for DOM parts anyway.dbaron commentedon Sep 5, 2024
So while XPath hasn't gotten much interest lately, it's possible that it might be a good fit for this sort of thing.
The reasons I think XPath may be worth considering here are:
It's perhaps questionable whether it falls into the "another microsyntax" trap: it's already a part of the Web (see e.g. domxpath and dom/xslt tests), but most of the things that use it are not widely used today. There's definitely a learning curve for those who don't know it -- but it's also pretty powerful and likely to do a pretty large subset of the things people would want from a feature like this.
[Edited to add] A big caveat that would need some research is that I'm not sure how well the existing implementations work with HTML (rather than XML).
sashafirsov commentedon Sep 5, 2024
+1 @dbaron
XPath is acually part of browser DOM implementation via document.evaluate method. Which makes in a native feature to be extended to HTML attribute as in this proposal.
There is a DCE (Declarative Custom Element) implementation which is using XPath for such kind of relations.
Even if the attribute can refer either ID, or css, the URI convention with schema as
xpath:preffix will fit there well.Delapouite commentedon Sep 5, 2024
Talking about XPath, a few years back @WebReflection attempted to get the ball rolling around upgrading the spec: whatwg/dom#903
WebReflection commentedon Sep 5, 2024
if there's anything I could add to that old attempt to refresh XPath on the Web:
:has(...)selector would've been great and we (at that time) collaborated with Igalia to bring:has(...)selector in ...:has(...)selector is wonderful and yet half powerful as XPath in CSS would've beenThat being said, when it's @LeaVerou suggesting DX improvements, I am usually 100% in favor of that so I won't bother this thread anymore with some hope that some solution would land in a way or another 👋
110 remaining items
bramus commentedon Aug 20, 2025
#11577 was filed for that just yesterday :)
bahrus commentedon Aug 20, 2025
Unpopular suggestion of the day, perhaps what @mayank99 was suggesting:
The platform would guarantee that the auto generated ids are unique within the ShadowDOM realm (including outside any ShadowDOM). Replacement would happen during parsing. This would make the connection "latch" at start up, and allow for moving things around the realm with no breakage.
If an outer tag that contains the form element also has generatedids = "foo", the inner most one trumps, similar to nested const's in JavaScript
What use cases does this miss?
mayank99 commentedon Aug 20, 2025
@bahrus My suggestion was similar but not quite the same. The key differences are:
<template>.generatedidsattribute, but if it's unavoidable then it must go on the<template>element, rather than<form>.I see you've opened #11585. I'll leave some more thoughts over there.
alice commentedon Aug 21, 2025
I finally got around to collating the responses I got to my questions about IDREFs: https://notes.igalia.com/XlsPwU5sQfuaWYHwhtBMtA
jyasskin commentedon Aug 25, 2025
Leaving a breadcrumb to a piece of prior art, CSS has been using names to establish cross-links between elements. Each purpose can assign its own names (e.g.
scroll-timeline-namevsanchor-name), and names can be explicitly scoped to a component (e.g.anchor-scope).sashafirsov commentedon Aug 26, 2025
This feature belong to templating and already exist in XSLT. The need of fully functional template is out of scope of relative reference discussion here as the subject is not rendering but existing DOM relations.
bahrus commentedon Aug 26, 2025
The name I used happens to be inspired by the name used in xslt, and yes, I think you can define a variable in xslt and refer to it with multiple elements. I did make a separate proposal, because I agree it is different from this one. I was very much in favor of this proposal, but I think at least 80% of its appeal, to me, stemmed simply from the platform not making working with id's ergonomic, which the other proposal tries to do. Id's have a kind of well-deserved stigma, which I'm trying to overcome when I imagine a world in which the other proposal is implemented. I still do think there might be scenarios where semantically it would make more sense to refer to other elements by some other attribute, or even by tag name. Maybe the command linkage is one such scenario, not sure. It looks like a "specifier" attribute is being seriously considered as far as linking imports. And of course if the platform doesn't implement something like 11585, then the id stigma remains justified, and the appeal of this proposal remains much stronger in my mind.
Hopefully my alternative / supplementary proposal makes clear that it does not require the use of the template element, or any other templating element, just HTML, so it doesn't "belong" to templating, but rather is a segue into SSR compatible templating, I hope. But the proposal stands on its own, even if it isn't followed up by SSR/isomorphic compatible templating.
LeaVerou commentedon Aug 26, 2025
Lots of things to respond to in this thread, but taking @jyasskin's advice, @noamr and I started an explainer here.
Still very much a work in progress, but we're posting it here to invite collaboration, so we can have a single source of truth, as currently this thread has grown to a length that is unmanageable even for folks who have followed it from the start.
keithamus commentedon Sep 8, 2025
Some early thoughts. I haven't digested the whole thread so forgive me if I'm retreading old ground:
label[for=my-input]becomelabel[for="& .* input"]?).idscope) seems straight forward for elements looking at other IDs but there becomes some amount of issues that unfold from this, for example existing APIs such asdocument.getElementById()presumably remain untouched (they find the first ID matching in the tree). Again we have an issue with CSS selectors but it is less of an issue, but this means there is a second order effect that as developers use more scoped IDs the duplication of said IDs proliferates, which causes the global lookups to be less and less useful over time. This may contribute to user harm, because it means that fragment IDs in URLs may become less stable. While we have text fragments these can be even less stable than fragment IDs for certain pages (e.g. a page with dynamic content, like a comment thread).WebReflection commentedon Sep 8, 2025
@keithamus
assuming the content of any container could easily change accordingly with circumstances, writing a top-container id followed by its target as plain CSS would make things way easier than needing unique identifiers all over the place, plus let's keep in mind every single ID leaks on the global context as property and there is no API to guarantee a new DOM identifier neither out there, neither for JS nor for Server Side languages.
I am honestly curious to understand when that global (leak?) lookup is really that useful except for demo pages where the amount of IDs is minimal and it's just "handy" but not elegant, neither robust (discrepancy between a cached expectations and what the next
getElementByIdcould return instead).Mind sharing an example of such usefulness? Thanks!
keithamus commentedon Sep 8, 2025
Perhaps not so much for developers, but for users it certainly is, as the ID can be used in a URL hash. The risk with introducing scoping is that developers are less inclined to use it in a way that users can leverage via the URL hash.
WebReflection commentedon Sep 8, 2025
@keithamus but I feel like that's exactly what's being tackled in here: ids matter, they do on the URL, they do on the global context pollution, they do for assistive technologies ... the current state is that ids don't matter anymore because to automate accessibility IDs are trashed all over the place without any meaning whatsoever, just to satisfy
labelled-byrequirements, right?So I fully agree with you there that IDs are relevant, but latest 20 years of Web growth rather showed how these are either a limitation, when meanings matters too, or an abused legacy feature automated to satisfy requirements, which is (imho) a bigger bummer to deal with.
edit on that note, a URL that points at a label without any context attached doesn't look like the best the Web can offer neither, but that ship has sealed long time ago
oscarotero commentedon Nov 5, 2025
I'd like to propose a scope-based solution with relative and absolute ids:
The
idscopeattribute creates a new scope. It means all inner ids starting with dot.are relative to this scope (it's similar to relative paths in the filesystem). For example, the.inputid is resolved tofield-name.input(in the first scope) andfield-email.input(in the second scope). The dot is just an idea, we can use a different character to indicate that an id is relative to the current scope.This method allows to use a reference to an id outside the current scope, which is compatible with URL hashes (just use the full path, ie
#field-name.input).The scopes can be nested:
Now, the resolved id is, for example
form-login.field-name.input(note that the values ofidscopedon't need to start with a dot, because they are always relative to the current scope if exists).noamr commentedon Nov 17, 2025
Note that conversation on this issue continues in https://github.com/wicg/idrefs.
It's a broader conversation about a topic, rather than specifically on using selectors as the a solution for this, which is a discussion which can use some rest :)