Skip to content

[types] cursor should accept arbitrary string - #1466

Open
henryqdineen wants to merge 3 commits into
facebook:mainfrom
henryqdineen:hqd-cursor-type
Open

henryqdineen wants to merge 3 commits into
facebook:mainfrom
henryqdineen:hqd-cursor-type

Conversation

@henryqdineen

Copy link
Copy Markdown
Collaborator

What changed / motivation ?

This updates the CSSCursor type to accept arbitrary strings to address a recent bug report. The fix in this PR is to simply add string to the union type.

I personally would prefer the TypeScript union to include | (string & {}) for the improved autocomplete but right now we are generating types from Flow. This article explains the TypeScript trick in more detail. Any objections to maintaining a separate type definitions of the CSS Types so we could use that trick? Have you considered directly using csstype?

Linked PR/Issues

Fixes #1463

Screenshots, Tests, Anything Else

Pre-flight checklist

@vercel

vercel Bot commented Jan 27, 2026

Copy link
Copy Markdown

@henryqdineen is attempting to deploy a commit to the Meta Open Source Team on Vercel.

A member of the Team first needs to authorize it.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 27, 2026
henryqdineen added a commit that referenced this pull request Sep 11, 2026
Worked example of the `CLOSED_DESPITE_GRAMMAR` loop, and it closes #1463.

    cursor: its grammar is `[ [ <url> [ <x> <y> ]? , ]* [ auto | default | ...
    ]]`, which admits more than keywords, but the type accepts no arbitrary
    string. Either add `string` in the Flow types and `(string & {})` in the
    definitions, or list it in CLOSED_DESPITE_GRAMMAR with a reason.

`cursor` takes a comma-separated list of `url()` values before its keyword, so
a union of literals can never describe it -- `cursor: 'url(cur.png) 4 12,
auto'` was a type error.

This is the change proposed in #1466, except the TypeScript definitions get
`(string & {})` rather than a bare `string`, so all 43 cursor keywords keep
autocompleting while any string is accepted. That was the thing that PR asked
for and could not have while the definitions were generated from the Flow
types; #1466 can be closed in favour of this.

Opening the union also made its `INCOMPLETE_UNIONS` entry unreachable, since
that check skips properties accepting arbitrary strings. Rather than leave a
dead entry, the seven keywords it recorded are added: `hand` (the pre-standard
IE spelling) and the `-moz-` and zoom variants, where StyleX had `-webkit-grab`
and `-webkit-grabbing` but not their siblings.

Confirmed after the change: `url(cur.png) 4 12, auto`, `-moz-grab` and
`pointer` all typecheck, and the editor still offers 43 completions.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

url value for cursor property

1 participant