Skip to content

Commit 30fbc10

Browse files
author
Oleksandr Dzhychko
authored
Merge pull request #303 from modelix/docs/vue-model-api-reference
docs(vue-model-api): add minimal reference docs
2 parents 28ac89e + edfe638 commit 30fbc10

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
= Vue.js bindings
2+
:navtitle: `vue-model-api`
3+
4+
:tip-caption: 🔗 Quick Links
5+
[TIP]
6+
--
7+
https://github.com/modelix/modelix.core[Repository^] | https://github.com/modelix/modelix.core/blob/main/vue-model-api/build.gradle.kts[buildfile^] | Artifacts: https://artifacts.itemis.cloud/service/rest/repository/browse/npm-open/%40modelix/vue-model-api/[Nexus^]
8+
--
9+
10+
11+
12+
The `@modelix/vue-model-api` can be used to create Vue.js applications, that interact with a xref:reference/component-model-server.adoc[model server] by reading and writing models.
13+
14+
== Overview
15+
16+
`@modelix/vue-model-api` provides https://vuejs.org/guide/reusability/composables.html[Vue.js composable] to connect to the model server. It exposes the model as a tree of reactive objects to the application developer. The exposed object can be further wrapped by the generated TypeScript API by the xref:reference/component-model-api-gen-gradle.adoc[Gradle plugin for typed model API generation].
17+
18+
// Ideas for more comprehensive and useful documentation are recorded in https://issues.modelix.org/issue/MODELIX-599

docs/global/modules/core/partials/nav-reference.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@
66
* xref:core:reference/component-bulk-model-sync-gradle.adoc[]
77
* xref:core:reference/component-light-model-client.adoc[]
88
* xref:core:reference/component-mps-model-server-plugin.adoc[]
9+
* xref:core:reference/component-vue-model-api.adoc[]

0 commit comments

Comments
 (0)