feat(api): settings description

vuejs · Feb 10, 2022 · bfe481c · bfe481c
1 parent ec2c324
commit bfe481c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/packages/api/src/plugin.ts b/packages/api/src/plugin.ts
@@ -20,6 +20,7 @@ export interface PluginDescriptor {
 
 export type PluginSettingsItem = {
   label: string
+  description?: string
 } & ({
   type: 'boolean'
   defaultValue: boolean

diff --git a/packages/app-backend-vue2/src/plugin.ts b/packages/app-backend-vue2/src/plugin.ts
@@ -21,7 +21,8 @@ export function setupPlugin (api: DevtoolsApi, app: App, Vue) {
     logo: 'https://vuejs.org/images/icons/favicon-96x96.png',
     settings: {
       legacyActions: {
-        label: 'Legacy Actions (enable with Vuex < 3.1.0)',
+        label: 'Legacy Actions',
+        description: 'Enable this for Vuex < 3.1.0',
         type: 'boolean',
         defaultValue: false,
       },

diff --git a/packages/app-frontend/src/features/plugin/PluginSettingsItem.vue b/packages/app-frontend/src/features/plugin/PluginSettingsItem.vue
@@ -51,7 +51,13 @@ export default defineComponent({
       class="flex-1 select-none text-sm py-1.5"
       @click="onLabelClick()"
     >
-      {{ schema.label }}
+      <div>{{ schema.label }}</div>
+      <div
+        v-if="schema.description"
+        class="opacity-75 text-xs"
+      >
+        {{ schema.description }}
+      </div>
     </div>
     <div class="w-1/2">
       <VueSwitch