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.

Sign up for GitHub

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

Jump to bottom

docs: track(signal) to track(()=>signal.value) #3651

Merged
merged 2 commits into from
Apr 5, 2023
Merged

docs: track(signal) to track(()=>signal.value) #3651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a4c689
track(signal) to track(()=>signal.value)
sreeisalso Apr 4, 2023
914ce4f
Merge branch 'main' into main
sreeisalso Apr 5, 2023
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
2 changes: 1 addition & 1 deletion .vscode/qwik.code-snippets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
"description": "useTask$() function hook",
"body": [
"useTask$(({ track }) => {",
" track($1);",
" track(() => $1);",
" $0",
"});",
""
Expand Down
1 change: 1 addition & 0 deletions packages/docs/src/routes/demo/getting-started/04-state/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export default component$(() => {
const isFavoriteSignal = useSignal(false);
const dadJokeSignal = useDadJoke();
const favoriteJokeAction = useJokeVoteAction();

return (
<div class="section bright">
<div>{dadJokeSignal.value.joke}</div>
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/demo/getting-started/05-tasks/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default component$(() => {
const dadJokeSignal = useDadJoke();
const favoriteJokeAction = useJokeVoteAction();
useTask$(({ track }) => {
track(isFavoriteSignal);
track(() => isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
server$(() => {
console.log('FAVORITE (server)', isFavoriteSignal.value);
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/demo/getting-started/06-styling/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default component$(() => {
const dadJokeSignal = useDadJoke();
const favoriteJokeAction = useJokeVoteAction();
useTask$(({ track }) => {
track(isFavoriteSignal);
track(() => isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
server$(() => {
console.log('FAVORITE (server)', isFavoriteSignal.value);
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/demo/state/resource/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default component$(() => {
const prNumber = useSignal('3576');

const prTitle = useResource$(async ({ track }) => {
track(prNumber); // Requires explicit tracking of inputs
track(() => prNumber.value); // Requires explicit tracking of inputs
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
);
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/demo/tasks/resource/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default component$(() => {
const prNumber = useSignal('3576');

const prTitle = useResource$(async ({ track }) => {
track(prNumber); // Requires explicit tracking of inputs
track(() => prNumber.value); // Requires explicit tracking of inputs
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
);
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/demo/tasks/track-server-guard/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default component$(() => {
const isBold = useSignal(false);

useTask$(({ track }) => {
track(text);
track(() => text.value);
if (isServer) {
return; // Server guard
}
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/demo/tasks/track/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default component$(() => {
const delayText = useSignal('');

useTask$(({ track }) => {
track(text);
track(() => text.value);
const value = text.value;
const update = () => (delayText.value = value);
isServer
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/docs/(qwik)/components/resource/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ import { component$, useResource$, Resource, useSignal } from '@builder.io/qwik'
export default component$(() => {
const query = useSignal('busy');
const jokes = useResource$(async ({ track, cleanup }) => {
track(query);
track(()=> query.value);
// A good practice is to use `AbortController` to abort the fetching of data if
// new request comes in. We create a new `AbortController` and register a `cleanup`
// function which is called when this function re-runs.
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/src/routes/docs/(qwik)/components/state/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ export default component$(() => {
const prNumber = useSignal(3576);

const prTitle = useResource$(async ({ track }) => {
track(prNumber); // Requires explicit tracking of inputs
track(()=> prNumber); // Requires explicit tracking of inputs
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
);
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/src/routes/docs/(qwik)/components/tasks/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ export default component$(() => {
const delayText = useSignal('');

useTask$(({ track }) => {
track(text);
track(()=> text.value);
const value = text.value;
const update = () => (delayText.value = value);
isServer
Expand Down Expand Up @@ -286,7 +286,7 @@ Sometimes a task needs to run only on the browser and after rendering, in that c
> const isBold = useSignal(false);
>
> useTask$(({ track }) => {
> track(text);
> track(()=> text.value);
> if (isServer) {
> return; // Server guard
> }
Expand Down Expand Up @@ -421,7 +421,7 @@ export default component$(() => {
const prNumber = useSignal(3576);

const prTitle = useResource$(async ({ track }) => {
track(prNumber); // Requires explicit tracking of inputs
track(()=> prNumber.value); // Requires explicit tracking of inputs
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
);
Expand Down
12 changes: 6 additions & 6 deletions packages/docs/src/routes/docs/(qwik)/getting-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ export default component$(() => {
const dadJokeSignal = useDadJoke();
const favoriteJokeAction = useJokeVoteAction();
useTask$(({ track }) => {
track(isFavoriteSignal);
track(()=> isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
server$(() => {
console.log('FAVORITE (server)', isFavoriteSignal.value);
Expand Down Expand Up @@ -359,20 +359,20 @@ In Qwik, a [task](/docs/components/tasks/#usetask) is work that needs to happen
2. Add a `track` call to the re-executed the task on `isFavoriteSignal` state change:
```tsx
useTask$(({ track }) => {
track(isFavoriteSignal);
track(()=> isFavoriteSignal.value);
});
```
3. Add the work that you want to execute on state change:
```tsx
useTask$(({ track }) => {
track(isFavoriteSignal);
track(()=> isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
});
```
4. If you want to have work happen on the server only, wrap it in `server$()`
```tsx
useTask$(({ track }) => {
track(isFavoriteSignal);
track(()=> isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
server$(() => {
console.log('FAVORITE (server)', isFavoriteSignal.value);
Expand Down Expand Up @@ -417,7 +417,7 @@ export default component$(() => {
const dadJokeSignal = useDadJoke();
const favoriteJokeAction = useJokeVoteAction();
useTask$(({ track }) => {
track(isFavoriteSignal);
track(()=> isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
server$(() => {
console.log('FAVORITE (server)', isFavoriteSignal.value);
Expand Down Expand Up @@ -519,7 +519,7 @@ export default component$(() => {
const dadJokeSignal = useDadJoke();
const favoriteJokeAction = useJokeVoteAction();
useTask$(({ track }) => {
track(isFavoriteSignal);
track(()=> isFavoriteSignal.value);
console.log('FAVORITE (isomorphic)', isFavoriteSignal.value);
server$(() => {
console.log('FAVORITE (server)', isFavoriteSignal.value);
Expand Down