aac-board-viewer 0.1.1 → 0.1.2
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 +2 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -40,24 +40,10 @@ yarn add aac-board-viewer
|
|
|
40
40
|
|
|
41
41
|
## Quick Start
|
|
42
42
|
|
|
43
|
-
### Client-Side Usage
|
|
44
|
-
|
|
45
|
-
```tsx
|
|
46
|
-
import { BoardViewer, useAACFile } from 'aac-board-viewer';
|
|
47
|
-
import 'aac-board-viewer/styles';
|
|
48
|
-
|
|
49
|
-
function MyViewer() {
|
|
50
|
-
const { tree, loading, error } = useAACFile('/path/to/file.sps');
|
|
51
|
-
|
|
52
|
-
if (loading) return <div>Loading...</div>;
|
|
53
|
-
if (error) return <div>Error: {error.message}</div>;
|
|
54
|
-
|
|
55
|
-
return <BoardViewer tree={tree} />;
|
|
56
|
-
}
|
|
57
|
-
```
|
|
58
|
-
|
|
59
43
|
### Server-Side / API Usage
|
|
60
44
|
|
|
45
|
+
> Important: `@willwade/aac-processors` is a Node-only dependency (uses native modules like `better-sqlite3`). File parsing must happen server-side. For client apps, call an API that returns the parsed tree and pass that to `BoardViewer`.
|
|
46
|
+
|
|
61
47
|
```tsx
|
|
62
48
|
import { BoardViewer } from 'aac-board-viewer';
|
|
63
49
|
import 'aac-board-viewer/styles';
|
|
@@ -179,18 +165,6 @@ interface AACTree {
|
|
|
179
165
|
|
|
180
166
|
The library provides utilities for loading AAC files:
|
|
181
167
|
|
|
182
|
-
### Client-Side Loading
|
|
183
|
-
|
|
184
|
-
```tsx
|
|
185
|
-
import { useAACFile } from 'aac-board-viewer';
|
|
186
|
-
|
|
187
|
-
function Viewer({ fileUrl }) {
|
|
188
|
-
const { tree, loading, error } = useAACFile(fileUrl);
|
|
189
|
-
|
|
190
|
-
// ...
|
|
191
|
-
}
|
|
192
|
-
```
|
|
193
|
-
|
|
194
168
|
### Programmatic Loading
|
|
195
169
|
|
|
196
170
|
```tsx
|
package/package.json
CHANGED