@opencor/opencor 0.20250813.0 → 0.20250814.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/README.md +15 -12
- package/dist/{index-BxzyBYAw.js → index-DnnuRqyP.js} +6512 -6505
- package/dist/index.d.ts +3 -4
- package/dist/opencor.es.js +1 -1
- package/dist/opencor.umd.js +26 -26
- package/dist/{quill-BGLY3Ud3.js → quill-CL4ccaRT.js} +1 -1
- package/package.json +1 -1
- package/src/components/OpenCOR.vue +19 -4
package/README.md
CHANGED
|
@@ -7,15 +7,16 @@ There are two versions of OpenCOR:
|
|
|
7
7
|
1. **OpenCOR:** a desktop application that can be run on [Intel](https://en.wikipedia.org/wiki/List_of_Intel_processors)-based and [ARM](https://en.wikipedia.org/wiki/ARM_architecture_family)-based [Windows](https://en.wikipedia.org/wiki/Microsoft_Windows), [Linux](https://en.wikipedia.org/wiki/Linux), and [macOS](https://en.wikipedia.org/wiki/MacOS) machines; and
|
|
8
8
|
2. **OpenCOR's Web app:** a [Web app](https://en.wikipedia.org/wiki/Web_application) that can be run on a Web browser.
|
|
9
9
|
|
|
10
|
-
This package is a [Vue 3](https://vuejs.org/) component for OpenCOR
|
|
10
|
+
This package is a [Vue 3](https://vuejs.org/) component for OpenCOR, built with the [Composition API](https://vuejs.org/guide/extras/composition-api-faq).
|
|
11
11
|
|
|
12
12
|
## Usage
|
|
13
13
|
|
|
14
|
-
The component comes with
|
|
14
|
+
The component comes with the following props:
|
|
15
15
|
|
|
16
|
-
|
|
|
17
|
-
|
|
|
18
|
-
| `omex` | The URL
|
|
16
|
+
| Name | Type | Default | Description |
|
|
17
|
+
| ------- | ---------------------------- | -------- | --------------------------------------------------------------- |
|
|
18
|
+
| `omex` | String | `null` | The URL of the [OMEX file](https://combinearchive.org/) to use. |
|
|
19
|
+
| `theme` | `light`, `dark`, or `system` | `system` | The theme to use. |
|
|
19
20
|
|
|
20
21
|
- **main.ts:**
|
|
21
22
|
|
|
@@ -28,6 +29,8 @@ createApp(App).mount('#app')
|
|
|
28
29
|
|
|
29
30
|
### No `omex` prop provided
|
|
30
31
|
|
|
32
|
+
When no `omex` prop is provided, the component gives access to all of OpenCOR's features
|
|
33
|
+
|
|
31
34
|
- **App.vue:**
|
|
32
35
|
|
|
33
36
|
```vue
|
|
@@ -36,13 +39,15 @@ createApp(App).mount('#app')
|
|
|
36
39
|
</template>
|
|
37
40
|
|
|
38
41
|
<script setup lang="ts">
|
|
39
|
-
import OpenCOR from 'opencor'
|
|
40
|
-
import 'opencor/style.css'
|
|
42
|
+
import OpenCOR from '@opencor/opencor'
|
|
43
|
+
import '@opencor/opencor/style.css'
|
|
41
44
|
</script>
|
|
42
45
|
```
|
|
43
46
|
|
|
44
47
|
### With `omex` prop provided
|
|
45
48
|
|
|
49
|
+
When an `omex` prop is provided, the component goes straight into OpenCOR's simulation mode, using the specified OMEX file.
|
|
50
|
+
|
|
46
51
|
- **App.vue:**
|
|
47
52
|
|
|
48
53
|
```vue
|
|
@@ -51,11 +56,9 @@ import 'opencor/style.css'
|
|
|
51
56
|
</template>
|
|
52
57
|
|
|
53
58
|
<script setup lang="ts">
|
|
54
|
-
import OpenCOR from 'opencor'
|
|
55
|
-
import 'opencor/style.css'
|
|
59
|
+
import OpenCOR from '@opencor/opencor'
|
|
60
|
+
import '@opencor/opencor/style.css'
|
|
56
61
|
</script>
|
|
57
62
|
```
|
|
58
63
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
See [LICENSE](LICENSE).
|
|
64
|
+
[](https://deepwiki.com/opencor/webapp)
|