readthedocs / readthedocs/ext-theme

Web component: handle async operations with built in Lit Task

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

Nobody has claimed this yet.

Accepted Improvement Needed: design decision
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

In #300 I manually handled an async web request to our API, but I did almost use the Lit Task API to handle all of the async and error handling. I decided to put this off for a bit, while we are still figuring out web components here.

Maybe this is more refactor level work, or we might just take on the dependency early if we feel we'll definitely switch.

This list will grow if we continue to manually implement async task handling in Lit elements, but for now, the places where this pattern could be applied are:

  • Notificaiton elements

Contributor guide

No contributing guide indexed for this repository

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 issue #300 and the Notification elements that currently handle async API requests manually. Read the linked Lit Task API documentation and assess how it fits the project's current web-component direction. Done means the scope is narrowed to a concrete migration or an explicit decision about adopting Lit Task.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.