@archilogic/floor-plan-sdk 0.0.0-20240716133754
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 +42 -0
- package/dist/fpe.d.ts +3120 -0
- package/dist/fpe.js +43204 -0
- package/dist/fpe.umd.cjs +10 -0
- package/dist/style.css +1 -0
- package/package.json +39 -0
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Floor Plan SDK
|
|
2
|
+
|
|
3
|
+
The @archilogic/floor-plan-sdk package enables you to create and embed interactive, customizable floor plans in the browser
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i @archilogic/floor-plan-sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## API Extractor
|
|
12
|
+
|
|
13
|
+
This package uses [API Extractor](https://api-extractor.com/) to generate [API report](./api.md) and [doc model](https://api-extractor.com/pages/overview/demo_docs/#whats-in-the-json-file) files
|
|
14
|
+
|
|
15
|
+
- The API report is used to track changes to the public API. This file is internal and tracked by git
|
|
16
|
+
- The doc model file is distributed with the npm package, and is used to generate the public documentation
|
|
17
|
+
|
|
18
|
+
Both files are generated by the `npm run build:api` command
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
### npm package
|
|
23
|
+
```bash
|
|
24
|
+
npm i @archilogic/floor-plan-sdk
|
|
25
|
+
```
|
|
26
|
+
```js
|
|
27
|
+
import { FloorPlanEngine } from '@archilogic/floor-plan-sdk'
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### es module import via CDN
|
|
31
|
+
```js
|
|
32
|
+
import { FloorPlanEngine } from 'https://esm.sh/@archilogic/floor-plan-sdk'
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### umd module import via CDN
|
|
36
|
+
```html
|
|
37
|
+
<script src="https://unpkg.com/@archilogic/floor-plan-sdk"></script>
|
|
38
|
+
<script>
|
|
39
|
+
const { FloorPlanEngine } = FloorPlanSdk
|
|
40
|
+
</script>
|
|
41
|
+
```
|
|
42
|
+
|