@opencor/opencor 0.20251205.2 → 0.20251206.1

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 CHANGED
@@ -7,7 +7,12 @@ 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, built with the [Composition API](https://vuejs.org/guide/extras/composition-api-faq).
10
+ Some characteristics of this package are that:
11
+ - It is built as a [Vue 3](https://vuejs.org/) component using the [Composition API](https://vuejs.org/guide/extras/composition-api-faq).
12
+ - It uses [PrimeVue](https://www.primefaces.org/primevue/) as its UI framework.
13
+ - It uses [Tailwind CSS](https://tailwindcss.com/) for styling.
14
+ - It can be used as a standalone Web app or embedded in a Vue 3 application.
15
+ - It uses [CSS containment](https://developer.mozilla.org/en-US/docs/Web/CSS/Guides/Containment) to prevent CSS leakage when embedded in an application that uses a different UI framework.
11
16
 
12
17
  ## Usage
13
18
 
@@ -36,7 +41,9 @@ When no `omex` prop is provided, the component gives access to all of OpenCOR's
36
41
 
37
42
  ```vue
38
43
  <template>
39
- <OpenCOR />
44
+ <div style="height: 100vh; height: 100dvh;">
45
+ <OpenCOR />
46
+ </div>
40
47
  </template>
41
48
 
42
49
  <script setup lang="ts">
@@ -53,7 +60,9 @@ When an `omex` prop is provided, the component goes straight into OpenCOR's simu
53
60
 
54
61
  ```vue
55
62
  <template>
56
- <OpenCOR omex="https://raw.githubusercontent.com/opencor/webapp/refs/heads/main/tests/models/ui/lorenz.omex" />
63
+ <div style="height: 100vh; height: 100dvh;">
64
+ <OpenCOR omex="https://raw.githubusercontent.com/opencor/webapp/refs/heads/main/tests/models/ui/lorenz.omex" />
65
+ </div>
57
66
  </template>
58
67
 
59
68
  <script setup lang="ts">