Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[examples] Add async task playground example #1179

Merged
merged 3 commits into from
Sep 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/lit-dev-content/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
"dependencies": {
"@lit-labs/motion": "^1.0.1",
"@lit-labs/react": "^1.0.8",
"@lit-labs/task": "^1.0.0",
"@lit-labs/task": "^3.0.2",
"@lit/localize": "^0.10.0",
"@material/mwc-button": "^0.27.0",
"@material/mwc-checkbox": "^0.27.0",
Expand Down
12 changes: 7 additions & 5 deletions packages/lit-dev-content/samples/examples/async-task/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<!doctype html>
<head>
<script type="module" src="./index.js"></script>
</head>
<style>
body { font-family: sans-serif; }
</style>

<script type="module" src="./npm-info.js"></script>

<body>
<demo-element></demo-element>
<npm-info></npm-info>
</body>
27 changes: 0 additions & 27 deletions packages/lit-dev-content/samples/examples/async-task/index.js

This file was deleted.

87 changes: 0 additions & 87 deletions packages/lit-dev-content/samples/examples/async-task/npm-info.js

This file was deleted.

77 changes: 77 additions & 0 deletions packages/lit-dev-content/samples/examples/async-task/npm-info.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import {LitElement, css, html} from 'lit';
import {customElement, state} from 'lit/decorators.js';
import {Task} from '@lit-labs/task';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll need to update this for graduation. cc @rictic

import {fetchPackageInfo} from './npm.js';

@customElement('npm-info')
export class NpmInfo extends LitElement {
@state()
private _package = 'lit';

private _fetchNpmInfoTask = new Task(this, {
task: async ([pkgName], {signal}) => {
if (pkgName === undefined || pkgName === '') {
throw new Error('Empty package name');
}
return await fetchPackageInfo(pkgName, signal);
},
args: () => [this._package],
});

render() {
return html`
<label>
augustjk marked this conversation as resolved.
Show resolved Hide resolved
Enter a package name:
<input .value=${this._package} @change=${this._onChange} />
</label>
<header>
<h1>${this._package}</h1>
<img
id="logo"
src="https://raw.githubusercontent.com/npm/logos/master/npm%20logo/npm-logo-red.svg"
alt="npm logo"
/>
</header>
<div>
${this._fetchNpmInfoTask.render({
pending: () => 'Loading...',
complete: (pkg) => html`
<h3>${pkg.description}</h3>
<h4>dist-tags:</h4>
<ul>
${Array.from(Object.entries(pkg['dist-tags'])).map(
([tag, version]) => html`<li><pre>${tag}: ${version}</pre></li>`
)}
</ul>
`,
error: (e) => `Error: ${(e as Error).message}`,
})}
</div>
`;
}

private _onChange(e: Event) {
this._package = (e.target as HTMLInputElement).value;
}

static styles = css`
:host {
display: block;
min-width: 300px;
border-radius: 5px;
border: solid 1px #aaa;
padding: 20px;
}
header {
display: flex;
flex-direction: row;
align-items: center;
justify-content: space-between;
}
#logo {
height: 38px;
width: auto;
}
`;
}

20 changes: 20 additions & 0 deletions packages/lit-dev-content/samples/examples/async-task/npm.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
export interface NpmPackage {
description: string;
['dist-tags']: {[tag: string]: string};
}

export const fetchPackageInfo = async (
pkgName: string,
signal: AbortSignal
): Promise<NpmPackage> => {
// Artifical delay for demo purposes
await new Promise((r) => setTimeout(r, 1000));
const response = await fetch(`https://registry.npmjs.org/${pkgName}`, {
signal,
});
if (response.status === 200) {
return response.json();
} else {
throw response.text();
}
};
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
{
"extends": "/samples/base.json",
"hide": true,
"title": "Async Task / NPM Info element",
"description": "Shows an example of an async Task controller. This one fetches npm package info and renders based on the state of the fetch.",
"section": "Specific Solutions",
"section": "Managing Data",
"files": {
"index.js": {},
"npm-info.js": {},
"task.js": {},
"npm-info.ts": {},
"npm.ts": {},
"index.html": {}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export class NamesController {
host: ReactiveControllerHost;
value?: string[];
readonly kinds = Names.kinds;
private task!: Task;
private task!: Task<[Names.Kind], Names.Result>;
private _kind: Names.Kind = '';

constructor(host: ReactiveControllerHost) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export class NamesController {
host: ReactiveControllerHost;
value?: string[];
readonly kinds = Names.kinds;
private task!: Task;
private task!: Task<[Names.Kind], Names.Result>;
private _kind: Names.Kind = '';

constructor(host: ReactiveControllerHost) {
Expand Down
1 change: 1 addition & 0 deletions packages/lit-dev-content/site/_data/playground_examples.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const topSectionOrder = [
'Reactive properties',
'Template concepts',
'Directives',
'Managing Data',
'@lit-labs/react',
'@lit-labs/motion'
];
Expand Down
Loading