@koumoul/vjsf 3.0.0-beta.3 → 3.0.0-beta.31

package/src/components/nodes/one-of-select.vue

@@ -1,8 +1,13 @@
 <script setup>
-import { VSelect, VRow } from 'vuetify/components'
-import { shallowRef, watch } from 'vue'
+import { VSelect, VRow, VCol } from 'vuetify/components'
+import { ref, watch, computed, h } from 'vue'
 import { isSection } from '@json-layout/core'
+import { isCompObject } from '@json-layout/vocabulary'
+import { getInputProps } from '../../utils/index.js'
 import Node from '../node.vue'
+import { useDefaults } from 'vuetify'
+
+useDefaults({}, 'VjsfOneOfSelect')
 
 const props = defineProps({
   modelValue: {
@@ -17,40 +22,56 @@ const props = defineProps({
   }
 })
 
-/** @type import('vue').ShallowRef<import('@json-layout/core').SkeletonTree | undefined> */
-const activeChildTree = shallowRef(undefined)
+/** @type import('vue').Ref<string | undefined> */
+const activeChildTree = ref(undefined)
 watch(() => props.modelValue, () => {
-  // we set the active oneOf child as the one whose schema validates on the current data
-  if (props.modelValue.fullKey in props.statefulLayout.activeItems) {
-    activeChildTree.value = props.modelValue.skeleton.childrenTrees?.[props.statefulLayout.activeItems[props.modelValue.fullKey]]
+  if (props.modelValue.children?.length === 1) {
+    if (typeof props.modelValue.children[0].key === 'number') {
+      activeChildTree.value = props.modelValue.skeleton.childrenTrees?.[props.modelValue.children[0].key]
+    }
   } else {
     activeChildTree.value = undefined
   }
 }, { immediate: true })
 
-const onChange = (/** @type import('@json-layout/core').SkeletonTree */childTree) => {
+const onChange = (/** @type {string} */childTree) => {
   if (!props.modelValue.skeleton.childrenTrees) return
   props.statefulLayout.activateItem(props.modelValue, props.modelValue.skeleton.childrenTrees.indexOf(childTree))
 }
 
+const fieldProps = computed(() => {
+  const fieldProps = getInputProps(props.modelValue, props.statefulLayout)
+  fieldProps.modelValue = activeChildTree.value
+  fieldProps['onUpdate:modelValue'] = onChange
+  const items = []
+  for (const childTreePointer of props.modelValue.skeleton.childrenTrees || []) {
+    const childTree = props.statefulLayout.compiledLayout.skeletonTrees[childTreePointer]
+    const childLayout = props.statefulLayout.compiledLayout.normalizedLayouts[childTree.root]
+    if (!isCompObject(childLayout) || !childLayout.if || !!props.statefulLayout.evalNodeExpression(props.modelValue, childLayout.if, props.modelValue.data)) {
+      items.push(childTree)
+    }
+  }
+  fieldProps.items = items
+  fieldProps.itemTitle = 'title'
+  fieldProps.itemValue = (/** @type {import('@json-layout/core').SkeletonTree} */childTree) => childTree.root
+  return fieldProps
+})
 </script>
 
 <template>
-  <v-select
-    v-if="modelValue.skeleton.childrenTrees"
-    v-model="activeChildTree"
-    :items="modelValue.skeleton.childrenTrees"
-    item-title="title"
-    return-object
-    :error-messages="modelValue.validated ? modelValue.error : null"
-    @update:model-value="onChange"
-  />
-  <v-row v-if="modelValue.children?.[0]">
-    <node
-      v-for="grandChild of isSection(modelValue.children?.[0]) ? modelValue.children?.[0].children : modelValue.children"
-      :key="grandChild.fullKey"
-      :model-value="/** @type import('../../types.js').VjsfNode */(grandChild)"
-      :stateful-layout="statefulLayout"
-    />
+  <v-row>
+    <v-col v-if="modelValue.skeleton.childrenTrees">
+      <v-select
+        v-bind="fieldProps"
+      />
+    </v-col>
+    <template v-if="modelValue.children?.[0]">
+      <node
+        v-for="grandChild of isSection(modelValue.children?.[0]) ? modelValue.children?.[0].children : modelValue.children"
+        :key="grandChild.fullKey"
+        :model-value="/** @type import('../../types.js').VjsfNode */(grandChild)"
+        :stateful-layout="statefulLayout"
+      />
+    </template>
   </v-row>
 </template>

package/src/components/nodes/radio-group.vue

@@ -0,0 +1,53 @@
+<script>
+import { VRadioGroup, VRadio, VSkeletonLoader } from 'vuetify/components'
+import { defineComponent, h, computed } from 'vue'
+import { getInputProps, getCompSlots } from '../../utils/index.js'
+import useGetItems from '../../composables/use-get-items.js'
+import { useDefaults } from 'vuetify'
+
+export default defineComponent({
+  props: {
+    modelValue: {
+      /** @type import('vue').PropType<import('../../types.js').VjsfRadioGroupNode> */
+      type: Object,
+      required: true
+    },
+    statefulLayout: {
+      /** @type import('vue').PropType<import('../../types.js').VjsfStatefulLayout> */
+      type: Object,
+      required: true
+    }
+  },
+  setup (props) {
+    useDefaults({}, 'VjsfRadioGroup')
+
+    const getItems = useGetItems(props)
+
+    const fieldProps = computed(() => {
+      const fieldProps = getInputProps(props.modelValue, props.statefulLayout)
+      return fieldProps
+    })
+
+    const fieldSlots = computed(() => {
+      const slots = getCompSlots(props.modelValue, props.statefulLayout)
+      /** @type {import('vue').VNode[]} */
+      const children = []
+      if (getItems.loading.value) {
+        children.push(h(VSkeletonLoader, { type: 'chip' }))
+      } else {
+        for (const item of getItems.items.value) {
+          children.push(h(VRadio, { label: item.title, value: item.value }))
+        }
+      }
+      slots.default = () => children
+      return slots
+    })
+
+    // @ts-ignore
+    return () => {
+      return h(VRadioGroup, fieldProps.value, fieldSlots.value)
+    }
+  }
+})
+
+</script>

package/src/components/nodes/section.vue

@@ -2,6 +2,9 @@
 import { VRow } from 'vuetify/components'
 import Node from '../node.vue'
 import SectionHeader from '../fragments/section-header.vue'
+import { useDefaults } from 'vuetify'
+
+useDefaults({}, 'VjsfSection')
 
 defineProps({
   modelValue: {

package/src/components/nodes/select.vue

@@ -1,9 +1,11 @@
 <script>
 import { VSelect } from 'vuetify/components'
-import { defineComponent, h, computed, ref, shallowRef } from 'vue'
+import { defineComponent, h, computed } from 'vue'
 import { getInputProps, getCompSlots } from '../../utils/index.js'
+import useGetItems from '../../composables/use-get-items.js'
 import SelectItem from '../fragments/select-item.vue'
 import SelectSelection from '../fragments/select-selection.vue'
+import { useDefaults } from 'vuetify'
 
 export default defineComponent({
   props: {
@@ -19,38 +21,19 @@ export default defineComponent({
     }
   },
   setup (props) {
-    /** @type import('vue').Ref<import('@json-layout/vocabulary').SelectItems> */
-    const items = shallowRef([])
-    /** @type import('vue').Ref<boolean> */
-    const loading = ref(false)
+    useDefaults({}, 'VjsfSelect')
+
+    const getItems = useGetItems(props)
 
     const fieldProps = computed(() => {
       const fieldProps = getInputProps(props.modelValue, props.statefulLayout, ['multiple'])
       if (props.modelValue.options.readOnly) fieldProps.menuProps = { modelValue: false }
-      fieldProps.loading = loading.value
-      fieldProps.items = items.value
-      fieldProps['onUpdate:menu'] = refresh
+      fieldProps.loading = getItems.loading.value
+      fieldProps.items = getItems.items.value
+      fieldProps.clearable = fieldProps.clearable ?? !props.modelValue.skeleton.required
       return fieldProps
     })
 
-    /** @type import('@json-layout/core').StateTree | null */
-    let lastStateTree = null
-    /** @type Record<string, any> | null */
-    let lastContext = null
-
-    const refresh = async () => {
-      if (props.statefulLayout.stateTree === lastStateTree && props.statefulLayout.options.context === lastContext) return
-      lastStateTree = props.statefulLayout.stateTree
-      lastContext = props.statefulLayout.options.context ?? null
-      loading.value = true
-      items.value = await props.statefulLayout.getItems(props.modelValue)
-      loading.value = false
-    }
-
-    if (!props.modelValue.layout.items) {
-      refresh()
-    }
-
     const fieldSlots = computed(() => {
       const slots = getCompSlots(props.modelValue, props.statefulLayout)
       if (!slots.item) {
@@ -64,7 +47,7 @@ export default defineComponent({
         slots.selection = (/** @type {any} */ context) => h(SelectSelection, {
           multiple: props.modelValue.layout.multiple,
           last: props.modelValue.layout.multiple && context.index === props.modelValue.data.length - 1,
-          item: context.item.raw
+          item: getItems.prepareSelectedItem(context.item.raw, context.item.value)
         })
       }
       return slots

package/src/components/nodes/slider.vue

@@ -2,6 +2,9 @@
 import { VSlider } from 'vuetify/components'
 import { computed } from 'vue'
 import { getInputProps } from '../../utils/index.js'
+import { useDefaults } from 'vuetify'
+
+useDefaults({}, 'VjsfSlider')
 
 const props = defineProps({
   modelValue: {

package/src/components/nodes/stepper.vue

@@ -4,6 +4,9 @@ import { VStepper, VStepperHeader, VStepperItem, VStepperWindow, VStepperWindowI
 import { isSection } from '@json-layout/core'
 import Node from '../node.vue'
 import SectionHeader from '../fragments/section-header.vue'
+import { useDefaults } from 'vuetify'
+
+useDefaults({}, 'VjsfStepper')
 
 const props = defineProps({
   modelValue: {

package/src/components/nodes/switch-group.vue

@@ -0,0 +1,39 @@
+<script>
+import { useDefaults } from 'vuetify'
+import SelectionGroup from '../fragments/selection-group.vue'
+import { defineComponent, h } from 'vue'
+
+export default defineComponent({
+  props: {
+    modelValue: {
+    /** @type import('vue').PropType<import('../../types.js').VjsfCheckboxGroupNode> */
+      type: Object,
+      required: true
+    },
+    statefulLayout: {
+    /** @type import('vue').PropType<import('../../types.js').VjsfStatefulLayout> */
+      type: Object,
+      required: true
+    }
+  },
+  setup (props) {
+    useDefaults({}, 'VjsfSwitchGroup')
+
+    // @ts-ignore
+    return () => {
+      return h(SelectionGroup, {
+        modelValue: props.modelValue,
+        statefulLayout: props.statefulLayout,
+        type: 'switch'
+      })
+    }
+  }
+})
+
+</script>
+
+<style>
+.vjsf-node-checkbox-group .v-selection-control-group .v-checkbox .v-selection-control {
+  min-height: auto;
+}
+</style>

package/src/components/nodes/switch.vue

@@ -2,6 +2,9 @@
 import { VSwitch } from 'vuetify/components'
 import { computed } from 'vue'
 import { getInputProps } from '../../utils/index.js'
+import { useDefaults } from 'vuetify'
+
+useDefaults({}, 'VjsfSwitch')
 
 const props = defineProps({
   modelValue: {
@@ -16,9 +19,12 @@ const props = defineProps({
   }
 })
 
-const fieldProps = computed(() =>
-  getInputProps(props.modelValue, props.statefulLayout)
-)
+const fieldProps = computed(() => {
+  const inputProps = getInputProps(props.modelValue, props.statefulLayout)
+  // it is not very common to show an error below checkboxes and switches and without hide-details=auto they take a lot of space
+  if (!('hideDetails' in inputProps)) inputProps.hideDetails = 'auto'
+  return inputProps
+})
 </script>
 
 <template>

package/src/components/nodes/tabs.vue

@@ -1,9 +1,14 @@
 <script setup>
 import { VTabs, VTab, VContainer, VSheet, VWindow, VWindowItem, VRow, VIcon } from 'vuetify/components'
+import { useDefaults } from 'vuetify'
 import { ref } from 'vue'
 import { isSection } from '@json-layout/core'
 import Node from '../node.vue'
 import SectionHeader from '../fragments/section-header.vue'
+import useCompDefaults from '../../composables/use-comp-defaults.js'
+
+useDefaults({}, 'VjsfTabs')
+const vSheetProps = useCompDefaults('VjsfTabs-VSheet', { border: true })
 
 defineProps({
   modelValue: {
@@ -23,13 +28,15 @@ const tab = ref(0)
 
 <template>
   <section-header :node="modelValue" />
-  <v-sheet border>
-    <v-tabs v-model="tab">
+  <v-sheet v-bind="vSheetProps">
+    <v-tabs
+      v-model="tab"
+      direction="horizontal"
+    >
       <v-tab
         v-for="(child, i) of modelValue.children"
         :key="child.key"
         :value="i"
-        :density="modelValue.options.density"
         :color="child.validated && (child.error || child.childError) ? 'error' : undefined"
       >
         <v-icon

package/src/components/nodes/text-field.vue

@@ -2,6 +2,7 @@
 import { defineComponent, h, computed } from 'vue'
 import { VTextField } from 'vuetify/components'
 import { getInputProps, getCompSlots } from '../../utils/index.js'
+import { useDefaults } from 'vuetify'
 
 export default defineComponent({
   props: {
@@ -17,6 +18,8 @@ export default defineComponent({
     }
   },
   setup (props) {
+    useDefaults({}, 'VjsfTextField')
+
     const fieldProps = computed(() => getInputProps(props.modelValue, props.statefulLayout, ['placeholder']))
     const fieldSlots = computed(() => getCompSlots(props.modelValue, props.statefulLayout))
 

package/src/components/nodes/textarea.vue

@@ -2,6 +2,7 @@
 import { defineComponent, h, computed, ref, watch } from 'vue'
 import { VTextarea } from 'vuetify/components'
 import { getInputProps, getCompSlots } from '../../utils/index.js'
+import { useDefaults } from 'vuetify'
 
 export default defineComponent({
   props: {
@@ -17,6 +18,8 @@ export default defineComponent({
     }
   },
   setup (props) {
+    useDefaults({}, 'VjsfTextArea')
+
     /** @type {import('vue').Ref<null | HTMLElement>} */
     const textarea = ref(null)
 

package/src/components/nodes/vertical-tabs.vue

@@ -4,6 +4,11 @@ import { VTabs, VTab, VContainer, VSheet, VWindow, VWindowItem, VRow, VIcon } fr
 import { ref } from 'vue'
 import Node from '../node.vue'
 import SectionHeader from '../fragments/section-header.vue'
+import { useDefaults } from 'vuetify'
+import useCompDefaults from '../../composables/use-comp-defaults.js'
+
+useDefaults({}, 'VjsfVerticalTabs')
+const vSheetProps = useCompDefaults('VjsfVerticalTabs-VSheet', { border: true })
 
 defineProps({
   modelValue: {
@@ -23,7 +28,7 @@ const tab = ref(0)
 
 <template>
   <section-header :node="modelValue" />
-  <v-sheet border>
+  <v-sheet v-bind="vSheetProps">
     <div class="d-flex flex-row">
       <v-tabs
         v-model="tab"

package/src/components/options.js

@@ -1,8 +1,8 @@
 /** @type {import("../types.js").PartialVjsfOptions} */
 export const defaultOptions = {
-  errorAlertProps: { type: 'error', variant: 'tonal' },
   nodeComponents: {},
-  plugins: {}
+  plugins: [],
+  pluginsOptions: {}
 }
 
 /**
@@ -11,18 +11,34 @@ export const defaultOptions = {
  * @param {any} form
  * @param {number} width
  * @param {import("vue").Slots} slots
- * @param {Record<string, import('vue').Component>} nodeComponents
+ * @param {Record<string, import('vue').Component>} defaultNodeComponents
+ * @param {(data: any) => void} onData
+ * @param {(statefulLayout: import('@json-layout/core').StatefulLayout) => void} onUpdate
+ * @param {(key: string) => void} onAutofocus
  * @returns
  */
-export const getFullOptions = (options, form, width, slots, nodeComponents) => {
+export const getFullOptions = (options, form, width, slots, defaultNodeComponents, onData, onUpdate, onAutofocus) => {
+  const components = { ...options?.components }
+  const nodeComponents = { ...defaultNodeComponents, ...options?.nodeComponents }
+  if (options?.plugins) {
+    for (const plugin of options.plugins) {
+      components[plugin.info.name] = plugin.info
+      nodeComponents[plugin.info.name] = plugin.nodeComponent
+    }
+  }
+
   const fullOptions = {
     ...defaultOptions,
     readOnly: !!(form && (form.isDisabled.value || form.isReadonly.value)),
     ...options,
+    onData,
+    onUpdate,
+    onAutofocus,
     context: options?.context ? JSON.parse(JSON.stringify(options.context)) : {},
     width: Math.round(width ?? 0),
     vjsfSlots: { ...slots },
-    nodeComponents: { ...nodeComponents, ...options?.nodeComponents }
+    components,
+    nodeComponents
   }
   return /** @type import('../types.js').VjsfOptions */ (fullOptions)
 }

package/src/components/vjsf.vue

@@ -18,6 +18,9 @@ import NodeDateTimePicker from './nodes/date-time-picker.vue'
 import NodeColorPicker from './nodes/color-picker.vue'
 import NodeSelect from './nodes/select.vue'
 import NodeAutocomplete from './nodes/autocomplete.vue'
+import NodeRadioGroup from './nodes/radio-group.vue'
+import NodeCheckboxGroup from './nodes/checkbox-group.vue'
+import NodeSwitchGroup from './nodes/switch-group.vue'
 import NodeOneOfSelect from './nodes/one-of-select.vue'
 import NodeTabs from './nodes/tabs.vue'
 import NodeVerticalTabs from './nodes/vertical-tabs.vue'
@@ -42,6 +45,9 @@ const nodeComponents = {
   'color-picker': NodeColorPicker,
   select: NodeSelect,
   autocomplete: NodeAutocomplete,
+  'radio-group': NodeRadioGroup,
+  'checkbox-group': NodeCheckboxGroup,
+  'switch-group': NodeSwitchGroup,
   'one-of-select': NodeOneOfSelect,
   tabs: NodeTabs,
   'vertical-tabs': NodeVerticalTabs,

package/src/composables/use-comp-defaults.js

@@ -0,0 +1,19 @@
+import { inject, computed } from 'vue'
+
+// inspired by https://github.com/vuetifyjs/vuetify/blob/27b4b1e52060b6bee13a290a4829f935f1bd9c05/packages/vuetify/src/composables/defaults.ts#L92
+/**
+ *
+ * @param {string} name
+ * @param {Record<string, any> | null} [localDefaults]
+ * @returns {import('vue').ComputedRef<Record<string, any>>}
+ */
+export default function useCompDefaultProps (name, localDefaults = null) {
+  /** @type {import('vue').Ref<import('vuetify').DefaultsInstance> | undefined} */
+  const defaults = inject(Symbol.for('vuetify:defaults'))
+  if (!defaults) throw new Error('[vjsf] Could not find defaults instance')
+  return computed(() => {
+    const componentDefaults = defaults.value?.[name] ?? {}
+    if (!localDefaults) return componentDefaults
+    return { ...componentDefaults, ...localDefaults }
+  })
+}

package/src/composables/use-dnd.js

@@ -42,6 +42,7 @@ export default function useDnd (array, callback) {
       dragging.value = itemIndex
     },
     onDragend: () => {
+      hovered.value = itemIndex
       dragging.value = -1
       callback()
     }

package/src/composables/use-get-items.js

@@ -0,0 +1,48 @@
+import { watch, shallowRef, ref, computed } from 'vue'
+
+/**
+ * @param {{modelValue: import('@json-layout/core').StateNode, statefulLayout: import('../types.js').VjsfStatefulLayout}} props
+ */
+export default function (props) {
+  /** @type import('vue').Ref<import('@json-layout/vocabulary').SelectItems> */
+  const items = shallowRef([])
+  /** @type import('vue').Ref<boolean> */
+  const loading = ref(false)
+  /** @type import('vue').Ref<string> */
+  const search = ref('')
+
+  const fetchItems = async () => {
+    loading.value = true
+    items.value = await props.statefulLayout.getItems(props.modelValue, search.value)
+    loading.value = false
+  }
+
+  watch(() => props.modelValue.itemsCacheKey, (newValue, oldValue) => {
+    if (newValue === oldValue) return
+    fetchItems()
+  }, { immediate: true })
+
+  watch(search, () => {
+    fetchItems()
+  })
+
+  /**
+   * @param {any} selectedItem
+   * @param {any} itemValue
+   */
+  const prepareSelectedItem = (selectedItem, itemValue) => {
+    let item = selectedItem
+    // item and value are the same when the selection is not found in items list
+    if (selectedItem === itemValue) {
+      try {
+        item = props.statefulLayout.prepareSelectItem(props.modelValue, selectedItem)
+        if (item.value === undefined) item.value = itemValue
+      } catch (e) {
+        item = { value: itemValue }
+      }
+    }
+    return item
+  }
+
+  return { items, loading, search, prepareSelectedItem }
+}