@structured-field/widget-editor 1.3.0 → 1.4.0

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@structured-field/widget-editor",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A lightweight JSON Schema form builder with support for relation fields (ForeignKey, QuerySet) and autocomplete search.",
   "type": "module",
+  "packageManager": "pnpm@10.11.1",
+  "engines": {
+    "node": ">=20"
+  },
   "main": "dist/structured-widget-editor.js",
   "module": "dist/structured-widget-editor.esm.js",
   "repository": {
@@ -29,7 +33,7 @@
     "dev": "rollup -c -w",
     "test": "vitest run",
     "test:watch": "vitest",
-    "test:serve": "vite --open"
+    "playground": "vite --open"
   },
   "keywords": [
     "json-schema",

package/src/editors/ObjectEditor.vue

@@ -1,15 +1,18 @@
 <template>
   <div v-if="isRoot" class="sf-object sf-object-root">
     <div class="sf-object-fields">
-      <SchemaEditor
-        v-for="(propSchema, key) in (effectiveSchema.properties || {})"
-        :key="key"
-        :schema="form.resolveSchema(propSchema)"
-        :model-value="(modelValue || {})[key]"
-        :path="[...path, key]"
-        :form="form"
-        @update:model-value="onChildChange(key, $event)"
-      />
+      <template v-for="cell in cells" :key="cell.key">
+        <div v-if="cell.breakBefore" class="sf-flow-break" aria-hidden="true"></div>
+        <div :class="cell.classes">
+          <SchemaEditor
+            :schema="cell.schema"
+            :model-value="(modelValue || {})[cell.key]"
+            :path="[...path, cell.key]"
+            :form="form"
+            @update:model-value="onChildChange(cell.key, $event)"
+          />
+        </div>
+      </template>
     </div>
   </div>
   <fieldset v-else class="sf-object" :class="{ 'sf-object-collapsed': collapsed }">
@@ -21,15 +24,18 @@
       <span v-if="collapsed && summary" class="sf-object-summary">{{ summary }}</span>
     </legend>
     <div v-show="!collapsed" class="sf-object-fields">
-      <SchemaEditor
-        v-for="(propSchema, key) in (effectiveSchema.properties || {})"
-        :key="key"
-        :schema="form.resolveSchema(propSchema)"
-        :model-value="(modelValue || {})[key]"
-        :path="[...path, key]"
-        :form="form"
-        @update:model-value="onChildChange(key, $event)"
-      />
+      <template v-for="cell in cells" :key="cell.key">
+        <div v-if="cell.breakBefore" class="sf-flow-break" aria-hidden="true"></div>
+        <div :class="cell.classes">
+          <SchemaEditor
+            :schema="cell.schema"
+            :model-value="(modelValue || {})[cell.key]"
+            :path="[...path, cell.key]"
+            :form="form"
+            @update:model-value="onChildChange(cell.key, $event)"
+          />
+        </div>
+      </template>
     </div>
   </fieldset>
 </template>
@@ -38,6 +44,7 @@
 import SchemaEditor from './SchemaEditor.vue';
 import SfIcon from './SfIcon.vue';
 import { applyConditionals, hasConditionals } from '../conditionals';
+import { layoutCells } from '../layout';
 
 export default {
   name: 'ObjectEditor',
@@ -46,6 +53,9 @@ export default {
     this.$options.components.SchemaEditor = SchemaEditor;
     this.$options.components.SfIcon = SfIcon;
   },
+  inject: {
+    customEditors: { default: () => () => [] },
+  },
   props: {
     schema: { type: Object, required: true },
     modelValue: { default: () => ({}) },
@@ -72,6 +82,13 @@ export default {
       if (!hasConditionals(this.schema)) return this.schema;
       return applyConditionals(this.schema, this.modelValue || {}, this.form?.resolveSchema);
     },
+    cells() {
+      return layoutCells(this.effectiveSchema.properties, {
+        resolveSchema: this.form?.resolveSchema,
+        customEditors: this.customEditors(),
+        basePath: this.path,
+      });
+    },
     summary() {
       const val = this.modelValue || {};
       const parts = [];

package/src/editors/RelationEditor.vue

@@ -1,5 +1,5 @@
 <template>
-  <div class="sf-field sf-relation" :class="{ errors: fieldErrors.length }" ref="root">
+  <div class="sf-field sf-relation" :class="{ errors: fieldErrors.length, 'sf-relation-multiple': isMultiple, 'sf-relation-open': dropdownVisible }" ref="root">
     <span class="sf-label" :class="{ required: isRequired }">{{ title }}</span>
     <div class="sf-relation-wrapper">
       <!-- Selected items -->

package/src/editors/SchemaEditor.vue

@@ -36,8 +36,7 @@ import RelationEditor from './RelationEditor.vue';
 import JsonEditor from './JsonEditor.vue';
 import WebComponentWrapper from './WebComponentWrapper.vue';
 import { isChoiceOneOf } from '../utils';
-
-const MAX_DEPTH = 12;
+import { MAX_DEPTH } from '../layout';
 
 export default {
   name: 'SchemaEditor',

package/src/index.js

@@ -16,6 +16,7 @@ export { default as RelationEditor } from './editors/RelationEditor.vue';
 export { default as WebComponentWrapper } from './editors/WebComponentWrapper.vue';
 export { BaseEditorElement } from './BaseEditorElement.js';
 export { applyConditionals, matchesSchema, hasConditionals } from './conditionals.js';
+export { fieldSize, layoutCells, normalizeLayoutHint } from './layout.js';
 
 import { defineCustomElement } from 'vue';
 import SchemaFormComponent from './SchemaForm.vue';

package/src/layout.js

@@ -0,0 +1,116 @@
+import { isChoiceOneOf } from './utils';
+
+// Field-size classification for the multicolumn flow layout.
+// Sizes are flex-basis tokens (see scss/components/layout.scss), not column
+// counts: columns emerge from how many cells fit the container's width.
+// Invariant: visual order === DOM order === tab order. Never reorder cells.
+
+const SIZES = ['xs', 'sm', 'md', 'lg', 'full'];
+const BREAKS = ['before', 'after', 'both'];
+
+// Schema-author hint: `layout: 'sm'` or `layout: { size: 'sm', break: 'before' }`.
+// Invalid hints are silently ignored so a typo degrades to the heuristic.
+export function normalizeLayoutHint(layout) {
+  if (typeof layout === 'string') {
+    return { size: SIZES.includes(layout) ? layout : null, break: null };
+  }
+  if (layout && typeof layout === 'object' && !Array.isArray(layout)) {
+    return {
+      size: SIZES.includes(layout.size) ? layout.size : null,
+      break: BREAKS.includes(layout.break) ? layout.break : null,
+    };
+  }
+  return { size: null, break: null };
+}
+
+// Nullable scalars carry the inline null-clear button (~30px of chrome), and
+// datetime-local needs its full width — one tier of slack keeps them usable.
+const NULLABLE_BUMP = { xs: 'sm', sm: 'md' };
+
+function bumpNullable(size, schema) {
+  return schema._nullable ? (NULLABLE_BUMP[size] || size) : size;
+}
+
+function choiceSize(labels, schema) {
+  const compact = labels.length <= 8 && labels.every((l) => String(l ?? '').length <= 12);
+  return bumpNullable(compact ? 'sm' : 'md', schema);
+}
+
+// Shared with SchemaEditor: past this depth everything renders StringEditor.
+export const MAX_DEPTH = 12;
+
+// Intrinsic size of a RESOLVED schema node.
+// Returns 'xs' | 'sm' | 'md' | 'lg' | 'full' | 'hidden'.
+// Hidden routing (const / single-string-enum) is authoritative: a size hint
+// on a field that renders HiddenEditor would only produce an empty cell.
+export function fieldSize(schema) {
+  if (!schema || typeof schema !== 'object') return 'full';
+  const intrinsic = intrinsicSize(schema);
+  if (intrinsic === 'hidden') return 'hidden';
+  return normalizeLayoutHint(schema.layout).size || intrinsic;
+}
+
+// The branch order mirrors SchemaEditor.editorComponent — keep them in sync.
+function intrinsicSize(schema) {
+  if (schema.type === 'relation') return schema.multiple ? 'lg' : 'md';
+  if (schema.oneOf && schema.discriminator) return 'full';
+  if (isChoiceOneOf(schema.oneOf)) {
+    return choiceSize(schema.oneOf.map((o) => o.title ?? o.const), schema);
+  }
+  if ('const' in schema) return 'hidden';
+  if (schema.enum && schema.enum.length === 1 && schema.type === 'string') return 'hidden';
+  // Covers ObjectEditor, JsonEditor, ArrayEditor and NullableEditor containers.
+  if (schema.type === 'object' || schema.type === 'array') return 'full';
+  if (schema.enum) return choiceSize(schema.enum, schema);
+  if (schema.type === 'boolean') return bumpNullable('xs', schema);
+  if (schema.type === 'number' || schema.type === 'integer') return bumpNullable('xs', schema);
+  if (schema.type === 'string') {
+    if (schema.format === 'date') return bumpNullable('sm', schema);
+    if (schema.format === 'date-time') return bumpNullable('md', schema);
+    // Mirrors StringEditor.isLong (textarea rendering).
+    if (schema.format === 'textarea' || schema.maxLength > 255) return 'full';
+    if (schema.maxLength > 0 && schema.maxLength <= 40) return bumpNullable('sm', schema);
+    return 'md';
+  }
+  return 'full';
+}
+
+// Builds the cell list for an object's properties: resolved schema, wrapper
+// classes and row-break flags. `break: 'after'` marks the NEXT visible field;
+// hidden fields neither consume nor emit a pending break.
+// Custom-editor matches default to 'full' (we can't predict their rendering)
+// unless the schema hint or the override's own `layout` says otherwise.
+export function layoutCells(properties, { resolveSchema, customEditors = [], basePath = [] } = {}) {
+  const cells = [];
+  let pendingBreak = false;
+  // Mirrors SchemaEditor: the depth guard runs before custom-editor overrides,
+  // and past it every field (const included) renders a visible StringEditor.
+  const pastMaxDepth = basePath.length + 1 > MAX_DEPTH;
+  for (const [key, raw] of Object.entries(properties || {})) {
+    const schema = resolveSchema ? resolveSchema(raw) : raw;
+    const hint = normalizeLayoutHint(schema.layout);
+    const override = !pastMaxDepth
+      && customEditors.find((o) => o.match && o.match(schema, [...basePath, key]));
+    let size;
+    if (pastMaxDepth) {
+      size = 'md';
+    } else if (override) {
+      size = hint.size || normalizeLayoutHint(override.layout).size || 'full';
+    } else {
+      size = fieldSize(schema);
+    }
+    const classes = ['sf-cell', `sf-cell-${size}`];
+    // Only the plain-boolean shape reaches the label-less BooleanEditor;
+    // boolean enums / choice oneOfs render SelectEditor (which has a label).
+    const isCheckbox = schema.type === 'boolean' && !override && !pastMaxDepth
+      && !schema.enum && !schema.oneOf && !('const' in schema);
+    let breakBefore = false;
+    if (size !== 'hidden') {
+      if (isCheckbox) classes.push('sf-cell-bool');
+      breakBefore = pendingBreak || hint.break === 'before' || hint.break === 'both';
+      pendingBreak = hint.break === 'after' || hint.break === 'both';
+    }
+    cells.push({ key, schema, classes: classes.join(' '), breakBefore });
+  }
+  return cells;
+}

package/src/scss/components/layout.scss

@@ -0,0 +1,76 @@
+// Multicolumn flow layout for object fields.
+//
+// Model: each .sf-object-fields is a wrapping flex row; cells carry a
+// flex-basis token per field kind (set in src/layout.js) and grow to share
+// the line. Columns emerge from the available width at every nesting level —
+// no media/container queries, no containment (container-type would create
+// stacking contexts under the relation dropdown and collapse the widget's
+// intrinsic width inside Django tabular-inline table cells).
+//
+// Invariant: visual order === DOM order === tab order. No `order`, ever.
+//
+// Gate: @supports (inset: 0) matches the flex-`gap` era (Chrome 87+,
+// FF 66+, Safari 14.5+). Do not test `gap` itself — it false-positives on
+// browsers that only support grid gap. Ungated browsers keep the original
+// single-column flex layout from editors.scss.
+.structured-field-editor {
+
+  .sf-cell {
+    // Required guard: without it a long relation tag or wide intrinsic
+    // content makes the flex item refuse to shrink and blows up the row.
+    min-width: 0;
+  }
+
+  .sf-cell-hidden {
+    display: none;
+  }
+
+  @supports (inset: 0) {
+    .sf-object-fields {
+      flex-flow: row wrap;
+      column-gap: 16px;
+      align-items: flex-start;
+    }
+
+    // Vertical rhythm stays on the editors' own margin-bottom (as in the
+    // single-column layout), so the zero-height row break adds no space.
+    .sf-flow-break {
+      flex-basis: 100%;
+      height: 0;
+    }
+
+    .sf-cell-xs   { flex: 1 1 var(--sf-basis-xs, 8rem); }
+    .sf-cell-sm   { flex: 1 1 var(--sf-basis-sm, 12rem); }
+    .sf-cell-md   { flex: 1 1 var(--sf-basis-md, 18rem); }
+    .sf-cell-lg   { flex: 1 1 var(--sf-basis-lg, 26rem); }
+    .sf-cell-full { flex: 1 1 100%; }
+
+    // Checkbox fields have no label above: equalize the bottom margin and
+    // anchor them to the line's bottom so the checkbox row sits on the same
+    // visual line as its neighbors' inputs.
+    .sf-cell > .sf-field-boolean {
+      margin-bottom: 12px;
+    }
+
+    .sf-cell-bool {
+      align-self: flex-end;
+
+      .sf-boolean-row {
+        min-height: var(--sf-control-height, 30px);
+      }
+    }
+
+    // While validation errors are shown, flex-end would sink checkboxes to
+    // the bottom of the grown line; anchor them to the top instead with a
+    // synthesized label row (one .sf-label line + its 4px margin).
+    @supports selector(:has(*)) {
+      .sf-object-fields:has(.errorlist) > .sf-cell-bool {
+        align-self: flex-start;
+
+        > .sf-field-boolean {
+          padding-top: calc(0.8125rem * 1.4 + 4px);
+        }
+      }
+    }
+  }
+}

package/src/scss/main.scss

@@ -1,3 +1,4 @@
 @use './components/form';
 @use './components/editors';
 @use './components/relation';
+@use './components/layout';