rename default loader to basic loader to avoid confusions

Dataport · Aug 20, 2024 · 9c6f8b1 · 9c6f8b1
1 parent 7a35910
commit 9c6f8b1
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 13 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/plugins/LoadingIndicator/README.md b/packages/plugins/LoadingIndicator/README.md
@@ -10,7 +10,7 @@ A generic loading indicator that may be used by any plugin or outside procedure
 
 | fieldName  | type | description |
 | - | - | - |
-| loaderStyle | enum['CircleLoader', 'DefaultLoader', 'none', 'RingLoader', 'RollerLoader', 'SpinnerLoader', 'v-progress-linear']? | Choose between different loader styles. Defaults to 'v-progress-linear' (Vuetify loader). |
+| loaderStyle | enum['CircleLoader', 'BasicLoader', 'none', 'RingLoader', 'RollerLoader', 'SpinnerLoader', 'v-progress-linear']? | Choose between different loader styles. Defaults to 'v-progress-linear' (Vuetify loader). |
 
 For details on the `displayComponent` attribute, refer to the [Global Plugin Parameters](../../core/README.md#global-plugin-parameters) section of `@polar/core`.
 
@@ -38,7 +38,7 @@ map.$store.commit('plugin/loadingIndicator/setLoaderStyle', loaderStyle)
 <table align="center">
   <tr align="center">
     <td width="33%" align="center"><img src="./assets/VuetifyLoader.PNG" alt="v-progress-linear" height="120px" style="object-fit: none;"><div>v-progress-linear</div></td>
-    <td width="33%" align="center"><img src="./assets/DefaultLoader.PNG" alt="DefaultLoader" height="120px" style="object-fit: contain;"><div>DefaultLoader</div></td>
+    <td width="33%" align="center"><img src="./assets/BasicLoader.PNG" alt="BasicLoader" height="120px" style="object-fit: contain;"><div>BasicLoader</div></td>
     <td width="33%" align="center"><img src="./assets/RingLoader.PNG" alt="RingLoader" height="120px" style="object-fit: contain;"><div>RingLoader</div></td>
   </tr>
   <tr align="center">

diff --git a/packages/plugins/LoadingIndicator/src/components/LoadingIndicator.vue b/packages/plugins/LoadingIndicator/src/components/LoadingIndicator.vue
@@ -27,7 +27,7 @@ import RollerLoader from './loaderStyles/Roller.vue'
 import CircleLoader from './loaderStyles/Circle.vue'
 import SpinnerLoader from './loaderStyles/Spinner.vue'
 import RingLoader from './loaderStyles/Ring.vue'
-import DefaultLoader from './loaderStyles/Default.vue'
+import BasicLoader from './loaderStyles/Basic.vue'
 
 export default Vue.extend({
   name: 'LoadingIndicator',
@@ -36,7 +36,7 @@ export default Vue.extend({
     CircleLoader,
     SpinnerLoader,
     RingLoader,
-    DefaultLoader,
+    BasicLoader,
   },
   computed: {
     ...mapGetters('plugin/loadingIndicator', ['showLoader', 'loaderStyle']),

diff --git a/...r/src/components/loaderStyles/Default.vue → ...tor/src/components/loaderStyles/Basic.vue b/...r/src/components/loaderStyles/Default.vue → ...tor/src/components/loaderStyles/Basic.vue
@@ -18,8 +18,13 @@
 <script lang="ts">
 import Vue from 'vue'
 
+/**
+ * This loader is the lds-default loader from https://loading.io/css/.
+ * It was renamed to BasicLoader to avoid confusion with the default loader.
+ */
+
 export default Vue.extend({
-  name: 'DefaultLoader',
+  name: 'BasicLoader',
 })
 </script>
 

diff --git a/packages/plugins/LoadingIndicator/src/store/mutations.ts b/packages/plugins/LoadingIndicator/src/store/mutations.ts
@@ -4,7 +4,7 @@ import { LoadingIndicatorMutations } from '../types'
 import { getInitialState } from './state'
 const styles = [
   'CircleLoader',
-  'DefaultLoader',
+  'BasicLoader',
   'none',
   'RingLoader',
   'RollerLoader',

diff --git a/packages/types/custom/core.ts b/packages/types/custom/core.ts
@@ -36,7 +36,7 @@ export type RenderType = 'iconMenu' | 'independent' | 'footer'
 
 export type LoaderStyles =
   | 'CircleLoader'
-  | 'DefaultLoader'
+  | 'BasicLoader'
   | 'none'
   | 'RingLoader'
   | 'RollerLoader'