Building Maker

BIMData Building Maker library.

Install

npm install @bimdata/building-maker

Usage (Vue 3.x)

The library provide a Vue plugin that you can use to register the BuildingMaker component together with its translations.

import BuildingMaker from "@bimdata/building-maker/vue3-plugin.js";
...

const i18n = createI18n({ ... });

const app = createApp(App).use(i18n);

app.use(BuildingMaker({ i18nPlugin: i18n }));

Once registered you can use the BuildingMaker component in your .vue files like so:

<template>
  ...
  <BuildingMaker
    :apiClient="apiClient"
    :space="mySpace"
    :project="myProject"
    @metaBuilding-created="onMetaBuildingCreated"
    @metaBuilding-updated="onMetaBuildingUpdated"
    @metaBuilding-deleted="onMetaBuildingDeleted"
  />
</template>

Component API

BuildingMaker component props

| Name | Default | Description | | ---------- | ------- | ----------- | | apiClient* | | An instance of @bimdata/typescript-fetch-api-client | | space* | | Current space | | project* | | Current project | | model | null | Model (meta-building) to open |

* : Required props.

BuildingMaker component events

| Name | Payload | Description | | ---------------------- | ------- | ----------- | | metaBuilding-created | None | Emitted on meta-building creation | | metaBuilding-updated | None | Emitted on meta-building update | | metaBuilding-deleted | None | Emitted on meta-building deletion |

License

The content of this repository is published under the terms of the LGPL v3 (see LICENSE).