Skip to content

Commit 556dbce

Browse files
bholmesdevbholmesdev
committed
add deprecation notices for form/ and stream/
1 parent 0312948 commit 556dbce

File tree

6 files changed

+29
-5
lines changed

6 files changed

+29
-5
lines changed

‎packages/form/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Simple form 🧘‍♂️
1+
# Simple form
22

3-
> The simple way to handle forms in your Astro project
3+
> ⚠️ **This package is no longer maintained.** Simple form was an experiment to see how we could make forms easier in Astro applications. Now, [Astro has Form Actions](https://docs.astro.build/en/guides/actions/#accepting-form-data-from-an-action), which makes validating form data on the server easier than ever. As for client-side validation, you can reference [my YouTube video on building your own client-side validation](https://www.youtube.com/watch?v=DwEkvie79xI&t=97s). If you want to package this up for others to use, feel free to fork the code in this repository and publish something yourself!
44
55
```astro
66
---

‎packages/stream/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Simple stream 🌊
22

3-
> Suspend Astro components with fallback content. Like React Server Components, but Just HTML ™️
3+
> ⚠️ **This package is no longer maintained.** Astro now has [Server Islands](https://docs.astro.build/en/guides/server-islands/), which largely replace the use cases explored by this package. Server Islands also offer a simpler mental model for streaming content that scales to a number of deployment hosts.
4+
>
5+
> That said, if you want to understand how this package works to fork the functionality for your own use, [watch my YouTube walkthrough!](https://www.youtube.com/watch?v=cdOyOgwt9Zc&t=128s)
46
57
https://github.com/bholmesdev/simple-stack/assets/51384119/99ed15a4-5a70-4f19-bc2a-712d4039c0a7
68

‎www/src/content/docs/form/client.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ sidebar:
55
order: 3
66
---
77

8+
:::caution
9+
⚠️ **This package is no longer maintained.** Astro now has [Server Islands](https://docs.astro.build/en/guides/server-islands/), which largely replace the use cases explored by this package. Server Islands also offer a simpler mental model for streaming content that scales to a number of deployment hosts.
10+
11+
That said, if you want to understand how this package works to fork the functionality for your own use, [watch my YouTube walkthrough!](https://www.youtube.com/watch?v=cdOyOgwt9Zc&t=128s)
12+
:::
13+
814
simple form helps generate a client-validated form in your framework of choice.
915

1016
> ⚠️ When using Astro, client validation relies on Astro view transitions. Ensure [view transitions are enabled](https://docs.astro.build/en/guides/view-transitions/#adding-view-transitions-to-a-page) on your page.

‎www/src/content/docs/form/index.mdx‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 🧘‍♂️ Simple form
2+
title: Simple form
33
description: The simple way to validate forms in your fullstack app.
44
sidebar:
55
label: Get started
@@ -8,7 +8,13 @@ sidebar:
88

99
import { Tabs, TabItem } from '@astrojs/starlight/components';
1010

11-
The simple way to validate forms in your fullstack app.
11+
:::caution
12+
⚠️ **This package is no longer maintained.** Astro now has [Server Islands](https://docs.astro.build/en/guides/server-islands/), which largely replace the use cases explored by this package. Server Islands also offer a simpler mental model for streaming content that scales to a number of deployment hosts.
13+
14+
That said, if you want to understand how this package works to fork the functionality for your own use, [watch my YouTube walkthrough!](https://www.youtube.com/watch?v=cdOyOgwt9Zc&t=128s)
15+
:::
16+
17+
The simple way to validate forms in your fullstack app.
1218

1319
```astro
1420
---

‎www/src/content/docs/form/parse.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ sidebar:
55
order: 2
66
---
77

8+
:::caution
9+
⚠️ **This package is no longer maintained.** Astro now has [Server Islands](https://docs.astro.build/en/guides/server-islands/), which largely replace the use cases explored by this package. Server Islands also offer a simpler mental model for streaming content that scales to a number of deployment hosts.
10+
11+
That said, if you want to understand how this package works to fork the functionality for your own use, [watch my YouTube walkthrough!](https://www.youtube.com/watch?v=cdOyOgwt9Zc&t=128s)
12+
:::
13+
814
Simple form exposes helpers to parse and validate form requests with generic APIs and the [`Astro.locals.form`](#astrolocalsform) object when using Astro frontmatter.
915

1016
## `validateForm()`

‎www/src/content/docs/stream.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Simple stream 🌊
33
description: Suspend Astro components with fallback content. Like React Server Components, but Just HTML ™️
44
---
55

6+
:::caution
7+
**This package is no longer maintained.** Simple form was an experiment to see how we could make forms easier in Astro applications. Now, [Astro has Form Actions](https://docs.astro.build/en/guides/actions/#accepting-form-data-from-an-action), which makes validating form data on the server easier than ever. As for client-side validation, you can reference [my YouTube video on building your own client-side validation](https://www.youtube.com/watch?v=DwEkvie79xI&t=97s). If you want to package this up for others to use, feel free to fork the code in this repository and publish something yourself!
8+
:::
9+
610
Suspend Astro components with fallback content. Like React Server Components, but Just HTML ™️
711

812
<video controls width="100%" style="aspect-ratio:1.65/1" src="/assets/simple-stream-intro.mov"></video>

0 commit comments

Comments
 (0)