Rename composable with Mgl prefix to fit standards

docs/.vitepress/config.ts

@@ -28,6 +28,12 @@ export default defineConfig({
           { text: 'Introduction', link: '/components/introduction' },
         ]
       },
+      {
+        text: 'Composables',
+        items: [
+          { text: 'Introduction', link: '/composables/introduction' },
+        ]
+      },
       {
         text: 'About',
         items: [

docs/composables/introduction.md

@@ -0,0 +1,13 @@
+---
+outline: deep
+---
+
+::: info
+For further documentation, you can refer to the [vue-maplibre-gl documentation](https://indoorequal.github.io/vue-maplibre-gl/examples/use-map.html) that already include guides, API references, and examples.
+
+If you find any errors related the Nuxt module (a composable not available for example), please open an issue on the [GitHub repository](https://github.com/gugustinette/nuxt-maplibre).
+:::
+
+::: tip
+Note that composables are exported with the `Mgl` prefix added to the name of the composable. For example, the `useMap` composable is exported as `useMglMap`.
+:::

playground/pages/map/map-basic.client.vue

@@ -13,7 +13,7 @@ const style = 'https://api.maptiler.com/maps/streets/style.json?key=cQX2iET1gmOW
 const center = [-1.559482, 47.21322];
 const zoom = 8;
 
-const map = useMap();
+const map = useMglMap();
 console.log(map.isLoaded)
 console.log(map.isMounted)
 console.log(map.instance)

src/module.ts

@@ -73,7 +73,7 @@ export default defineNuxtModule<ModuleOptions>({
     for (const composable of composables) {
       addImports({
         name: composable,
-        as: composable,
+        as: 'useMgl' + composable.slice(3),
         from: '@indoorequal/vue-maplibre-gl'
       })
     }