@limetech/lime-elements 40.17.1 → 40.18.1

package/dist/types/components/form/fields/schema-field.d.ts

@@ -19,6 +19,7 @@ export declare class SchemaField extends React.Component<FieldProps> {
     constructor(props: any);
     private isInvalid;
     private getHelperText;
+    private hasHeaderFromForm;
     private handleCustomComponentChange;
     private handleChange;
     /**

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

@@ -7,6 +7,7 @@ import { HeadingLevel } from '../../global/shared-types/heading-level.types';
  * @exampleComponent limel-example-list-form
  * @exampleComponent limel-example-dynamic-form
  * @exampleComponent limel-example-custom-component-form
+ * @exampleComponent limel-example-custom-component-header-form
  * @exampleComponent limel-example-props-factory-form
  * @exampleComponent limel-example-form-layout
  * @exampleComponent limel-example-form-span-fields
@@ -109,6 +110,7 @@ export declare class Form {
     render(): any;
     private reactRender;
     private showHighlightedField;
+    private get rootElement();
     private handleChange;
     private validateFormData;
     /**

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

@@ -26,6 +26,10 @@ export declare const integerSchema: FormSchema;
 export declare const serverErrorsSchema: FormSchema;
 export declare const transformErrorsSchema: FormSchema;
 export declare const customComponentSchema: FormSchema;
+export declare const customComponentWithHeaderSchema: FormSchema;
+export declare const requiredCustomComponentWithHeaderSchema: FormSchema;
+export declare const customComponentWithHelpSchema: FormSchema;
+export declare const rowLayoutWithCustomComponentHeaderSchema: FormSchema;
 export declare const undefinedComponentSchema: FormSchema;
 export declare const emptySchema: FormSchema;
 export declare const hiddenFieldSchema: FormSchema;

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

@@ -104,7 +104,8 @@ export interface FormComponent<T = any> {
      */
     label?: string;
     /**
-     * The helper text for the current property
+     * The helper text for the current property. While the property has a
+     * validation error to show, this is the error.
      */
     helperText?: string;
     /**
@@ -224,6 +225,21 @@ export interface FormComponentOptions {
      * specified on the `FormComponent` interface
      */
     props?: Record<string, any>;
+    /**
+     * Let the form draw the title, the description and the help of the field
+     * above the component, as a heading that fits how deep the field is.
+     *
+     * The component still gets `label` and `helperText`, so a component that
+     * draws its own title or description should read this option in
+     * `formInfo.schema` and leave them out. It should still show `helperText`
+     * while `invalid` is `true`, because that is where the form puts a
+     * validation error.
+     *
+     * A row layout draws its own header, so the option has no effect there.
+     *
+     * Defaults to `false`.
+     */
+    showHeader?: boolean;
 }
 /**
  * @public

package/dist/types/components/form/show-field.d.ts

@@ -6,4 +6,10 @@
  * @param path - the path of the field in the value of the form
  */
 export declare function showField(root: HTMLElement, path: Array<string | number>): Promise<void>;
+/**
+ * Stop keeping the field that was shown last in view.
+ *
+ * @param root - the element the form is rendered in
+ */
+export declare function stopShowingField(root: HTMLElement | null): void;
 //# sourceMappingURL=show-field.d.ts.map

package/dist/types/components.d.ts

@@ -1899,6 +1899,7 @@ export namespace Components {
      * @exampleComponent limel-example-list-form
      * @exampleComponent limel-example-dynamic-form
      * @exampleComponent limel-example-custom-component-form
+     * @exampleComponent limel-example-custom-component-header-form
      * @exampleComponent limel-example-props-factory-form
      * @exampleComponent limel-example-form-layout
      * @exampleComponent limel-example-form-span-fields
@@ -5747,6 +5748,7 @@ declare global {
      * @exampleComponent limel-example-list-form
      * @exampleComponent limel-example-dynamic-form
      * @exampleComponent limel-example-custom-component-form
+     * @exampleComponent limel-example-custom-component-header-form
      * @exampleComponent limel-example-props-factory-form
      * @exampleComponent limel-example-form-layout
      * @exampleComponent limel-example-form-span-fields
@@ -9234,6 +9236,7 @@ declare namespace LocalJSX {
      * @exampleComponent limel-example-list-form
      * @exampleComponent limel-example-dynamic-form
      * @exampleComponent limel-example-custom-component-form
+     * @exampleComponent limel-example-custom-component-header-form
      * @exampleComponent limel-example-props-factory-form
      * @exampleComponent limel-example-form-layout
      * @exampleComponent limel-example-form-span-fields
@@ -13386,6 +13389,7 @@ declare module "@stencil/core" {
              * @exampleComponent limel-example-list-form
              * @exampleComponent limel-example-dynamic-form
              * @exampleComponent limel-example-custom-component-form
+             * @exampleComponent limel-example-custom-component-header-form
              * @exampleComponent limel-example-props-factory-form
              * @exampleComponent limel-example-form-layout
              * @exampleComponent limel-example-form-span-fields

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "40.17.1",
+  "version": "40.18.1",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",