@typestyles/next 0.2.0 → 0.5.0
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/LICENSE +204 -0
- package/README.md +342 -0
- package/dist/build.cjs +151 -0
- package/dist/build.js +129 -0
- package/dist/client.cjs +71 -0
- package/dist/client.js +44 -0
- package/dist/index.cjs +40 -11
- package/dist/index.js +35 -11
- package/dist/server.cjs +55 -0
- package/dist/server.js +17 -0
- package/package.json +38 -8
- package/src/build-route-css.test.ts +48 -0
- package/src/build.d.ts +70 -0
- package/src/build.test.ts +104 -0
- package/src/build.ts +233 -0
- package/src/client.d.ts +33 -0
- package/src/client.tsx +144 -0
- package/src/index.d.ts +6 -4
- package/src/index.tsx +20 -99
- package/src/react-augmentation.d.ts +13 -0
- package/src/server.d.ts +9 -0
- package/src/server.ts +56 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,204 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
Copyright 2026 The TypeStyles Authors
|
|
7
|
+
|
|
8
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
9
|
+
|
|
10
|
+
1. Definitions.
|
|
11
|
+
|
|
12
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
13
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
14
|
+
|
|
15
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
16
|
+
the copyright owner that is granting the License.
|
|
17
|
+
|
|
18
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
19
|
+
other entities that control, are controlled by, or are under common
|
|
20
|
+
control with that entity. For the purposes of this definition,
|
|
21
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
22
|
+
direction or management of such entity, whether by contract or
|
|
23
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
24
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
25
|
+
|
|
26
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
27
|
+
exercising permissions granted by this License.
|
|
28
|
+
|
|
29
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
30
|
+
including but not limited to software source code, documentation
|
|
31
|
+
source, and configuration files.
|
|
32
|
+
|
|
33
|
+
"Object" form shall mean any form resulting from mechanical
|
|
34
|
+
transformation or translation of a Source form, including but
|
|
35
|
+
not limited to compiled object code, generated documentation,
|
|
36
|
+
and conversions to other media types.
|
|
37
|
+
|
|
38
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
39
|
+
Object form, made available under the License, as indicated by a
|
|
40
|
+
copyright notice that is included in or attached to the work
|
|
41
|
+
(an example is provided in the Appendix below).
|
|
42
|
+
|
|
43
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
44
|
+
form, that is based on (or derived from) the Work and for which the
|
|
45
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
46
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
47
|
+
of this License, Derivative Works shall not include works that remain
|
|
48
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
49
|
+
the Work and Derivative Works thereof.
|
|
50
|
+
|
|
51
|
+
"Contribution" shall mean any work of authorship, including
|
|
52
|
+
the original version of the Work and any modifications or additions
|
|
53
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
54
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
55
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
56
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
57
|
+
means any form of electronic, verbal, or written communication sent
|
|
58
|
+
to the Licensor or its representatives, including but not limited to
|
|
59
|
+
communication on electronic mailing lists, source code control systems,
|
|
60
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
61
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
62
|
+
excluding communication that is conspicuously marked or otherwise
|
|
63
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
64
|
+
|
|
65
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
66
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
67
|
+
subsequently incorporated within the Work.
|
|
68
|
+
|
|
69
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
70
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
71
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
72
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
73
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
74
|
+
Work and such Derivative Works in Source or Object form.
|
|
75
|
+
|
|
76
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
77
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
78
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
79
|
+
(except as stated in this section) patent license to make, have made,
|
|
80
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
81
|
+
where such license applies only to those patent claims licensable
|
|
82
|
+
by such Contributor that are necessarily infringed by their
|
|
83
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
84
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
85
|
+
institute patent litigation against any entity (including a
|
|
86
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
87
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
88
|
+
or contributory patent infringement, then any patent licenses
|
|
89
|
+
granted to You under this License for that Work shall terminate
|
|
90
|
+
as of the date such litigation is filed.
|
|
91
|
+
|
|
92
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
93
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
94
|
+
modifications, and in Source or Object form, provided that You
|
|
95
|
+
meet the following conditions:
|
|
96
|
+
|
|
97
|
+
(a) You must give any other recipients of the Work or
|
|
98
|
+
Derivative Works a copy of this License; and
|
|
99
|
+
|
|
100
|
+
(b) You must cause any modified files to carry prominent notices
|
|
101
|
+
stating that You changed the files; and
|
|
102
|
+
|
|
103
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
104
|
+
that You distribute, all copyright, patent, trademark, and
|
|
105
|
+
attribution notices from the Source form of the Work,
|
|
106
|
+
excluding those notices that do not pertain to any part of
|
|
107
|
+
the Derivative Works; and
|
|
108
|
+
|
|
109
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
110
|
+
distribution, then any Derivative Works that You distribute must
|
|
111
|
+
include a readable copy of the attribution notices contained
|
|
112
|
+
within such NOTICE file, excluding those notices that do not
|
|
113
|
+
pertain to any part of the Derivative Works, in at least one
|
|
114
|
+
of the following places: within a NOTICE text file distributed
|
|
115
|
+
as part of the Derivative Works; within the Source form or
|
|
116
|
+
documentation, if provided along with the Derivative Works; or,
|
|
117
|
+
within a display generated by the Derivative Works, if and
|
|
118
|
+
wherever such third-party notices normally appear. The contents
|
|
119
|
+
of the NOTICE file are for informational purposes only and
|
|
120
|
+
do not modify the License. You may add Your own attribution
|
|
121
|
+
notices within Derivative Works that You distribute, alongside
|
|
122
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
123
|
+
that such additional attribution notices cannot be construed
|
|
124
|
+
as modifying the License.
|
|
125
|
+
|
|
126
|
+
You may add Your own copyright statement to Your modifications and
|
|
127
|
+
may provide additional or different license terms and conditions
|
|
128
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
129
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
130
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
131
|
+
the conditions stated in this License.
|
|
132
|
+
|
|
133
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
134
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
135
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
136
|
+
this License, without any additional terms or conditions.
|
|
137
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
138
|
+
the terms of any separate license agreement you may have executed
|
|
139
|
+
with Licensor regarding such Contributions.
|
|
140
|
+
|
|
141
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
142
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
143
|
+
except as required for reasonable and customary use in describing the
|
|
144
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
145
|
+
|
|
146
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
147
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
148
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
149
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
150
|
+
implied, including, without limitation, any warranties or conditions
|
|
151
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
152
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
153
|
+
appropriateness of using or redistributing the Work and assume any
|
|
154
|
+
risks associated with Your exercise of permissions under this License.
|
|
155
|
+
|
|
156
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
157
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
158
|
+
unless required by applicable law (such as deliberate and grossly
|
|
159
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
160
|
+
liable to You for damages, including any direct, indirect, special,
|
|
161
|
+
incidental, or consequential damages of any character arising as a
|
|
162
|
+
result of this License or out of the use or inability to use the
|
|
163
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
164
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
165
|
+
other commercial damages or losses), even if such Contributor
|
|
166
|
+
has been advised of the possibility of such damages.
|
|
167
|
+
|
|
168
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
169
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
170
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
171
|
+
or other liability obligations and/or rights consistent with this
|
|
172
|
+
License. However, in accepting such obligations, You may act only
|
|
173
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
174
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
175
|
+
defend, and hold each Contributor harmless for any liability
|
|
176
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
177
|
+
of your accepting any such warranty or additional liability.
|
|
178
|
+
|
|
179
|
+
END OF TERMS AND CONDITIONS
|
|
180
|
+
|
|
181
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
182
|
+
|
|
183
|
+
To apply the Apache License to your work, attach the following
|
|
184
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
185
|
+
replaced with your own identifying information. (Don't include
|
|
186
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
187
|
+
comment syntax for the file format. We also recommend that a
|
|
188
|
+
file or class name and description of purpose be included on the
|
|
189
|
+
same "printed page" as the copyright notice for easier
|
|
190
|
+
identification within third-party archives.
|
|
191
|
+
|
|
192
|
+
Copyright [yyyy] [name of copyright owner]
|
|
193
|
+
|
|
194
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
195
|
+
you may not use this file except in compliance with the License.
|
|
196
|
+
You may obtain a copy of the License at
|
|
197
|
+
|
|
198
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
199
|
+
|
|
200
|
+
Unless required by applicable law or agreed to in writing, software
|
|
201
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
202
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
203
|
+
See the License for the specific language governing permissions and
|
|
204
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,342 @@
|
|
|
1
|
+
# @typestyles/next
|
|
2
|
+
|
|
3
|
+
Next.js integration for typestyles with full support for App Router, Pages Router, and React Server Components.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @typestyles/next typestyles
|
|
9
|
+
# or
|
|
10
|
+
pnpm add @typestyles/next typestyles
|
|
11
|
+
# or
|
|
12
|
+
yarn add @typestyles/next typestyles
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Requirements
|
|
16
|
+
|
|
17
|
+
- Next.js >= 13.0.0
|
|
18
|
+
- React >= 18.0.0
|
|
19
|
+
- typestyles >= 0.1.0
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
### App Router (Recommended)
|
|
24
|
+
|
|
25
|
+
Import `getRegisteredCss` in your root layout to inject styles during SSR:
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
// app/layout.tsx
|
|
29
|
+
import { getRegisteredCss } from '@typestyles/next';
|
|
30
|
+
|
|
31
|
+
export default function RootLayout({ children }: { children: React.ReactNode }) {
|
|
32
|
+
const css = getRegisteredCss();
|
|
33
|
+
|
|
34
|
+
return (
|
|
35
|
+
<html lang="en">
|
|
36
|
+
<head>{css && <style dangerouslySetInnerHTML={{ __html: css }} />}</head>
|
|
37
|
+
<body>{children}</body>
|
|
38
|
+
</html>
|
|
39
|
+
);
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Pages Router
|
|
44
|
+
|
|
45
|
+
Wrap your pages with the stylesheet component:
|
|
46
|
+
|
|
47
|
+
```tsx
|
|
48
|
+
// pages/_app.tsx
|
|
49
|
+
import { TypestylesStylesheet } from '@typestyles/next';
|
|
50
|
+
import type { AppProps } from 'next/app';
|
|
51
|
+
|
|
52
|
+
export default function App({ Component, pageProps }: AppProps) {
|
|
53
|
+
return (
|
|
54
|
+
<TypestylesStylesheet>
|
|
55
|
+
<Component {...pageProps} />
|
|
56
|
+
</TypestylesStylesheet>
|
|
57
|
+
);
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## React Server Components (RSC)
|
|
62
|
+
|
|
63
|
+
The package provides multiple approaches for RSC support:
|
|
64
|
+
|
|
65
|
+
### Option 1: Layout SSR (Simplest)
|
|
66
|
+
|
|
67
|
+
Import `getRegisteredCss` in your root layout - this works in both Server and Client Components:
|
|
68
|
+
|
|
69
|
+
```tsx
|
|
70
|
+
// app/layout.tsx
|
|
71
|
+
import { getRegisteredCss } from '@typestyles/next';
|
|
72
|
+
|
|
73
|
+
export default function RootLayout({ children }) {
|
|
74
|
+
const css = getRegisteredCss();
|
|
75
|
+
|
|
76
|
+
return (
|
|
77
|
+
<html>
|
|
78
|
+
<head>{css && <style dangerouslySetInnerHTML={{ __html: css }} />}</head>
|
|
79
|
+
<body>{children}</body>
|
|
80
|
+
</html>
|
|
81
|
+
);
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Option 2: Client Component Provider
|
|
86
|
+
|
|
87
|
+
For complex cases with dynamic styles, create a client component wrapper:
|
|
88
|
+
|
|
89
|
+
```tsx
|
|
90
|
+
// components/TypestylesProvider.tsx
|
|
91
|
+
'use client';
|
|
92
|
+
|
|
93
|
+
import { getRegisteredCss } from 'typestyles/server';
|
|
94
|
+
import { useEffect, useState } from 'react';
|
|
95
|
+
|
|
96
|
+
export function TypestylesProvider({ children }) {
|
|
97
|
+
const [css, setCss] = useState('');
|
|
98
|
+
const [mounted, setMounted] = useState(false);
|
|
99
|
+
|
|
100
|
+
useEffect(() => {
|
|
101
|
+
setMounted(true);
|
|
102
|
+
setCss(getRegisteredCss());
|
|
103
|
+
}, []);
|
|
104
|
+
|
|
105
|
+
return (
|
|
106
|
+
<>
|
|
107
|
+
{children}
|
|
108
|
+
{mounted && css && <style id="typestyles" dangerouslySetInnerHTML={{ __html: css }} />}
|
|
109
|
+
</>
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Then use it in your layout:
|
|
115
|
+
|
|
116
|
+
```tsx
|
|
117
|
+
// app/layout.tsx
|
|
118
|
+
import { TypestylesProvider } from '@/components/TypestylesProvider';
|
|
119
|
+
|
|
120
|
+
export default function RootLayout({ children }) {
|
|
121
|
+
return (
|
|
122
|
+
<html>
|
|
123
|
+
<body>
|
|
124
|
+
<TypestylesProvider>{children}</TypestylesProvider>
|
|
125
|
+
</body>
|
|
126
|
+
</html>
|
|
127
|
+
);
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Option 3: Collecting from a specific component tree
|
|
132
|
+
|
|
133
|
+
`getTypestylesMetadata` (alias of `collectStylesFromComponent`) renders a React element on the server and returns the CSS registered during that render. Use it when you need CSS scoped to a subtree rather than the whole app. For App Router pages, injecting the result still belongs in `layout.tsx` / `<head>` (Next.js `Metadata` does not provide a supported hook for arbitrary `<style>` payloads).
|
|
134
|
+
|
|
135
|
+
```tsx
|
|
136
|
+
import { getTypestylesMetadata } from '@typestyles/next/server';
|
|
137
|
+
import { Home } from './Home';
|
|
138
|
+
|
|
139
|
+
const css = await getTypestylesMetadata(<Home />);
|
|
140
|
+
// Pass `css` into your layout <style> or streaming head pipeline.
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Build-time CSS + Turbopack
|
|
144
|
+
|
|
145
|
+
To ship a static stylesheet and avoid client-side `<style>` injection (uses `typestyles/build` under the hood):
|
|
146
|
+
|
|
147
|
+
1. Run **`buildTypestylesForNext({ root })`** before `next build`. It discovers the same **convention entry** as `@typestyles/vite` (see `DEFAULT_EXTRACT_MODULE_CANDIDATES` from `@typestyles/build-runner`) and by default writes **`app/typestyles.css`** plus **`app/typestyles.manifest.json`** (override paths or pass explicit `modules` when needed). When `app/` exists, it also emits **per-route CSS** under `app/_typestyles/routes/` and a **manifest v2** `routes` map (`routeCss: false` to disable).
|
|
148
|
+
2. Import that CSS from your root layout (e.g. `import './typestyles.css'`).
|
|
149
|
+
3. Wrap config with **`withTypestyles`** from `@typestyles/next/build` — in **production**, if a convention entry exists, it applies **`withTypestylesExtract`**; in **development** it leaves your config unchanged so the runtime stays on.
|
|
150
|
+
|
|
151
|
+
`withTypestylesExtract` sets **`NEXT_PUBLIC_TYPESTYLES_RUNTIME_DISABLED`** via `next.config` `env` (works with **webpack and Turbopack**) and adds webpack **`DefinePlugin`** for `__TYPESTYLES_RUNTIME_DISABLED__` on client bundles when webpack runs. Example app: `examples/next-app`.
|
|
152
|
+
|
|
153
|
+
### Runtime in development, zero-runtime in production
|
|
154
|
+
|
|
155
|
+
During `next dev`, keeping the client runtime **enabled** avoids tying every style tweak to a pre-build extraction step. In production, disable injection so the browser loads one cacheable stylesheet.
|
|
156
|
+
|
|
157
|
+
```js
|
|
158
|
+
// next.config.mjs
|
|
159
|
+
import { withTypestyles } from '@typestyles/next/build';
|
|
160
|
+
|
|
161
|
+
export default withTypestyles({
|
|
162
|
+
transpilePackages: ['typestyles', '@typestyles/next'],
|
|
163
|
+
});
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
You still typically run extraction before production builds (CI or `prebuild`). For full manual control, **`withTypestylesExtract`** remains available.
|
|
167
|
+
|
|
168
|
+
## API Reference
|
|
169
|
+
|
|
170
|
+
### getRouteCss
|
|
171
|
+
|
|
172
|
+
Read pre-extracted CSS for an App Router route from the build manifest (v2). Falls back to the full-app stylesheet when no route entry exists.
|
|
173
|
+
|
|
174
|
+
```tsx
|
|
175
|
+
import { getRouteCss } from '@typestyles/next/server';
|
|
176
|
+
|
|
177
|
+
const css = getRouteCss('/about', { root: process.cwd() });
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### getRegisteredCss
|
|
181
|
+
|
|
182
|
+
Returns all currently registered CSS as a string. This is the simplest way to get styles for SSR.
|
|
183
|
+
|
|
184
|
+
```tsx
|
|
185
|
+
import { getRegisteredCss } from '@typestyles/next';
|
|
186
|
+
|
|
187
|
+
const css = getRegisteredCss();
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### collectStylesFromComponent
|
|
191
|
+
|
|
192
|
+
Collect styles from a React component tree. Useful when you need explicit control over style collection.
|
|
193
|
+
|
|
194
|
+
```tsx
|
|
195
|
+
import { collectStylesFromComponent } from '@typestyles/next/server';
|
|
196
|
+
import { YourComponent } from './YourComponent';
|
|
197
|
+
|
|
198
|
+
const css = await collectStylesFromComponent(<YourComponent />);
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### getTypestylesMetadata
|
|
202
|
+
|
|
203
|
+
Same as `collectStylesFromComponent` — renders the given element on the server and returns registered CSS. Use when you want a dedicated name for “CSS for this subtree.”
|
|
204
|
+
|
|
205
|
+
```tsx
|
|
206
|
+
import { getTypestylesMetadata } from '@typestyles/next/server';
|
|
207
|
+
import { Home } from './Home';
|
|
208
|
+
|
|
209
|
+
const css = await getTypestylesMetadata(<Home />);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### TypestylesStylesheet (Pages Router)
|
|
213
|
+
|
|
214
|
+
A React component that renders typestyles CSS. Works with Pages Router.
|
|
215
|
+
|
|
216
|
+
```tsx
|
|
217
|
+
import { TypestylesStylesheet } from '@typestyles/next';
|
|
218
|
+
|
|
219
|
+
<TypestylesStylesheet>
|
|
220
|
+
<YourApp />
|
|
221
|
+
</TypestylesStylesheet>;
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
## Examples
|
|
225
|
+
|
|
226
|
+
### Basic Usage with App Router
|
|
227
|
+
|
|
228
|
+
```tsx
|
|
229
|
+
// app/page.tsx
|
|
230
|
+
import { styles } from 'typestyles';
|
|
231
|
+
|
|
232
|
+
const button = styles.component('button', {
|
|
233
|
+
base: {
|
|
234
|
+
padding: '12px 24px',
|
|
235
|
+
backgroundColor: '#0066ff',
|
|
236
|
+
color: 'white',
|
|
237
|
+
border: 'none',
|
|
238
|
+
borderRadius: '6px',
|
|
239
|
+
cursor: 'pointer',
|
|
240
|
+
},
|
|
241
|
+
});
|
|
242
|
+
|
|
243
|
+
export default function Home() {
|
|
244
|
+
return (
|
|
245
|
+
<main>
|
|
246
|
+
<button className={button()}>Click me</button>
|
|
247
|
+
</main>
|
|
248
|
+
);
|
|
249
|
+
}
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### With Design Tokens
|
|
253
|
+
|
|
254
|
+
```tsx
|
|
255
|
+
// app/tokens.ts
|
|
256
|
+
import { tokens } from 'typestyles';
|
|
257
|
+
|
|
258
|
+
export const colors = tokens.create('color', {
|
|
259
|
+
primary: '#0066ff',
|
|
260
|
+
secondary: '#64748b',
|
|
261
|
+
});
|
|
262
|
+
|
|
263
|
+
export const spacing = tokens.create('space', {
|
|
264
|
+
sm: '8px',
|
|
265
|
+
md: '16px',
|
|
266
|
+
lg: '24px',
|
|
267
|
+
});
|
|
268
|
+
|
|
269
|
+
// app/page.tsx
|
|
270
|
+
import { styles } from 'typestyles';
|
|
271
|
+
import { colors, spacing } from './tokens';
|
|
272
|
+
|
|
273
|
+
const card = styles.component('card', {
|
|
274
|
+
base: {
|
|
275
|
+
padding: spacing.md,
|
|
276
|
+
backgroundColor: colors.primary,
|
|
277
|
+
borderRadius: '8px',
|
|
278
|
+
},
|
|
279
|
+
});
|
|
280
|
+
|
|
281
|
+
export default function Page() {
|
|
282
|
+
return <div className={card()}>Hello World</div>;
|
|
283
|
+
}
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### With Dark Mode
|
|
287
|
+
|
|
288
|
+
```tsx
|
|
289
|
+
// app/layout.tsx
|
|
290
|
+
import { tokens } from 'typestyles';
|
|
291
|
+
import { getRegisteredCss } from '@typestyles/next';
|
|
292
|
+
|
|
293
|
+
const darkTheme = tokens.createTheme('dark', {
|
|
294
|
+
base: {
|
|
295
|
+
color: {
|
|
296
|
+
background: '#1a1a1a',
|
|
297
|
+
text: '#ffffff',
|
|
298
|
+
},
|
|
299
|
+
},
|
|
300
|
+
});
|
|
301
|
+
|
|
302
|
+
export default function RootLayout({ children }) {
|
|
303
|
+
const css = getRegisteredCss();
|
|
304
|
+
|
|
305
|
+
return (
|
|
306
|
+
<html className={darkTheme.className}>
|
|
307
|
+
<head>{css && <style dangerouslySetInnerHTML={{ __html: css }} />}</head>
|
|
308
|
+
<body>{children}</body>
|
|
309
|
+
</html>
|
|
310
|
+
);
|
|
311
|
+
}
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
## Fonts and local files
|
|
315
|
+
|
|
316
|
+
`global.fontFace()` registers `@font-face` like any other TypeStyles global. For **Next’s pre-build extraction** (`buildTypestylesForNext`), prefer fonts under **`public/fonts/`** and a root-relative `url('/fonts/…')` in `src` so Node does not need to resolve binary imports.
|
|
317
|
+
|
|
318
|
+
For **Vite**, you can use `import file from './font.woff2?url'` and `url(\`${file}\`) format('woff2')` so production CSS points at hashed assets.
|
|
319
|
+
|
|
320
|
+
See the **Fonts** guide in the TypeStyles docs (`docs/content/docs/fonts.md`, route `/docs/fonts` on the docs site).
|
|
321
|
+
|
|
322
|
+
## Troubleshooting
|
|
323
|
+
|
|
324
|
+
### Flash of Unstyled Content (FOUC)
|
|
325
|
+
|
|
326
|
+
If you see a flash of unstyled content, ensure `getRegisteredCss()` is called in the layout and styles are injected before the body renders.
|
|
327
|
+
|
|
328
|
+
### Styles not appearing
|
|
329
|
+
|
|
330
|
+
Make sure `typestyles` is installed in your project:
|
|
331
|
+
|
|
332
|
+
```bash
|
|
333
|
+
npm install typestyles
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### TypeScript errors
|
|
337
|
+
|
|
338
|
+
Ensure you have `"moduleResolution": "bundler"` or `"node"` in your `tsconfig.json`.
|
|
339
|
+
|
|
340
|
+
## License
|
|
341
|
+
|
|
342
|
+
Apache-2.0
|
package/dist/build.cjs
ADDED
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/build.ts
|
|
21
|
+
var build_exports = {};
|
|
22
|
+
__export(build_exports, {
|
|
23
|
+
DEFAULT_EXTRACT_MODULE_CANDIDATES: () => import_build_runner2.DEFAULT_EXTRACT_MODULE_CANDIDATES,
|
|
24
|
+
VerifyTypestylesBuildError: () => import_build_runner2.VerifyTypestylesBuildError,
|
|
25
|
+
buildTypestylesForNext: () => buildTypestylesForNext,
|
|
26
|
+
discoverDefaultExtractModules: () => import_build_runner2.discoverDefaultExtractModules,
|
|
27
|
+
getRouteCss: () => import_build_runner2.getRouteCss,
|
|
28
|
+
verifyTypestylesBuild: () => import_build_runner2.verifyTypestylesBuild,
|
|
29
|
+
withTypestyles: () => withTypestyles,
|
|
30
|
+
withTypestylesExtract: () => withTypestylesExtract
|
|
31
|
+
});
|
|
32
|
+
module.exports = __toCommonJS(build_exports);
|
|
33
|
+
var import_node_fs = require("fs");
|
|
34
|
+
var import_promises = require("fs/promises");
|
|
35
|
+
var import_node_module = require("module");
|
|
36
|
+
var import_node_path = require("path");
|
|
37
|
+
var import_node_url = require("url");
|
|
38
|
+
var import_build_runner = require("@typestyles/build-runner");
|
|
39
|
+
var import_build = require("typestyles/build");
|
|
40
|
+
var import_build_runner2 = require("@typestyles/build-runner");
|
|
41
|
+
function resolveExtractModulesForNext(root, modules) {
|
|
42
|
+
if (modules !== void 0) {
|
|
43
|
+
return modules;
|
|
44
|
+
}
|
|
45
|
+
const found = (0, import_build_runner.discoverDefaultExtractModules)(root);
|
|
46
|
+
if (found.length === 0) {
|
|
47
|
+
throw new Error(
|
|
48
|
+
`[typestyles] No extraction entry found under ${root}. Add a convention file (see DEFAULT_EXTRACT_MODULE_CANDIDATES from @typestyles/build-runner) or pass modules to buildTypestylesForNext.`
|
|
49
|
+
);
|
|
50
|
+
}
|
|
51
|
+
return found;
|
|
52
|
+
}
|
|
53
|
+
async function buildTypestylesForNext(options) {
|
|
54
|
+
const {
|
|
55
|
+
root,
|
|
56
|
+
modules,
|
|
57
|
+
cssOutFile = "app/typestyles.css",
|
|
58
|
+
manifestOutFile,
|
|
59
|
+
manifestCssPath,
|
|
60
|
+
routeCssOutDir = "app/_typestyles/routes",
|
|
61
|
+
appDir = "app"
|
|
62
|
+
} = options;
|
|
63
|
+
const resolvedModules = resolveExtractModulesForNext(root, modules);
|
|
64
|
+
const enableRouteCss = options.routeCss ?? discoverNextAppRoutesEnabled(root, appDir);
|
|
65
|
+
const loaders = resolvedModules.map((mod) => {
|
|
66
|
+
const abs = (0, import_node_path.resolve)(root, mod);
|
|
67
|
+
const href = (0, import_node_url.pathToFileURL)(abs).href;
|
|
68
|
+
return () => import(href);
|
|
69
|
+
});
|
|
70
|
+
const css = await (0, import_build.collectStylesFromModules)(loaders);
|
|
71
|
+
const outAbs = (0, import_node_path.resolve)(root, cssOutFile);
|
|
72
|
+
await (0, import_promises.mkdir)((0, import_node_path.dirname)(outAbs), { recursive: true });
|
|
73
|
+
await (0, import_promises.writeFile)(outAbs, css, "utf8");
|
|
74
|
+
const manifestRel = manifestOutFile === false ? void 0 : manifestOutFile ?? "app/typestyles.manifest.json";
|
|
75
|
+
if (manifestRel) {
|
|
76
|
+
const cssPath = manifestCssPath ?? cssOutFile;
|
|
77
|
+
let manifest = {
|
|
78
|
+
version: 1,
|
|
79
|
+
css: cssPath
|
|
80
|
+
};
|
|
81
|
+
if (enableRouteCss) {
|
|
82
|
+
const { routes } = await (0, import_build_runner.collectAndWriteRouteCss)({
|
|
83
|
+
root,
|
|
84
|
+
sharedModules: resolvedModules,
|
|
85
|
+
appDir,
|
|
86
|
+
routeCssOutDir,
|
|
87
|
+
collectCss: import_build.collectStylesFromModules
|
|
88
|
+
});
|
|
89
|
+
manifest = (0, import_build_runner.buildManifestV2)(cssPath, routes);
|
|
90
|
+
}
|
|
91
|
+
const manAbs = (0, import_node_path.resolve)(root, manifestRel);
|
|
92
|
+
await (0, import_promises.mkdir)((0, import_node_path.dirname)(manAbs), { recursive: true });
|
|
93
|
+
await (0, import_promises.writeFile)(manAbs, `${JSON.stringify(manifest, null, 2)}
|
|
94
|
+
`, "utf8");
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
function discoverNextAppRoutesEnabled(root, appDir) {
|
|
98
|
+
return (0, import_node_fs.existsSync)((0, import_node_path.resolve)(root, appDir));
|
|
99
|
+
}
|
|
100
|
+
function withTypestyles(nextConfig = {}, options = {}) {
|
|
101
|
+
const projectRoot = options.root ?? process.cwd();
|
|
102
|
+
const hasConventionEntry = (0, import_build_runner.discoverDefaultExtractModules)(projectRoot).length > 0;
|
|
103
|
+
const prod = process.env.NODE_ENV === "production";
|
|
104
|
+
if (!prod || !hasConventionEntry) {
|
|
105
|
+
return nextConfig;
|
|
106
|
+
}
|
|
107
|
+
return withTypestylesExtract(nextConfig, options);
|
|
108
|
+
}
|
|
109
|
+
function withTypestylesExtract(nextConfig = {}, options = {}) {
|
|
110
|
+
const disableClientRuntime = options.disableClientRuntime !== false;
|
|
111
|
+
const projectRoot = options.root ?? process.cwd();
|
|
112
|
+
return {
|
|
113
|
+
...nextConfig,
|
|
114
|
+
...disableClientRuntime ? {
|
|
115
|
+
env: {
|
|
116
|
+
...typeof nextConfig.env === "object" && nextConfig.env !== null && !Array.isArray(nextConfig.env) ? nextConfig.env : {},
|
|
117
|
+
NEXT_PUBLIC_TYPESTYLES_RUNTIME_DISABLED: "true"
|
|
118
|
+
}
|
|
119
|
+
} : {},
|
|
120
|
+
webpack(config, context) {
|
|
121
|
+
const nextWebpack = typeof nextConfig.webpack === "function" ? nextConfig.webpack(config, context) : config;
|
|
122
|
+
if (disableClientRuntime && !context.isServer) {
|
|
123
|
+
try {
|
|
124
|
+
const require2 = (0, import_node_module.createRequire)((0, import_node_path.join)(projectRoot, "package.json"));
|
|
125
|
+
const webpackLib = require2("webpack");
|
|
126
|
+
nextWebpack.plugins.push(
|
|
127
|
+
new webpackLib.DefinePlugin({
|
|
128
|
+
__TYPESTYLES_RUNTIME_DISABLED__: JSON.stringify("true")
|
|
129
|
+
})
|
|
130
|
+
);
|
|
131
|
+
} catch {
|
|
132
|
+
console.warn(
|
|
133
|
+
"[@typestyles/next/build] Could not load webpack; client bundles may still inject <style>."
|
|
134
|
+
);
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
return nextWebpack;
|
|
138
|
+
}
|
|
139
|
+
};
|
|
140
|
+
}
|
|
141
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
142
|
+
0 && (module.exports = {
|
|
143
|
+
DEFAULT_EXTRACT_MODULE_CANDIDATES,
|
|
144
|
+
VerifyTypestylesBuildError,
|
|
145
|
+
buildTypestylesForNext,
|
|
146
|
+
discoverDefaultExtractModules,
|
|
147
|
+
getRouteCss,
|
|
148
|
+
verifyTypestylesBuild,
|
|
149
|
+
withTypestyles,
|
|
150
|
+
withTypestylesExtract
|
|
151
|
+
});
|