@limetech/lime-elements 40.22.0 → 40.23.0

package/dist/types/components/form/filled-defaults.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The value without the defaults that were filled into the value the form was
+ * given, as long as they still hold their default. A default the user changed
+ * stays, and so do the defaults of what the user added, such as a list item.
+ *
+ * @param value - the value the form holds, with the defaults filled in
+ * @param filled - the value the form was given, with the defaults filled in
+ * @param given - the value the form was given
+ * @returns the value without the defaults that were filled in
+ */
+export declare function withoutFilledDefaults(value: unknown, filled: unknown, given: unknown): unknown;
+//# sourceMappingURL=filled-defaults.d.ts.map

package/dist/types/components/form/form.d.ts

@@ -21,6 +21,7 @@ import { HeadingLevel } from '../../global/shared-types/heading-level.types';
  * @exampleComponent limel-example-code-editor-form
  * @exampleComponent limel-example-form-highlighted-field
  * @exampleComponent limel-example-form-heading-level
+ * @exampleComponent limel-example-form-include-defaults
  */
 export declare class Form {
     /**
@@ -72,6 +73,18 @@ export declare class Form {
      * which keeps untouched required-empty fields silent.
      */
     revealErrors: boolean;
+    /**
+     * Set to `false` to leave the defaults of the schema out of the value,
+     * so that it stays as it was given until the user changes something. The
+     * form still shows the defaults. A default the user changes is in the
+     * value from then on, and so are the defaults that a change brings in,
+     * such as those of a new list item or of fields that depend on the
+     * changed one. Pass the value the form emits back in as `value`.
+     * The form validates what it shows, defaults included. When the user
+     * changes everything back, the value is what the form was given, also
+     * when that is `null` or `undefined`.
+     */
+    includeDefaults: boolean;
     /**
      * The path in the value of a field to take the user to, such as
      * `['heroes', 2, 'name']`. When it changes, the form opens the sections
@@ -95,11 +108,14 @@ export declare class Form {
     validate: EventEmitter<ValidationStatus>;
     private host;
     private isValid;
+    private currentValue;
+    private givenValue?;
     private root;
     private initialized;
     constructor();
     connectedCallback(): void;
     componentWillLoad(): void;
+    protected handleValueChange(): void;
     componentDidLoad(): void;
     protected handleHeadingLevelChange(): void;
     private warnIfHeadingLevelIsInvalid;
@@ -112,6 +128,7 @@ export declare class Form {
     private showHighlightedField;
     private get rootElement();
     private handleChange;
+    private getGivenValue;
     private validateFormData;
     /**
      * Returns a copy of the schema with `$id` replaced by a content-based

package/dist/types/components/form/form.test-schemas.d.ts

@@ -56,4 +56,6 @@ export declare const untitledRootSchema: FormSchema;
 export declare const nestedCollapsibleSchema: FormSchema;
 export declare const untitledCollapsibleSchema: FormSchema;
 export declare const untitledRowSchema: FormSchema;
+export declare const dependencyWithDefaultsSchema: FormSchema;
+export declare const dependencyWithChangingDefaultSchema: FormSchema;
 //# sourceMappingURL=form.test-schemas.d.ts.map

package/dist/types/components.d.ts

@@ -1924,6 +1924,7 @@ export namespace Components {
      * @exampleComponent limel-example-code-editor-form
      * @exampleComponent limel-example-form-highlighted-field
      * @exampleComponent limel-example-form-heading-level
+     * @exampleComponent limel-example-form-include-defaults
      */
     interface LimelForm {
         /**
@@ -1945,6 +1946,11 @@ export namespace Components {
           * @beta
          */
         "highlightedField"?: Array<string | number>;
+        /**
+          * Set to `false` to leave the defaults of the schema out of the value, so that it stays as it was given until the user changes something. The form still shows the defaults. A default the user changes is in the value from then on, and so are the defaults that a change brings in, such as those of a new list item or of fields that depend on the changed one. Pass the value the form emits back in as `value`. The form validates what it shows, defaults included. When the user changes everything back, the value is what the form was given, also when that is `null` or `undefined`.
+          * @default true
+         */
+        "includeDefaults": boolean;
         /**
           * Factory for creating properties for custom form components  When using custom components in the form some properties might have to be set dynamically. If this factory is set, it will be called with the current schema for the field for each custom component in the form. The factory must return an object where each key is the name of the property that should be set, along with its value.
          */
@@ -5784,6 +5790,7 @@ declare global {
      * @exampleComponent limel-example-code-editor-form
      * @exampleComponent limel-example-form-highlighted-field
      * @exampleComponent limel-example-form-heading-level
+     * @exampleComponent limel-example-form-include-defaults
      */
     interface HTMLLimelFormElement extends Components.LimelForm, HTMLStencilElement {
         addEventListener<K extends keyof HTMLLimelFormElementEventMap>(type: K, listener: (this: HTMLLimelFormElement, ev: LimelFormCustomEvent<HTMLLimelFormElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -9284,6 +9291,7 @@ declare namespace LocalJSX {
      * @exampleComponent limel-example-code-editor-form
      * @exampleComponent limel-example-form-highlighted-field
      * @exampleComponent limel-example-form-heading-level
+     * @exampleComponent limel-example-form-include-defaults
      */
     interface LimelForm {
         /**
@@ -9305,6 +9313,11 @@ declare namespace LocalJSX {
           * @beta
          */
         "highlightedField"?: Array<string | number>;
+        /**
+          * Set to `false` to leave the defaults of the schema out of the value, so that it stays as it was given until the user changes something. The form still shows the defaults. A default the user changes is in the value from then on, and so are the defaults that a change brings in, such as those of a new list item or of fields that depend on the changed one. Pass the value the form emits back in as `value`. The form validates what it shows, defaults included. When the user changes everything back, the value is what the form was given, also when that is `null` or `undefined`.
+          * @default true
+         */
+        "includeDefaults"?: boolean;
         /**
           * Emitted when a change is made within the form
          */
@@ -12319,6 +12332,7 @@ declare namespace LocalJSX {
         "disabled": boolean;
         "headingLevel": HeadingLevel;
         "revealErrors": boolean;
+        "includeDefaults": boolean;
     }
     interface LimelFormHeaderAttributes {
         "heading": string;
@@ -13445,6 +13459,7 @@ declare module "@stencil/core" {
              * @exampleComponent limel-example-code-editor-form
              * @exampleComponent limel-example-form-highlighted-field
              * @exampleComponent limel-example-form-heading-level
+             * @exampleComponent limel-example-form-include-defaults
              */
             "limel-form": LocalJSX.IntrinsicElements["limel-form"] & JSXBase.HTMLAttributes<HTMLLimelFormElement>;
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "40.22.0",
+  "version": "40.23.0",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -77,9 +77,9 @@
     "dayjs": "^1.11.23",
     "diff": "^9.0.0",
     "echarts": "^6.1.0",
-    "eslint": "^10.13.0",
+    "eslint": "^10.14.0",
     "flatpickr": "^4.6.13",
-    "glob": "^13.0.6",
+    "glob": "^14.0.3",
     "globals": "^17.13.0",
     "hast-util-from-dom": "^5.0.1",
     "hast-util-to-mdast": "^10.1.2",