Skip to content

Commit 431b203

Browse files
committed
chore: more docs tweaks
1 parent 8208d83 commit 431b203

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Simple stack is a suite of tools built for [Astro](https://astro.build) to simpl
88

99
Simple stack offers a growing collection of packages:
1010

11-
- **[🧘‍♂️ Simple form](https://simple-stack.dev/form):** A full stack solution to validate forms with your client framework of choice.
12-
- **[🔎 Simple scope](https://simple-stack.dev/scope):** Get a scoped ID for any file you're in. Perfect for form label IDs and query selectors.
13-
- **[🌊 Simple stream](https://simple-stack.dev/stream):** Suspend Astro components with fallback content.
14-
- **[⏳ WIP: Simple partial](https://simple-stack.dev/partial):** Re-render just the parts that change in your Astro app.
11+
- **[🔎 Simple query](/query):** The simplest way to query elements from your Astro component.
12+
- **[🌊 Simple stream](/stream):** Suspend Astro components with fallback content.
13+
- **[🧘‍♂️ Simple form](/form):** A full stack solution to validate forms with your client framework of choice.
14+
- **[🔎 Simple scope](/scope):** A scoped ID generator for any file you're in. Perfect for form label IDs and query selectors.
1515

1616
## Get involved
1717

packages/query/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Selectors should be applied to the `data-target` attribute. All selectors are sc
3535
<!--data-target="btn-4SzN_OBB"-->
3636
```
3737

38-
From your client script, the query result will be a plain HTML element. No, it's not a JQuery object. But who doesn't like a little nostalgia?
38+
Then, use the same `$()` function from your client script to select that element. The query result will be a plain [`HTMLElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement). No, it's not a JQuery object. We just used `$` for the nostalgia 😉
3939

4040
```ts
4141
$('btn').addEventListener(() => { /* ... */ });
@@ -69,7 +69,7 @@ ready(() => {
6969

7070
### `$.all()` selector
7171

72-
You may want to select multiple targets with the same name. You can use `$.all()` to query for an array of results:
72+
You may want to select multiple targets with the same name. Use `$.all()` to query for an array of results:
7373

7474
```astro
7575
---
@@ -87,7 +87,7 @@ ready(() => {
8787
</script>
8888
```
8989

90-
### `$.ready()` function
90+
## `$.ready()` function
9191

9292
All `$` queries must be nested in a `$.ready()` block. This opts in to using the global `$` from client scripts. `$.ready()` also ensures your code reruns on every page [when view transitions are enabled.](https://docs.astro.build/en/guides/view-transitions/)
9393

www/src/content/docs/query.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Selectors should be applied to the `data-target` attribute. All selectors are sc
3838
<!--data-target="btn-4SzN_OBB"-->
3939
```
4040

41-
From your client script, the query result will be a plain HTML element. No, it's not a JQuery object. But who doesn't like a little nostalgia?
41+
Then, use the same `$()` function from your client script to select that element. The query result will be a plain [`HTMLElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement). No, it's not a JQuery object. We just used `$` for the nostalgia 😉
4242

4343
```ts
4444
$('btn').addEventListener(() => { /* ... */ });
@@ -72,7 +72,7 @@ ready(() => {
7272

7373
### `$.all()` selector
7474

75-
You may want to select multiple targets with the same name. You can use `$.all()` to query for an array of results:
75+
You may want to select multiple targets with the same name. Use `$.all()` to query for an array of results:
7676

7777
```astro
7878
---

0 commit comments

Comments
 (0)