Skip to content

快速上手

本节将介绍如何在项目中使用,使用前请先确认是否已安装 npm ,没有安装请先参考安装章节

使用之前

在开始使用 mapgis-webclient-vue3-common 之前,请先确保开发者已经了解并掌握 vue3 开发的基本操作,重点包含以下内容。

mapgis-webclient-vue3-common 中涵盖以下 vue 的技术点,建议先掌握其使用方法。

  • prop 传递数据
  • slot 内容分发
  • events emit @click 事件

用法

在 main.ts 中写入以下内容:

完整引入

js
import { createApp } from 'vue'
import App from './App.vue'

import '@mapgis/webclient-common'

import Antd from 'ant-design-vue'
import MapGISUIComponents from '@mapgis/webclient-vue3-ui'
import MapGISCommonComponents from '@mapgis/webclient-vue3-common'

import 'ant-design-vue/dist/reset.css'
import '@mapgis/webclient-vue3-ui/dist/index.css'
import '@mapgis/webclient-vue3-common/dist/index.css'

createApp(App).use(Antd).use(MapGISUIComponents).use(MapGISCommonComponents).mount('#app')

按需导入

默认支持基于 ES modules 的 tree shaking,直接引入 import { Zoom } from '@mapgis/webclient-vue3-common'; 就会有按需加载的效果

vue
<template>
  <a-config-provider>
    <mapgis-theme-provider>
      <Zoom></Zoom>
    </mapgis-theme-provider>
  </a-config-provider>
</template>

<script>
import { Zoom } from '@mapgis/webclient-vue3-common'
import '@mapgis/webclient-vue3-common/dist/theme/zoom.css'
</script>