@pracht/core 0.0.0 → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -0
- package/package.json +13 -1
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @pracht/core
|
|
2
|
+
|
|
3
|
+
Core routing, rendering, server/client runtime, and type utilities for pracht.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @pracht/core preact preact-render-to-string
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## API
|
|
12
|
+
|
|
13
|
+
### Route Manifest
|
|
14
|
+
|
|
15
|
+
- `defineApp()` — define the application and its route tree
|
|
16
|
+
- `route()` — declare a route with path, component, loader, and rendering mode
|
|
17
|
+
- `group()` — group routes under a shared shell or middleware
|
|
18
|
+
|
|
19
|
+
### Server
|
|
20
|
+
|
|
21
|
+
- `handlePrachtRequest()` — server renderer that produces full HTML with hydration markers
|
|
22
|
+
- `matchAppRoute()` — segment-based route matching
|
|
23
|
+
|
|
24
|
+
### Client
|
|
25
|
+
|
|
26
|
+
- `startApp()` — client-side hydration and runtime
|
|
27
|
+
- `useRouteData()` — access loader data inside a route component
|
|
28
|
+
- `useRevalidateRoute()` — trigger a revalidation of the current route's data
|
|
29
|
+
- `useSubmitAction()` — submit a form action programmatically
|
|
30
|
+
- `<Form>` — progressive enhancement form component
|
|
31
|
+
|
|
32
|
+
### Types
|
|
33
|
+
|
|
34
|
+
- `LoaderData<T>` — infer the return type of a loader
|
|
35
|
+
- `RouteComponentProps<T>` — props type for route components
|
|
36
|
+
- `LoaderArgs` — argument type passed to loaders and actions
|
|
37
|
+
|
|
38
|
+
## Rendering Modes
|
|
39
|
+
|
|
40
|
+
Each route can specify its rendering mode:
|
|
41
|
+
|
|
42
|
+
- `ssr` — server-rendered on every request
|
|
43
|
+
- `ssg` — pre-rendered at build time
|
|
44
|
+
- `isg` — pre-rendered with time-based revalidation
|
|
45
|
+
- `spa` — client-only rendering
|
package/package.json
CHANGED
|
@@ -1,10 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pracht/core",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "https://github.com/JoviDeCroock/pracht",
|
|
7
|
+
"directory": "packages/framework"
|
|
8
|
+
},
|
|
9
|
+
"homepage": "https://github.com/JoviDeCroock/pracht/tree/main/packages/framework",
|
|
10
|
+
"bugs": {
|
|
11
|
+
"url": "https://github.com/JoviDeCroock/pracht/issues"
|
|
12
|
+
},
|
|
4
13
|
"files": [
|
|
5
14
|
"dist"
|
|
6
15
|
],
|
|
7
16
|
"type": "module",
|
|
17
|
+
"publishConfig": {
|
|
18
|
+
"provenance": true
|
|
19
|
+
},
|
|
8
20
|
"exports": {
|
|
9
21
|
".": {
|
|
10
22
|
"types": "./dist/index.d.mts",
|