@limetech/lime-elements 37.6.0 → 37.7.0

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

@@ -1,5 +1,5 @@
 import { EventEmitter } from '../../stencil-public-runtime';
-import { FormError, ValidationError, ValidationStatus } from './form.types';
+import { FormError, FormSchema, ValidationError, ValidationStatus } from './form.types';
 /**
  * @exampleComponent limel-example-form
  * @exampleComponent limel-example-nested-form
@@ -18,10 +18,7 @@ export declare class Form {
   /**
    * The schema used to render the form
    */
-  schema: {
-    id?: string;
-    [key: string]: any;
-  };
+  schema: FormSchema;
   /**
    * Value of the form
    */
@@ -39,7 +36,7 @@ export declare class Form {
    * factory must return an object where each key is the name of the property
    * that should be set, along with its value.
    */
-  propsFactory?: (schema: Record<string, any>) => Record<string, any>;
+  propsFactory?: (schema: FormSchema) => Record<string, any>;
   /**
    * Custom function to customize the default error messages
    */

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

@@ -1,5 +1,21 @@
+import { JSONSchema7 } from 'json-schema';
 import { Help } from '../help/help.types';
 import { EventEmitter } from '../../stencil-public-runtime';
+declare module 'json-schema' {
+  interface JSONSchema7 {
+    /**
+     * @internal
+     * Unique identifier for the schema
+     */
+    id?: string;
+    /**
+     * Lime elements specific options that can be specified in a schema
+     */
+    lime?: Omit<LimeSchemaOptions, 'layout'> & {
+      layout?: Partial<LimeLayoutOptions>;
+    };
+  }
+}
 /**
  * @public
  */
@@ -93,11 +109,11 @@ export interface FormInfo {
   /**
    * The schema of the current property
    */
-  schema?: object;
+  schema?: FormSchema;
   /**
    * The schema of the whole form
    */
-  rootSchema?: object;
+  rootSchema?: FormSchema;
   /**
    * A tree of errors for this property and its children
    */
@@ -151,13 +167,18 @@ export interface LimeSchemaOptions {
    * When specified on an object it will render the sub components with the
    * specified layout
    */
-  layout?: FormLayoutOptions<any>;
+  layout?: LimeLayoutOptions;
   /**
    * Mark the field as disabled
    */
   disabled?: boolean;
-  help?: string | Help;
+  help?: string | Partial<Help>;
 }
+/**
+ * @public
+ * Options for a layout to be used in a form
+ */
+export type LimeLayoutOptions = GridLayoutOptions & RowLayoutOptions;
 /**
  * Options for a component to be rendered inside a form
  *
@@ -177,7 +198,7 @@ export interface FormComponentOptions {
 /**
  * @public
  */
-export interface FormLayoutOptions<T = FormLayoutType.Default> {
+export interface FormLayoutOptions<T extends FormLayoutType | `${FormLayoutType}` = FormLayoutType.Default> {
   /**
    * The type of layout to use
    */
@@ -185,8 +206,9 @@ export interface FormLayoutOptions<T = FormLayoutType.Default> {
 }
 /**
  * @public
+ * Layout options for a grid layout
  */
-export interface GridLayoutOptions extends FormLayoutOptions<FormLayoutType.Grid> {
+export interface GridLayoutOptions extends FormLayoutOptions<FormLayoutType | `${FormLayoutType}`> {
   /**
    * When specified on a component within the grid, the component will take
    * up the the specified number of columns in the form
@@ -210,8 +232,9 @@ export interface GridLayoutOptions extends FormLayoutOptions<FormLayoutType.Grid
 }
 /**
  * @public
+ * Layout options for a row layout
  */
-export interface RowLayoutOptions extends FormLayoutOptions<FormLayoutType.Row> {
+export interface RowLayoutOptions extends FormLayoutOptions<FormLayoutType | `${FormLayoutType}`> {
   /**
    * When specified on a field, the chosen icon will be displayed
    * on the left side of the row, beside the title.
@@ -220,6 +243,7 @@ export interface RowLayoutOptions extends FormLayoutOptions<FormLayoutType.Row>
 }
 /**
  * @public
+ * Represents the layout types for a form.
  */
 export declare enum FormLayoutType {
   /**
@@ -239,4 +263,10 @@ export declare enum FormLayoutType {
    */
   Row = "row"
 }
+/**
+ * @public
+ * Represents the JSON schema with Lime specific options
+ */
+export interface FormSchema extends JSONSchema7 {
+}
 //# sourceMappingURL=form.types.d.ts.map

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

@@ -1,7 +1,7 @@
 import React from 'react';
 import { LimeElementsAdapter } from '../adapters/base-adapter';
-import { LimeJSONSchema } from '../internal.types';
-export declare function getHelpComponent(schema: LimeJSONSchema): React.ReactElement<{
+import { FormSchema } from '../form.types';
+export declare function getHelpComponent(schema: FormSchema): React.ReactElement<{
   value: string;
 }, string | React.JSXElementConstructor<any>> | React.CElement<{
   name: string;

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

@@ -1,11 +1,11 @@
 import { ObjectFieldTemplateProps, ArrayFieldTemplateProps } from '@rjsf/core';
-import { LimeJSONSchema } from '../internal.types';
+import { FormSchema } from '../form.types';
 export { FieldTemplateProps, ArrayFieldTemplateProps } from '@rjsf/core';
 export type TemplateProps = ObjectFieldTemplateProps | ArrayFieldTemplateProps;
 export type ObjectFieldProperty = ObjectFieldTemplateProps['properties'][0];
 export type ArrayFieldItem = ArrayFieldTemplateProps['items'][0];
 export interface LimeObjectFieldTemplateProps extends ObjectFieldTemplateProps {
-  schema: LimeJSONSchema;
+  schema: FormSchema;
 }
 export interface Runnable {
   run: (event: any) => void;

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

@@ -1,6 +1,6 @@
 import { WidgetProps as RjsfWidgetProps } from '@rjsf/core';
-import { LimeJSONSchema } from '../internal.types';
+import { FormSchema } from '../form.types';
 export interface WidgetProps extends RjsfWidgetProps {
-  schema: LimeJSONSchema;
+  schema: FormSchema;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/types/components.d.ts

@@ -23,7 +23,7 @@ import { DockItem } from "./components/dock/dock.types";
 import { FileInfo } from "./components/file/file.types";
 import { OfficeViewer } from "./components/file-viewer/file-viewer.types";
 import { FlexContainerAlign, FlexContainerDirection, FlexContainerJustify } from "./components/flex-container/flex-container.types";
-import { FormError, ValidationError, ValidationStatus } from "./components/form/form.types";
+import { FormError, FormSchema, ValidationError, ValidationStatus } from "./components/form/form.types";
 import { IconSize } from "./components/icon/icon.types";
 import { Link as Link1 } from "./global/shared-types/link.types";
 import { InfoTileProgress } from "./components/info-tile/info-tile.types";
@@ -56,7 +56,7 @@ export { DockItem } from "./components/dock/dock.types";
 export { FileInfo } from "./components/file/file.types";
 export { OfficeViewer } from "./components/file-viewer/file-viewer.types";
 export { FlexContainerAlign, FlexContainerDirection, FlexContainerJustify } from "./components/flex-container/flex-container.types";
-export { FormError, ValidationError, ValidationStatus } from "./components/form/form.types";
+export { FormError, FormSchema, ValidationError, ValidationStatus } from "./components/form/form.types";
 export { IconSize } from "./components/icon/icon.types";
 export { Link as Link1 } from "./global/shared-types/link.types";
 export { InfoTileProgress } from "./components/info-tile/info-tile.types";
@@ -1138,14 +1138,11 @@ export namespace Components {
         /**
           * 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.
          */
-        "propsFactory"?: (schema: Record<string, any>) => Record<string, any>;
+        "propsFactory"?: (schema: FormSchema) => Record<string, any>;
         /**
           * The schema used to render the form
          */
-        "schema": {
-        id?: string;
-        [key: string]: any;
-    };
+        "schema": FormSchema;
         /**
           * Custom function to customize the default error messages
          */
@@ -5067,14 +5064,11 @@ declare namespace LocalJSX {
         /**
           * 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.
          */
-        "propsFactory"?: (schema: Record<string, any>) => Record<string, any>;
+        "propsFactory"?: (schema: FormSchema) => Record<string, any>;
         /**
           * The schema used to render the form
          */
-        "schema"?: {
-        id?: string;
-        [key: string]: any;
-    };
+        "schema"?: FormSchema;
         /**
           * Custom function to customize the default error messages
          */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "37.6.0",
+  "version": "37.7.0",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -43,8 +43,8 @@
     "generate": "stencil generate"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^19.0.0",
-    "@microsoft/api-extractor": "^7.41.0",
+    "@commitlint/config-conventional": "^19.0.3",
+    "@microsoft/api-extractor": "^7.41.1",
     "@popperjs/core": "^2.11.8",
     "@rjsf/core": "^2.4.2",
     "@rollup/plugin-node-resolve": "^13.3.0",

package/dist/cjs/form.types-e76a78e1.js

@@ -1,26 +0,0 @@
-'use strict';
-
-/**
- * @public
- */
-exports.FormLayoutType = void 0;
-(function (FormLayoutType) {
-  /**
-   * The default layout
-   */
-  FormLayoutType["Default"] = "default";
-  /**
-   * Render the form fields using a responsive grid layout
-   */
-  FormLayoutType["Grid"] = "grid";
-  /**
-   * Render the form fields in full-width rows.
-   * Each row can have a leading `icon`, and a field.
-   * `title` and `description` provided by the schema will be placed
-   * on the row itself, and not on the field.
-   * This layout is good for creating UIs for user settings pages.
-   */
-  FormLayoutType["Row"] = "row";
-})(exports.FormLayoutType || (exports.FormLayoutType = {}));
-
-//# sourceMappingURL=form.types-e76a78e1.js.map

package/dist/cjs/form.types-e76a78e1.js.map

@@ -1 +0,0 @@
-{"file":"form.types-e76a78e1.js","mappings":";;AAqQA;;;AAGYA;AAAZ,WAAY,cAAc;;;;EAItB,qCAAmB,CAAA;;;;EAKnB,+BAAa,CAAA;;;;;;;;EASb,6BAAW,CAAA;AACf,CAAC,EAnBWA,sBAAc,KAAdA,sBAAc;;","names":["FormLayoutType"],"sources":["./src/components/form/form.types.ts"],"sourcesContent":["import { Help } from '../help/help.types';\nimport { EventEmitter } from '@stencil/core';\n\n/**\n * @public\n */\nexport interface ValidationStatus {\n    /**\n     * True if the form is valid, false otherwise\n     *\n     * If the form is invalid, any errors can be found on the `errors` property\n     */\n    valid: boolean;\n\n    /**\n     * List of validation errors\n     */\n    errors?: FormError[];\n}\n\n/**\n * @public\n */\nexport interface FormError {\n    /**\n     * Name of the error\n     */\n    name: string;\n\n    /**\n     * Params of the error\n     */\n    params?: unknown;\n\n    /**\n     * Name of the invalid property\n     */\n    property: string;\n\n    /**\n     * Path to the property within the schema\n     */\n    schemaPath: string;\n\n    /**\n     * String describing the error\n     */\n    message: string;\n}\n\n/**\n * @public\n */\nexport type ValidationError = {\n    /**\n     * Name of the field the error belongs to\n     */\n    [key: string]: string[] | ValidationError;\n};\n\n/**\n * @public\n */\nexport interface FormComponent<T = any> {\n    /**\n     * The value of the current property\n     */\n    value: T;\n\n    /**\n     * Whether or not the current property is required\n     */\n    required?: boolean;\n\n    /**\n     * Whether or not the current property is readonly\n     */\n    readonly?: boolean;\n\n    /**\n     * Whether or not the current property is disabled\n     */\n    disabled?: boolean;\n\n    /**\n     * The label of the current property\n     */\n    label?: string;\n\n    /**\n     * The helper text for the current property\n     */\n    helperText?: string;\n\n    /**\n     * Additional contextual information about the form\n     */\n    formInfo?: FormInfo;\n\n    /**\n     * The event to emit when the value of the current property has changed\n     */\n    change: EventEmitter<T>;\n}\n\n/**\n * @public\n */\nexport interface FormInfo {\n    /**\n     * The schema of the current property\n     */\n    schema?: object;\n\n    /**\n     * The schema of the whole form\n     */\n    rootSchema?: object;\n\n    /**\n     * A tree of errors for this property and its children\n     */\n    errorSchema?: object;\n\n    /**\n     * The value of the whole form\n     */\n    rootValue?: any;\n\n    /**\n     * The name of the current property\n     */\n    name?: string;\n\n    /**\n     * Path to the property within the schema\n     */\n    schemaPath?: string[];\n}\n\n/**\n * Lime elements specific options that can be specified under the `lime` key in\n * a schema, e.g.\n *\n * ```ts\n * const schema = {\n *     type: 'object',\n *     lime: {\n *         collapsible: true,\n *     },\n * };\n * ```\n *\n * @public\n */\nexport interface LimeSchemaOptions {\n    /**\n     * When specified on an object it will render all sub components inside a\n     * collapsible section\n     */\n    collapsible?: boolean;\n\n    /**\n     * When `collapsible` is `true`, set this to `false` to make the\n     * collapsible section load in the open state.\n     * Defaults to `true`.\n     */\n    collapsed?: boolean;\n\n    /**\n     * Will render the field using the specified component. The component\n     * should implement the `FormComponent` interface\n     */\n    component?: FormComponentOptions;\n\n    /**\n     * When specified on an object it will render the sub components with the\n     * specified layout\n     */\n    layout?: FormLayoutOptions<any>;\n\n    /**\n     * Mark the field as disabled\n     */\n    disabled?: boolean;\n\n    help?: string | Help;\n}\n\n/**\n * Options for a component to be rendered inside a form\n *\n * @public\n */\nexport interface FormComponentOptions {\n    /**\n     * Name of the component\n     */\n    name?: string;\n\n    /**\n     * Extra properties to give the component in addition to the properties\n     * specified on the `FormComponent` interface\n     */\n    props?: Record<string, any>;\n}\n\n/**\n * @public\n */\nexport interface FormLayoutOptions<T = FormLayoutType.Default> {\n    /**\n     * The type of layout to use\n     */\n    type: T;\n}\n\n/**\n * @public\n */\nexport interface GridLayoutOptions\n    extends FormLayoutOptions<FormLayoutType.Grid> {\n    /**\n     * When specified on a component within the grid, the component will take\n     * up the the specified number of columns in the form\n     */\n    // eslint-disable-next-line no-magic-numbers\n    colSpan?: 1 | 2 | 3 | 4 | 5 | 'all';\n\n    /**\n     * When specified on a component within the grid, the component will take\n     * up the the specified number of rows in the form\n     */\n    rowSpan?: number;\n\n    /**\n     * Number of columns to use in the layout\n     */\n    // eslint-disable-next-line no-magic-numbers\n    columns?: 1 | 2 | 3 | 4 | 5;\n\n    /**\n     * Attempts to fill in holes earlier in the grid, if smaller items come up\n     * later. This may cause items to appear out-of-order, when doing so would\n     * fill holes left by larger items. Defaults to `true`.\n     */\n    dense?: boolean;\n}\n\n/**\n * @public\n */\nexport interface RowLayoutOptions\n    extends FormLayoutOptions<FormLayoutType.Row> {\n    /**\n     * When specified on a field, the chosen icon will be displayed\n     * on the left side of the row, beside the title.\n     */\n    icon?: string;\n}\n\n/**\n * @public\n */\nexport enum FormLayoutType {\n    /**\n     * The default layout\n     */\n    Default = 'default',\n\n    /**\n     * Render the form fields using a responsive grid layout\n     */\n    Grid = 'grid',\n\n    /**\n     * Render the form fields in full-width rows.\n     * Each row can have a leading `icon`, and a field.\n     * `title` and `description` provided by the schema will be placed\n     * on the row itself, and not on the field.\n     * This layout is good for creating UIs for user settings pages.\n     */\n    Row = 'row',\n}\n"],"version":3}

package/dist/collection/components/form/internal.types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=internal.types.js.map

package/dist/collection/components/form/internal.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"internal.types.js","sourceRoot":"","sources":["../../../src/components/form/internal.types.ts"],"names":[],"mappings":"","sourcesContent":["import { JSONSchema7 } from 'json-schema';\nimport { LimeSchemaOptions } from './form.types';\n\nexport interface LimeJSONSchema extends JSONSchema7 {\n    lime?: LimeSchemaOptions;\n}\n"]}

package/dist/esm/form.types-e39f98a4.js

@@ -1,26 +0,0 @@
-/**
- * @public
- */
-var FormLayoutType;
-(function (FormLayoutType) {
-  /**
-   * The default layout
-   */
-  FormLayoutType["Default"] = "default";
-  /**
-   * Render the form fields using a responsive grid layout
-   */
-  FormLayoutType["Grid"] = "grid";
-  /**
-   * Render the form fields in full-width rows.
-   * Each row can have a leading `icon`, and a field.
-   * `title` and `description` provided by the schema will be placed
-   * on the row itself, and not on the field.
-   * This layout is good for creating UIs for user settings pages.
-   */
-  FormLayoutType["Row"] = "row";
-})(FormLayoutType || (FormLayoutType = {}));
-
-export { FormLayoutType as F };
-
-//# sourceMappingURL=form.types-e39f98a4.js.map

package/dist/esm/form.types-e39f98a4.js.map

@@ -1 +0,0 @@
-{"file":"form.types-e39f98a4.js","mappings":"AAqQA;;;IAGY;AAAZ,WAAY,cAAc;;;;EAItB,qCAAmB,CAAA;;;;EAKnB,+BAAa,CAAA;;;;;;;;EASb,6BAAW,CAAA;AACf,CAAC,EAnBW,cAAc,KAAd,cAAc;;;;","names":[],"sources":["./src/components/form/form.types.ts"],"sourcesContent":["import { Help } from '../help/help.types';\nimport { EventEmitter } from '@stencil/core';\n\n/**\n * @public\n */\nexport interface ValidationStatus {\n    /**\n     * True if the form is valid, false otherwise\n     *\n     * If the form is invalid, any errors can be found on the `errors` property\n     */\n    valid: boolean;\n\n    /**\n     * List of validation errors\n     */\n    errors?: FormError[];\n}\n\n/**\n * @public\n */\nexport interface FormError {\n    /**\n     * Name of the error\n     */\n    name: string;\n\n    /**\n     * Params of the error\n     */\n    params?: unknown;\n\n    /**\n     * Name of the invalid property\n     */\n    property: string;\n\n    /**\n     * Path to the property within the schema\n     */\n    schemaPath: string;\n\n    /**\n     * String describing the error\n     */\n    message: string;\n}\n\n/**\n * @public\n */\nexport type ValidationError = {\n    /**\n     * Name of the field the error belongs to\n     */\n    [key: string]: string[] | ValidationError;\n};\n\n/**\n * @public\n */\nexport interface FormComponent<T = any> {\n    /**\n     * The value of the current property\n     */\n    value: T;\n\n    /**\n     * Whether or not the current property is required\n     */\n    required?: boolean;\n\n    /**\n     * Whether or not the current property is readonly\n     */\n    readonly?: boolean;\n\n    /**\n     * Whether or not the current property is disabled\n     */\n    disabled?: boolean;\n\n    /**\n     * The label of the current property\n     */\n    label?: string;\n\n    /**\n     * The helper text for the current property\n     */\n    helperText?: string;\n\n    /**\n     * Additional contextual information about the form\n     */\n    formInfo?: FormInfo;\n\n    /**\n     * The event to emit when the value of the current property has changed\n     */\n    change: EventEmitter<T>;\n}\n\n/**\n * @public\n */\nexport interface FormInfo {\n    /**\n     * The schema of the current property\n     */\n    schema?: object;\n\n    /**\n     * The schema of the whole form\n     */\n    rootSchema?: object;\n\n    /**\n     * A tree of errors for this property and its children\n     */\n    errorSchema?: object;\n\n    /**\n     * The value of the whole form\n     */\n    rootValue?: any;\n\n    /**\n     * The name of the current property\n     */\n    name?: string;\n\n    /**\n     * Path to the property within the schema\n     */\n    schemaPath?: string[];\n}\n\n/**\n * Lime elements specific options that can be specified under the `lime` key in\n * a schema, e.g.\n *\n * ```ts\n * const schema = {\n *     type: 'object',\n *     lime: {\n *         collapsible: true,\n *     },\n * };\n * ```\n *\n * @public\n */\nexport interface LimeSchemaOptions {\n    /**\n     * When specified on an object it will render all sub components inside a\n     * collapsible section\n     */\n    collapsible?: boolean;\n\n    /**\n     * When `collapsible` is `true`, set this to `false` to make the\n     * collapsible section load in the open state.\n     * Defaults to `true`.\n     */\n    collapsed?: boolean;\n\n    /**\n     * Will render the field using the specified component. The component\n     * should implement the `FormComponent` interface\n     */\n    component?: FormComponentOptions;\n\n    /**\n     * When specified on an object it will render the sub components with the\n     * specified layout\n     */\n    layout?: FormLayoutOptions<any>;\n\n    /**\n     * Mark the field as disabled\n     */\n    disabled?: boolean;\n\n    help?: string | Help;\n}\n\n/**\n * Options for a component to be rendered inside a form\n *\n * @public\n */\nexport interface FormComponentOptions {\n    /**\n     * Name of the component\n     */\n    name?: string;\n\n    /**\n     * Extra properties to give the component in addition to the properties\n     * specified on the `FormComponent` interface\n     */\n    props?: Record<string, any>;\n}\n\n/**\n * @public\n */\nexport interface FormLayoutOptions<T = FormLayoutType.Default> {\n    /**\n     * The type of layout to use\n     */\n    type: T;\n}\n\n/**\n * @public\n */\nexport interface GridLayoutOptions\n    extends FormLayoutOptions<FormLayoutType.Grid> {\n    /**\n     * When specified on a component within the grid, the component will take\n     * up the the specified number of columns in the form\n     */\n    // eslint-disable-next-line no-magic-numbers\n    colSpan?: 1 | 2 | 3 | 4 | 5 | 'all';\n\n    /**\n     * When specified on a component within the grid, the component will take\n     * up the the specified number of rows in the form\n     */\n    rowSpan?: number;\n\n    /**\n     * Number of columns to use in the layout\n     */\n    // eslint-disable-next-line no-magic-numbers\n    columns?: 1 | 2 | 3 | 4 | 5;\n\n    /**\n     * Attempts to fill in holes earlier in the grid, if smaller items come up\n     * later. This may cause items to appear out-of-order, when doing so would\n     * fill holes left by larger items. Defaults to `true`.\n     */\n    dense?: boolean;\n}\n\n/**\n * @public\n */\nexport interface RowLayoutOptions\n    extends FormLayoutOptions<FormLayoutType.Row> {\n    /**\n     * When specified on a field, the chosen icon will be displayed\n     * on the left side of the row, beside the title.\n     */\n    icon?: string;\n}\n\n/**\n * @public\n */\nexport enum FormLayoutType {\n    /**\n     * The default layout\n     */\n    Default = 'default',\n\n    /**\n     * Render the form fields using a responsive grid layout\n     */\n    Grid = 'grid',\n\n    /**\n     * Render the form fields in full-width rows.\n     * Each row can have a leading `icon`, and a field.\n     * `title` and `description` provided by the schema will be placed\n     * on the row itself, and not on the field.\n     * This layout is good for creating UIs for user settings pages.\n     */\n    Row = 'row',\n}\n"],"version":3}

package/dist/lime-elements/p-067efbaf.js

@@ -1,2 +0,0 @@
-var r;(function(r){r["Default"]="default";r["Grid"]="grid";r["Row"]="row"})(r||(r={}));export{r as F};
-//# sourceMappingURL=p-067efbaf.js.map

package/dist/lime-elements/p-067efbaf.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["FormLayoutType"],"sources":["./src/components/form/form.types.ts"],"sourcesContent":["import { Help } from '../help/help.types';\nimport { EventEmitter } from '@stencil/core';\n\n/**\n * @public\n */\nexport interface ValidationStatus {\n    /**\n     * True if the form is valid, false otherwise\n     *\n     * If the form is invalid, any errors can be found on the `errors` property\n     */\n    valid: boolean;\n\n    /**\n     * List of validation errors\n     */\n    errors?: FormError[];\n}\n\n/**\n * @public\n */\nexport interface FormError {\n    /**\n     * Name of the error\n     */\n    name: string;\n\n    /**\n     * Params of the error\n     */\n    params?: unknown;\n\n    /**\n     * Name of the invalid property\n     */\n    property: string;\n\n    /**\n     * Path to the property within the schema\n     */\n    schemaPath: string;\n\n    /**\n     * String describing the error\n     */\n    message: string;\n}\n\n/**\n * @public\n */\nexport type ValidationError = {\n    /**\n     * Name of the field the error belongs to\n     */\n    [key: string]: string[] | ValidationError;\n};\n\n/**\n * @public\n */\nexport interface FormComponent<T = any> {\n    /**\n     * The value of the current property\n     */\n    value: T;\n\n    /**\n     * Whether or not the current property is required\n     */\n    required?: boolean;\n\n    /**\n     * Whether or not the current property is readonly\n     */\n    readonly?: boolean;\n\n    /**\n     * Whether or not the current property is disabled\n     */\n    disabled?: boolean;\n\n    /**\n     * The label of the current property\n     */\n    label?: string;\n\n    /**\n     * The helper text for the current property\n     */\n    helperText?: string;\n\n    /**\n     * Additional contextual information about the form\n     */\n    formInfo?: FormInfo;\n\n    /**\n     * The event to emit when the value of the current property has changed\n     */\n    change: EventEmitter<T>;\n}\n\n/**\n * @public\n */\nexport interface FormInfo {\n    /**\n     * The schema of the current property\n     */\n    schema?: object;\n\n    /**\n     * The schema of the whole form\n     */\n    rootSchema?: object;\n\n    /**\n     * A tree of errors for this property and its children\n     */\n    errorSchema?: object;\n\n    /**\n     * The value of the whole form\n     */\n    rootValue?: any;\n\n    /**\n     * The name of the current property\n     */\n    name?: string;\n\n    /**\n     * Path to the property within the schema\n     */\n    schemaPath?: string[];\n}\n\n/**\n * Lime elements specific options that can be specified under the `lime` key in\n * a schema, e.g.\n *\n * ```ts\n * const schema = {\n *     type: 'object',\n *     lime: {\n *         collapsible: true,\n *     },\n * };\n * ```\n *\n * @public\n */\nexport interface LimeSchemaOptions {\n    /**\n     * When specified on an object it will render all sub components inside a\n     * collapsible section\n     */\n    collapsible?: boolean;\n\n    /**\n     * When `collapsible` is `true`, set this to `false` to make the\n     * collapsible section load in the open state.\n     * Defaults to `true`.\n     */\n    collapsed?: boolean;\n\n    /**\n     * Will render the field using the specified component. The component\n     * should implement the `FormComponent` interface\n     */\n    component?: FormComponentOptions;\n\n    /**\n     * When specified on an object it will render the sub components with the\n     * specified layout\n     */\n    layout?: FormLayoutOptions<any>;\n\n    /**\n     * Mark the field as disabled\n     */\n    disabled?: boolean;\n\n    help?: string | Help;\n}\n\n/**\n * Options for a component to be rendered inside a form\n *\n * @public\n */\nexport interface FormComponentOptions {\n    /**\n     * Name of the component\n     */\n    name?: string;\n\n    /**\n     * Extra properties to give the component in addition to the properties\n     * specified on the `FormComponent` interface\n     */\n    props?: Record<string, any>;\n}\n\n/**\n * @public\n */\nexport interface FormLayoutOptions<T = FormLayoutType.Default> {\n    /**\n     * The type of layout to use\n     */\n    type: T;\n}\n\n/**\n * @public\n */\nexport interface GridLayoutOptions\n    extends FormLayoutOptions<FormLayoutType.Grid> {\n    /**\n     * When specified on a component within the grid, the component will take\n     * up the the specified number of columns in the form\n     */\n    // eslint-disable-next-line no-magic-numbers\n    colSpan?: 1 | 2 | 3 | 4 | 5 | 'all';\n\n    /**\n     * When specified on a component within the grid, the component will take\n     * up the the specified number of rows in the form\n     */\n    rowSpan?: number;\n\n    /**\n     * Number of columns to use in the layout\n     */\n    // eslint-disable-next-line no-magic-numbers\n    columns?: 1 | 2 | 3 | 4 | 5;\n\n    /**\n     * Attempts to fill in holes earlier in the grid, if smaller items come up\n     * later. This may cause items to appear out-of-order, when doing so would\n     * fill holes left by larger items. Defaults to `true`.\n     */\n    dense?: boolean;\n}\n\n/**\n * @public\n */\nexport interface RowLayoutOptions\n    extends FormLayoutOptions<FormLayoutType.Row> {\n    /**\n     * When specified on a field, the chosen icon will be displayed\n     * on the left side of the row, beside the title.\n     */\n    icon?: string;\n}\n\n/**\n * @public\n */\nexport enum FormLayoutType {\n    /**\n     * The default layout\n     */\n    Default = 'default',\n\n    /**\n     * Render the form fields using a responsive grid layout\n     */\n    Grid = 'grid',\n\n    /**\n     * Render the form fields in full-width rows.\n     * Each row can have a leading `icon`, and a field.\n     * `title` and `description` provided by the schema will be placed\n     * on the row itself, and not on the field.\n     * This layout is good for creating UIs for user settings pages.\n     */\n    Row = 'row',\n}\n"],"mappings":"IAwQYA,GAAZ,SAAYA,GAIRA,EAAA,qBAKAA,EAAA,eASAA,EAAA,YACH,EAnBD,CAAYA,MAAc,Y"}