lit / lit/lit.dev

Link to or document decorator equivalents

Open
#460 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

Non-decorator users often wonder how to implement the functionality of our decorators in plain JS. We have this information for many decorators - `@property` equivalent is talked about in *Reactive properties*, `@query` equivalent is talked about in *Shadow DOM* - but we might not have it for all decorators and the information is distributed in the topical docs.

It'd probably be useful if we repeated the equivalents or linked to the topics from the decorator docs.

This brings up an issue that we don't have guides on the decorators, we only have them mentioned in particular topics or have API docs. We possibly just want links from API docs then.

Contributor guide

Open the 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.

Research direction

Start by reviewing the existing decorator API docs and the topical docs for Reactive properties and Shadow DOM. Identify which decorator equivalents are already documented, then link or repeat that information consistently; done means non-decorator users can find the plain-JavaScript equivalent for each supported decorator.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.