Skip to content

Commit f174364

Browse files
committed
Update examples and Readme
1 parent 7f50bf4 commit f174364

File tree

5 files changed

+27
-31
lines changed

5 files changed

+27
-31
lines changed

.tkb

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,11 @@
11
{
22
"scope": "Workspace",
3-
"tasks": {
4-
"P_NrSJQ8m91Odgz8E1fS6": {
5-
"id": "P_NrSJQ8m91Odgz8E1fS6",
6-
"description": "Create your library and update examples",
7-
"columnId": "column-todo"
8-
},
9-
"1dRWJhy45E1Rq5wZAmPHt": {
10-
"id": "1dRWJhy45E1Rq5wZAmPHt",
11-
"description": "Update README as required",
12-
"columnId": "column-todo"
13-
},
14-
"O1qAByMoxhHOR-a_guL91": {
15-
"id": "O1qAByMoxhHOR-a_guL91",
16-
"description": "Optionally deploy your examples to Vercel.",
17-
"columnId": "column-todo"
18-
}
19-
},
3+
"tasks": {},
204
"columns": [
215
{
226
"id": "column-todo",
237
"title": "To do",
24-
"tasksIds": [
25-
"P_NrSJQ8m91Odgz8E1fS6",
26-
"1dRWJhy45E1Rq5wZAmPHt",
27-
"O1qAByMoxhHOR-a_guL91"
28-
]
8+
"tasksIds": []
299
},
3010
{
3111
"id": "column-doing",

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,17 @@ export default defineConfig({
7474

7575
---
7676

77+
## IDE Setup for IntelliSense and Type Checking
78+
79+
Add following to your declaration file. If you do not have one, create `declarations.d.ts` file and add following.
80+
81+
```typescript
82+
declare module "*?raw" {
83+
const value: string;
84+
export default value;
85+
}
86+
```
87+
7788
## Importing Files as Raw Text
7889

7990
With the plugin enabled, you can import files as raw text directly:

packages/shared/src/client/demo/demo.tsx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,13 @@ import styles from "./demo.module.scss";
44
import { LiveProvider, LiveEditor, LivePreview } from "react-live";
55
import { Dots1, Dots2, Bars1, Bars2 } from "react18-loaders/dist/server";
66
import text from "./index.ts?raw";
7-
8-
const code = `
9-
// available components Dots1, Dots2, Bars1, Bars2
10-
<div className="${styles.center}">
11-
<Bars1 color="var(--text-color)"/>
12-
</div>
13-
`;
7+
import code from "./loader-demo.tsx?raw";
148

159
/** React live demo */
1610
export function Demo() {
1711
console.log({ text });
1812
return (
19-
<LiveProvider code={code} scope={{ Dots1, Dots2, Bars1, Bars2 }}>
13+
<LiveProvider code={code.replace(/import.*/, "")} scope={{ Dots1, Dots2, Bars1, Bars2 }}>
2014
<div className={styles.demo}>
2115
<LiveEditor className={styles.code} />
2216
<LivePreview className={styles.preview} />
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { Bars1 } from "react18-loaders/dist/server";
2+
// Using esbuild-raw-plugin, we embedded this code into
3+
// a .tsx file, enabling IDE IntelliSense support.
4+
5+
// available components Dots1, Dots2, Bars1, Bars2
6+
<div className="${styles.center}">
7+
<Bars1 color="var(--text-color)" />
8+
</div>;
Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
declare module "*.module.css";
22
declare module "*.module.scss";
3-
declare module "*?raw";
3+
declare module "*?raw" {
4+
const value: string;
5+
export default value;
6+
}

0 commit comments

Comments
 (0)