feat(vModel): support HTMLDetailsElement

packages/compiler-dom/__tests__/transforms/__snapshots__/vModel.spec.ts.snap

@@ -143,6 +143,22 @@ return function render(_ctx, _cache) {
 }"
 `;
 
+exports[`compiler: transform v-model > simple expression for details 1`] = `
+"const _Vue = Vue
+
+return function render(_ctx, _cache) {
+  with (_ctx) {
+    const { vModelDetails: _vModelDetails, withDirectives: _withDirectives, openBlock: _openBlock, createElementBlock: _createElementBlock } = _Vue
+
+    return _withDirectives((_openBlock(), _createElementBlock("details", {
+      "onUpdate:modelValue": $event => ((model) = $event)
+    }, null, 8 /* PROPS */, ["onUpdate:modelValue"])), [
+      [_vModelDetails, model]
+    ])
+  }
+}"
+`;
+
 exports[`compiler: transform v-model > simple expression for input (checkbox) 1`] = `
 "const _Vue = Vue
 

packages/compiler-dom/__tests__/transforms/vModel.spec.ts

@@ -10,6 +10,7 @@ import { transformElement } from '../../../compiler-core/src/transforms/transfor
 import { DOMErrorCodes } from '../../src/errors'
 import {
   V_MODEL_CHECKBOX,
+  V_MODEL_DETAILS,
   V_MODEL_DYNAMIC,
   V_MODEL_RADIO,
   V_MODEL_SELECT,
@@ -99,6 +100,12 @@ describe('compiler: transform v-model', () => {
     expect(generate(root).code).toMatchSnapshot()
   })
 
+  test('simple expression for details', () => {
+    const root = transformWithModel('<details v-model="model" />')
+    expect(root.helpers).toContain(V_MODEL_DETAILS)
+    expect(generate(root).code).toMatchSnapshot()
+  })
+
   describe('errors', () => {
     test('plain elements with argument', () => {
       const onError = vi.fn()

packages/compiler-dom/src/errors.ts

@@ -53,7 +53,7 @@ export const DOMErrorMessages: Record<DOMErrorCodes, string> = {
   [DOMErrorCodes.X_V_HTML_WITH_CHILDREN]: `v-html will override element children.`,
   [DOMErrorCodes.X_V_TEXT_NO_EXPRESSION]: `v-text is missing expression.`,
   [DOMErrorCodes.X_V_TEXT_WITH_CHILDREN]: `v-text will override element children.`,
-  [DOMErrorCodes.X_V_MODEL_ON_INVALID_ELEMENT]: `v-model can only be used on <input>, <textarea> and <select> elements.`,
+  [DOMErrorCodes.X_V_MODEL_ON_INVALID_ELEMENT]: `v-model can only be used on <input>, <textarea>, <select> and <details> elements.`,
   [DOMErrorCodes.X_V_MODEL_ARG_ON_ELEMENT]: `v-model argument is not supported on plain elements.`,
   [DOMErrorCodes.X_V_MODEL_ON_FILE_INPUT_ELEMENT]: `v-model cannot be used on file inputs since they are read-only. Use a v-on:change listener instead.`,
   [DOMErrorCodes.X_V_MODEL_UNNECESSARY_VALUE]: `Unnecessary value binding used alongside v-model. It will interfere with v-model's behavior.`,

packages/compiler-dom/src/runtimeHelpers.ts

@@ -8,6 +8,9 @@ export const V_MODEL_TEXT: unique symbol = Symbol(__DEV__ ? `vModelText` : ``)
 export const V_MODEL_SELECT: unique symbol = Symbol(
   __DEV__ ? `vModelSelect` : ``,
 )
+export const V_MODEL_DETAILS: unique symbol = Symbol(
+  __DEV__ ? `vModelDetails` : ``,
+)
 export const V_MODEL_DYNAMIC: unique symbol = Symbol(
   __DEV__ ? `vModelDynamic` : ``,
 )
@@ -31,6 +34,7 @@ registerRuntimeHelpers({
   [V_MODEL_CHECKBOX]: `vModelCheckbox`,
   [V_MODEL_TEXT]: `vModelText`,
   [V_MODEL_SELECT]: `vModelSelect`,
+  [V_MODEL_DETAILS]: `vModelDetails`,
   [V_MODEL_DYNAMIC]: `vModelDynamic`,
   [V_ON_WITH_MODIFIERS]: `withModifiers`,
   [V_ON_WITH_KEYS]: `withKeys`,

packages/compiler-dom/src/transforms/vModel.ts

@@ -11,6 +11,7 @@ import {
 import { DOMErrorCodes, createDOMCompilerError } from '../errors'
 import {
   V_MODEL_CHECKBOX,
+  V_MODEL_DETAILS,
   V_MODEL_DYNAMIC,
   V_MODEL_RADIO,
   V_MODEL_SELECT,
@@ -51,6 +52,7 @@ export const transformModel: DirectiveTransform = (dir, node, context) => {
     tag === 'input' ||
     tag === 'textarea' ||
     tag === 'select' ||
+    tag === 'details' ||
     isCustomElement
   ) {
     let directiveToUse = V_MODEL_TEXT
@@ -94,6 +96,8 @@ export const transformModel: DirectiveTransform = (dir, node, context) => {
       }
     } else if (tag === 'select') {
       directiveToUse = V_MODEL_SELECT
+    } else if (tag === 'details') {
+      directiveToUse = V_MODEL_DETAILS
     } else {
       // textarea
       __DEV__ && checkDuplicatedValue()

packages/compiler-sfc/__tests__/__snapshots__/compileTemplate.spec.ts.snap

@@ -80,6 +80,6 @@ export function ssrRender(_ctx, _push, _parent, _attrs) {
 exports[`template errors 1`] = `
 [
   [SyntaxError: Error parsing JavaScript expression: Unexpected token (1:3)],
-  [SyntaxError: v-model can only be used on <input>, <textarea> and <select> elements.],
+  [SyntaxError: v-model can only be used on <input>, <textarea>, <select> and <details> elements.],
 ]
 `;

packages/compiler-ssr/src/transforms/ssrVModel.ts

@@ -174,6 +174,8 @@ export const ssrTransformModel: DirectiveTransform = (dir, node, context) => {
       node.children = [createInterpolation(model, model.loc)]
     } else if (node.tag === 'select') {
       processSelectChildren(node.children)
+    } else if (node.tag === 'details') {
+      // TODO
     } else {
       context.onError(
         createDOMCompilerError(

packages/compiler-vapor/__tests__/transforms/vModel.spec.ts

@@ -77,6 +77,12 @@ describe('compiler: vModel transform', () => {
     expect(root2.helpers).toContain('applyDynamicModel')
   })
 
+  test.todo('should support details', () => {
+    const { code, helpers } = compileWithVModel('<details v-model="model" />')
+    expect(code).toMatchSnapshot()
+    expect(helpers).toContain('applyDetailsModel')
+  })
+
   describe('errors', () => {
     test('invalid element', () => {
       const onError = vi.fn()

packages/runtime-dom/__tests__/directives/vModel.spec.ts

@@ -1496,4 +1496,35 @@ describe('vModel', () => {
     await nextTick()
     expect(foo.checked).toEqual(false)
   })
+
+  it('should work with details', async () => {
+    const component = defineComponent({
+      data() {
+        return { value: null }
+      },
+      render() {
+        return [
+          withVModel(
+            h('details', {
+              'onUpdate:modelValue': setValue.bind(this),
+            }),
+            this.value,
+          ),
+        ]
+      },
+    })
+    render(h(component), root)
+
+    const details: HTMLDetailsElement = root.querySelector('details')
+    const data = root._vnode.component.data
+
+    details.open = true
+    triggerEvent('toggle', details)
+    await nextTick()
+    expect(data.value).toEqual(true)
+
+    data.value = false
+    await nextTick()
+    expect(details.open).toEqual(false)
+  })
 })

packages/runtime-dom/src/directives/vModel.ts

@@ -370,6 +370,22 @@ function getCheckboxValue(
   return checked
 }
 
+export const vModelDetails: ModelDirective<HTMLDetailsElement> = {
+  created(el, { value }, vnode) {
+    el.open = looseEqual(value, vnode.props!.value)
+    el[assignKey] = getModelAssigner(vnode)
+    addEventListener(el, 'toggle', () => {
+      el[assignKey](el.open)
+    })
+  },
+  beforeUpdate(el, { value, oldValue }, vnode) {
+    el[assignKey] = getModelAssigner(vnode)
+    if (value !== oldValue) {
+      el.open = looseEqual(value, vnode.props!.value)
+    }
+  },
+}
+
 export const vModelDynamic: ObjectDirective<
   HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement
 > = {
@@ -393,6 +409,8 @@ function resolveDynamicModel(tagName: string, type: string | undefined) {
       return vModelSelect
     case 'TEXTAREA':
       return vModelText
+    case 'DETAILS':
+      return vModelDetails
     default:
       switch (type) {
         case 'checkbox':
@@ -465,4 +483,5 @@ export type VModelDirective =
   | typeof vModelCheckbox
   | typeof vModelSelect
   | typeof vModelRadio
+  | typeof vModelDetails
   | typeof vModelDynamic

packages/runtime-dom/src/index.ts

@@ -284,6 +284,7 @@ export {
   vModelCheckbox,
   vModelRadio,
   vModelSelect,
+  vModelDetails,
   vModelDynamic,
 } from './directives/vModel'
 export { withModifiers, withKeys } from './directives/vOn'