mirror of
https://github.com/vector-im/hydrogen-web.git
synced 2024-12-23 03:25:12 +01:00
update SDK docs to not use paths/vite anymore
This commit is contained in:
parent
93eca757d3
commit
8c1596d869
23
doc/SDK.md
23
doc/SDK.md
@ -33,7 +33,20 @@ import {
|
|||||||
RoomViewModel,
|
RoomViewModel,
|
||||||
TimelineView
|
TimelineView
|
||||||
} from "hydrogen-view-sdk";
|
} from "hydrogen-view-sdk";
|
||||||
import assetPaths from "hydrogen-view-sdk/paths/vite";
|
import downloadSandboxPath from 'hydrogen-view-sdk/download-sandbox.html?url';
|
||||||
|
import workerPath from 'hydrogen-view-sdk/main.js?url';
|
||||||
|
import olmWasmPath from '@matrix-org/olm/olm.wasm?url';
|
||||||
|
import olmJsPath from '@matrix-org/olm/olm.js?url';
|
||||||
|
import olmLegacyJsPath from '@matrix-org/olm/olm_legacy.js?url';
|
||||||
|
const assetPaths = {
|
||||||
|
downloadSandbox: downloadSandboxPath,
|
||||||
|
worker: workerPath,
|
||||||
|
olm: {
|
||||||
|
wasm: olmWasmPath,
|
||||||
|
legacyBundle: olmLegacyJsPath,
|
||||||
|
wasmBundle: olmJsPath
|
||||||
|
}
|
||||||
|
};
|
||||||
import "hydrogen-view-sdk/style.css";
|
import "hydrogen-view-sdk/style.css";
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
@ -84,7 +97,13 @@ main();
|
|||||||
|
|
||||||
## Typescript support
|
## Typescript support
|
||||||
|
|
||||||
There is partial typescript support while we are still in the process of converting the Hydrogen codebase to typesccript.
|
Typescript support is not yet available while we're converting the Hydrogen codebase to Typescript.
|
||||||
|
In your `src` directory, you'll need to add a `.d.ts` (can be called anything, e.g. `deps.d.ts`)
|
||||||
|
containing this snippet to make Typescript not complain that `hydrogen-view-sdk` doesn't have types:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
declare module "hydrogen-view-sdk";
|
||||||
|
```
|
||||||
|
|
||||||
## API Stability
|
## API Stability
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user