chore(docs): add examples for plugin usage

reegodev · Mar 24, 2024 · 1afcd9a · 1afcd9a
1 parent 6897f90
commit 1afcd9a
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -1,6 +1,5 @@
 {
   "name": "vue-screen-docs",
-  "version": "2.0.0-alpha.0",
   "license": "MIT",
   "private": true,
   "scripts":{

diff --git a/packages/docs/src/guide/configuration/plugin.md b/packages/docs/src/guide/configuration/plugin.md
@@ -33,3 +33,29 @@ Config can be either:
 ```
 
 Please refer to [Composition API configuration](/guide/configuration/composition-api) for the signatures of each property.
+
+## Using `screen` and `grid` properties in your components
+
+### With composition API
+
+```vue
+<script setup>
+import { inject } from 'vue'
+
+const grid = inject('grid');
+const screen = inject('screen')
+</script>
+```
+
+### With options API
+
+```vue
+export default {
+  onMounted() {
+    console.log({
+      screen: this.$screen,
+      grid: this.$grid,
+    })
+  }
+}
+```
diff --git a/packages/e2e/package.json b/packages/e2e/package.json
@@ -1,6 +1,5 @@
 {
   "name": "vue-screen-e2e",
-  "version": "2.0.0-alpha.0",
   "license": "MIT",
   "private": true,
   "scripts": {

diff --git a/packages/examples/package.json b/packages/examples/package.json
@@ -1,7 +1,6 @@
 {
   "name": "vue-screen-examples",
   "private": true,
-  "version": "2.0.0-alpha.0",
   "scripts": {
     "serve": "vite"
   },