feat(admin): allow rendering description in shipping methods

myparcelnl · Jul 5, 2024 · bde392d · bde392d
1 parent 0507fa6
commit bde392d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/apps/admin-preset-default/src/components/DefaultShippingMethodsInput.vue b/apps/admin-preset-default/src/components/DefaultShippingMethodsInput.vue
@@ -25,7 +25,11 @@
         <PdkTableCol
           component="th"
           :class="config?.cssUtilities?.whitespaceNoWrap">
-          {{ shippingMethod.label }}
+          <p v-text="shippingMethod.label" />
+
+          <small
+            v-if="shippingMethod.description"
+            v-html="translate(shippingMethod.description)" />
         </PdkTableCol>
 
         <PdkTableCol
@@ -59,7 +63,7 @@ import {
   useShippingMethodsInputContext,
 } from '@myparcel-pdk/admin';
 import {isEnumValue} from '@myparcel/ts-utils';
-import {PackageTypeName} from '@myparcel/constants';
+import {PackageTypeName} from '@myparcel/constants'; // eslint-disable-next-line vue/no-unused-properties
 
 // eslint-disable-next-line vue/no-unused-properties
 const props = defineProps<ShippingMethodsInputProps>();

diff --git a/apps/admin/src/types/form.types.ts b/apps/admin/src/types/form.types.ts
@@ -1,7 +1,7 @@
 import {type Keyable, type SortType} from '@myparcel-pdk/common';
 import {type InteractiveElementInstance} from '@myparcel/vue-form-builder';
 import {type AdminIcon} from '../data';
-import {type Translation} from './language.types';
+import {type Translatable, type Translation} from './language.types';
 
 export type GlobalFieldProps = {
   description?: Translation;
@@ -40,6 +40,7 @@ interface BaseSelectOption<Value extends SelectOptionValue = SelectOptionValue>
   disabled?: boolean;
   icon?: string | AdminIcon;
   image?: string;
+  description?: Translatable;
   value: Value;
 }