remix 3.0.0-rc.1 → 3.0.0-rc.3
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/INDEX.md +87 -0
- package/dist/multiple-import-maps-polyfill.d.ts +2 -0
- package/dist/multiple-import-maps-polyfill.d.ts.map +1 -0
- package/dist/multiple-import-maps-polyfill.js +2 -0
- package/guides/01-start-here.md +808 -0
- package/guides/02-routing-and-controllers.md +326 -0
- package/guides/03-request-handling.md +356 -0
- package/guides/04-rendering-ui.md +500 -0
- package/guides/05-interactivity.md +900 -0
- package/guides/06-streaming-ui-with-frames.md +361 -0
- package/guides/07-animation.md +333 -0
- package/guides/13-testing.md +441 -0
- package/package.json +46 -40
- package/src/assets/README.md +101 -13
- package/src/auth/README.md +2 -0
- package/src/compression-middleware/README.md +4 -2
- package/src/cookie/README.md +2 -0
- package/src/cop-middleware/README.md +2 -2
- package/src/cors-middleware/README.md +7 -2
- package/src/csrf-middleware/README.md +1 -1
- package/src/fetch-proxy/README.md +17 -0
- package/src/fetch-router/README.md +39 -0
- package/src/form-data-parser/README.md +4 -0
- package/src/multiple-import-maps-polyfill/README.md +107 -0
- package/src/multiple-import-maps-polyfill.ts +2 -0
- package/src/render-middleware/README.md +2 -2
- package/src/response/README.md +251 -0
- package/src/route-pattern/README.md +3 -1
- package/src/session-middleware/README.md +9 -1
- package/src/tar-parser/README.md +53 -0
- package/src/ui/README.md +56 -8
- package/src/ui/server/README.md +25 -5
- package/src/ui-hmr/README.md +6 -1
- package/src/ui/accordion/primitives/README.md +0 -202
- package/src/ui/combobox/primitives/README.md +0 -194
- package/src/ui/menu/primitives/README.md +0 -161
- package/src/ui/select/primitives/README.md +0 -117
- package/src/ui/tabs/primitives/README.md +0 -141
- package/src/ui/toggle/primitives/README.md +0 -56
package/INDEX.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# Remix Documentation Index
|
|
2
|
+
|
|
3
|
+
Search this generated index by task, export name, or description. Use the guides for app workflows and the package READMEs for API details that match the installed Remix version.
|
|
4
|
+
|
|
5
|
+
## Guides
|
|
6
|
+
|
|
7
|
+
| Guide | Description |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| [Start Here](guides/01-start-here.md) | A high-level introduction to Remix and the mental model behind a Remix application. |
|
|
10
|
+
| [Routing and Controllers](guides/02-routing-and-controllers.md) | How route maps, route helpers, controllers, actions, and responses define Remix request handling. |
|
|
11
|
+
| [Request Handling](guides/03-request-handling.md) | How a Web Request becomes a Web Response across runtime adapters and the middleware pipeline. |
|
|
12
|
+
| [Rendering UI](guides/04-rendering-ui.md) | How to build pages from Remix components, props, context, document shells, styles, and first-party UI. |
|
|
13
|
+
| [Interactivity](guides/05-interactivity.md) | How server-rendered UI hydrates, handles events, connects components to application models, navigates, and cancels stale work. |
|
|
14
|
+
| [Streaming UI with Frames](guides/06-streaming-ui-with-frames.md) | How to stream and reload route-owned UI with Frame, fallbacks, and server and browser frame resolvers. |
|
|
15
|
+
| [Animation](guides/07-animation.md) | The CSS-first animation model and Remix UI helpers for motion that respects rendering state. |
|
|
16
|
+
| [Testing](guides/13-testing.md) | How to choose a test boundary and test Remix routes, stateful request flows, components, and end-to-end behavior. |
|
|
17
|
+
|
|
18
|
+
## Package APIs
|
|
19
|
+
|
|
20
|
+
Exports covered by the same README are grouped together.
|
|
21
|
+
|
|
22
|
+
| Exports | Description | Docs |
|
|
23
|
+
| --- | --- | --- |
|
|
24
|
+
| `remix/assert` | Node assert-compatible utilities for any JavaScript environment | [README](src/assert/README.md) |
|
|
25
|
+
| `remix/assets`<br>`remix/assets/types/hmr` | Fetch-based server for compiling browser JS/TS and CSS assets on demand | [README](src/assets/README.md) |
|
|
26
|
+
| `remix/auth` | Browser login, OAuth, and OIDC helpers for Remix | [README](src/auth/README.md) |
|
|
27
|
+
| `remix/cookie` | A toolkit for working with cookies in JavaScript | [README](src/cookie/README.md) |
|
|
28
|
+
| `remix/data-schema`<br>`remix/data-schema/checks`<br>`remix/data-schema/coerce`<br>`remix/data-schema/form-data`<br>`remix/data-schema/lazy` | Tiny, standards-aligned schema validation | [README](src/data-schema/README.md) |
|
|
29
|
+
| `remix/data-table`<br>`remix/data-table/cli`<br>`remix/data-table/migrations`<br>`remix/data-table/migrations/node`<br>`remix/data-table/operators`<br>`remix/data-table/sql-helpers` | A typed, relational query toolkit for JavaScript | [README](src/data-table/README.md) |
|
|
30
|
+
| `remix/data-table/mysql` | MySQL database implementation for remix/data-table | [README](src/data-table-mysql/README.md) |
|
|
31
|
+
| `remix/data-table/postgres` | PostgreSQL database implementation for remix/data-table | [README](src/data-table-postgres/README.md) |
|
|
32
|
+
| `remix/data-table/sqlite` | SQLite database implementation for remix/data-table | [README](src/data-table-sqlite/README.md) |
|
|
33
|
+
| `remix/fetch-proxy` | An HTTP proxy for the web Fetch API | [README](src/fetch-proxy/README.md) |
|
|
34
|
+
| `remix/file-storage`<br>`remix/file-storage/fs`<br>`remix/file-storage/memory` | Key/value storage for JavaScript File objects | [README](src/file-storage/README.md) |
|
|
35
|
+
| `remix/file-storage/s3` | S3 backend for remix/file-storage | [README](src/file-storage-s3/README.md) |
|
|
36
|
+
| `remix/form-data-parser` | A request.formData() wrapper with streaming file upload handling | [README](src/form-data-parser/README.md) |
|
|
37
|
+
| `remix/fs` | Filesystem utilities using the Web File API | [README](src/fs/README.md) |
|
|
38
|
+
| `remix/headers`<br>`remix/headers/accept`<br>`remix/headers/accept-encoding`<br>`remix/headers/accept-language`<br>`remix/headers/cache-control`<br>`remix/headers/content-disposition`<br>`remix/headers/content-range`<br>`remix/headers/content-type`<br>`remix/headers/cookie`<br>`remix/headers/if-match`<br>`remix/headers/if-none-match`<br>`remix/headers/if-range`<br>`remix/headers/range`<br>`remix/headers/raw-headers`<br>`remix/headers/set-cookie`<br>`remix/headers/vary` | A toolkit for working with HTTP headers in JavaScript | [README](src/headers/README.md) |
|
|
39
|
+
| `remix/html-template` | HTML template tag with auto-escaping for JavaScript | [README](src/html-template/README.md) |
|
|
40
|
+
| `remix/lazy-file` | Lazy, streaming files for JavaScript | [README](src/lazy-file/README.md) |
|
|
41
|
+
| `remix/middleware/async-context` | Middleware for storing request context in AsyncLocalStorage | [README](src/async-context-middleware/README.md) |
|
|
42
|
+
| `remix/middleware/auth` | Pluggable authentication middleware for Remix | [README](src/auth-middleware/README.md) |
|
|
43
|
+
| `remix/middleware/compression` | Middleware for compressing HTTP responses | [README](src/compression-middleware/README.md) |
|
|
44
|
+
| `remix/middleware/cop` | Middleware for tokenless cross-origin protection in Fetch API servers | [README](src/cop-middleware/README.md) |
|
|
45
|
+
| `remix/middleware/cors` | Middleware for handling CORS in Fetch API servers | [README](src/cors-middleware/README.md) |
|
|
46
|
+
| `remix/middleware/csrf` | Middleware for CSRF protection in Fetch API servers | [README](src/csrf-middleware/README.md) |
|
|
47
|
+
| `remix/middleware/form-data` | Middleware for parsing FormData from request bodies | [README](src/form-data-middleware/README.md) |
|
|
48
|
+
| `remix/middleware/logger` | Middleware for logging HTTP requests and responses | [README](src/logger-middleware/README.md) |
|
|
49
|
+
| `remix/middleware/method-override` | Middleware for overriding HTTP request methods from form data | [README](src/method-override-middleware/README.md) |
|
|
50
|
+
| `remix/middleware/render` | Conventional Remix UI and custom request-scoped render middleware | [README](src/render-middleware/README.md) |
|
|
51
|
+
| `remix/middleware/session` | Middleware for managing sessions with cookie-based storage | [README](src/session-middleware/README.md) |
|
|
52
|
+
| `remix/middleware/static` | Middleware for serving static files from the filesystem | [README](src/static-middleware/README.md) |
|
|
53
|
+
| `remix/mime` | Utilities for working with MIME types | [README](src/mime/README.md) |
|
|
54
|
+
| `remix/multipart-parser`<br>`remix/multipart-parser/node` | A fast, efficient parser for multipart streams in any JavaScript environment | [README](src/multipart-parser/README.md) |
|
|
55
|
+
| `remix/multiple-import-maps-polyfill` | Polyfill for dynamic JavaScript imports that depend on import maps added at runtime | [README](src/multiple-import-maps-polyfill/README.md) |
|
|
56
|
+
| `remix/node-fetch-server`<br>`remix/node-fetch-server/test` | Build servers for Node.js using the web fetch API | [README](src/node-fetch-server/README.md) |
|
|
57
|
+
| `remix/node-hmr`<br>`remix/node-hmr/runtime`<br>`remix/node-hmr/types` | Run Node.js applications with Hot Module Reloading | [README](src/node-hmr/README.md) |
|
|
58
|
+
| `remix/node-tsx`<br>`remix/node-tsx/load-module` | Run Node.js with TypeScript and JSX syntax support | [README](src/node-tsx/README.md) |
|
|
59
|
+
| `remix/response/compress`<br>`remix/response/file`<br>`remix/response/html`<br>`remix/response/redirect` | Response helpers for the web Fetch API | [README](src/response/README.md) |
|
|
60
|
+
| `remix/route-pattern`<br>`remix/route-pattern/href`<br>`remix/route-pattern/join`<br>`remix/route-pattern/match`<br>`remix/route-pattern/specificity` | Match and generate URLs with strong typing | [README](src/route-pattern/README.md) |
|
|
61
|
+
| `remix/router`<br>`remix/routes` | A minimal, composable router for the web Fetch API | [README](src/fetch-router/README.md) |
|
|
62
|
+
| `remix/session`<br>`remix/session-storage/cookie`<br>`remix/session-storage/fs`<br>`remix/session-storage/memory` | Session management for JavaScript | [README](src/session/README.md) |
|
|
63
|
+
| `remix/session-storage/memcache` | Memcache session storage for remix/session | [README](src/session-storage-memcache/README.md) |
|
|
64
|
+
| `remix/session-storage/redis` | Redis session storage for remix/session | [README](src/session-storage-redis/README.md) |
|
|
65
|
+
| `remix/spa` | Client-rendered application routing for Remix | [README](src/spa/README.md) |
|
|
66
|
+
| `remix/tar-parser` | A fast, efficient parser for tar streams in any JavaScript environment | [README](src/tar-parser/README.md) |
|
|
67
|
+
| `remix/terminal` | Terminal output utilities for JavaScript libraries and CLIs | [README](src/terminal/README.md) |
|
|
68
|
+
| `remix/test`<br>`remix/test/cli` | A test framework for JavaScript and TypeScript projects | [README](src/test/README.md) |
|
|
69
|
+
| `remix/ui`<br>`remix/ui/dev/refresh`<br>`remix/ui/jsx-dev-runtime`<br>`remix/ui/jsx-runtime` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/README.md) |
|
|
70
|
+
| `remix/ui-hmr`<br>`remix/ui-hmr/assets`<br>`remix/ui-hmr/node`<br>`remix/ui-hmr/runtime/browser`<br>`remix/ui-hmr/runtime/server` | Hot module replacement runtime and transforms for Remix UI components | [README](src/ui-hmr/README.md) |
|
|
71
|
+
| `remix/ui/accordion`<br>`remix/ui/accordion/primitives` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/accordion/README.md) |
|
|
72
|
+
| `remix/ui/anchor` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/anchor/README.md) |
|
|
73
|
+
| `remix/ui/animation` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/animation/README.md) |
|
|
74
|
+
| `remix/ui/breadcrumbs` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/breadcrumbs/README.md) |
|
|
75
|
+
| `remix/ui/button` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/button/README.md) |
|
|
76
|
+
| `remix/ui/checkbox` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/checkbox/README.md) |
|
|
77
|
+
| `remix/ui/combobox`<br>`remix/ui/combobox/primitives` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/combobox/README.md) |
|
|
78
|
+
| `remix/ui/input` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/input/README.md) |
|
|
79
|
+
| `remix/ui/listbox` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/listbox/README.md) |
|
|
80
|
+
| `remix/ui/menu`<br>`remix/ui/menu/primitives` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/menu/README.md) |
|
|
81
|
+
| `remix/ui/popover` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/popover/README.md) |
|
|
82
|
+
| `remix/ui/radio` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/radio/README.md) |
|
|
83
|
+
| `remix/ui/select`<br>`remix/ui/select/primitives` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/select/README.md) |
|
|
84
|
+
| `remix/ui/server` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/server/README.md) |
|
|
85
|
+
| `remix/ui/tabs`<br>`remix/ui/tabs/primitives` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/tabs/README.md) |
|
|
86
|
+
| `remix/ui/test` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/test/README.md) |
|
|
87
|
+
| `remix/ui/toggle`<br>`remix/ui/toggle/primitives` | UI runtime, headless primitives, and styled components for Remix | [README](src/ui/toggle/README.md) |
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"multiple-import-maps-polyfill.d.ts","sourceRoot":"","sources":["../src/multiple-import-maps-polyfill.ts"],"names":[],"mappings":"AACA,cAAc,0CAA0C,CAAA"}
|