@limetech/lime-elements 37.6.0 → 37.7.1

package/dist/types/components/icon/get-icon-props.d.ts

@@ -1,4 +1,4 @@
-import { Icon } from '../../interface';
+import { Icon } from '../../global/shared-types/icon.types';
 /**
  * Get the icon name.
  * This helps in setting the right icon, both if the consumer only types `icon: string`,

package/dist/types/components/list/list-item.types.d.ts

@@ -1,5 +1,7 @@
+import { ListSeparator } from '../../global/shared-types/separator.types';
 import { Icon } from '../../global/shared-types/icon.types';
 import { MenuItem } from '../menu/menu.types';
+export { ListSeparator };
 /**
  * List item.
  * @public
@@ -52,22 +54,6 @@ export interface ListItem<T = any> {
    */
   primaryComponent?: ListComponent;
 }
-/**
- * Indicates that a separator should be rendered in the list.
- * @public
- */
-export interface ListSeparator {
-  /**
-   * Indicates that a separator should be rendered in the list.
-   */
-  separator: true;
-  /**
-   * Text to display in the separator.
-   * This can be used as a label for the section of the list following the separator.
-   * If not specified, the separator will be rendered without a label.
-   */
-  text?: string;
-}
 /**
  * Component used to render a list item.
  * @public

package/dist/types/components/list/list-renderer.d.ts

@@ -1,4 +1,5 @@
-import { ListItem, ListSeparator } from '../list/list-item.types';
+import { ListItem } from './list-item.types';
+import { ListSeparator } from '../../global/shared-types/separator.types';
 import { ListRendererConfig } from './list-renderer-config';
 export declare class ListRenderer {
   private defaultConfig;

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

@@ -1,5 +1,5 @@
+import { ListSeparator } from '../../global/shared-types/separator.types';
 import { Icon } from '../../global/shared-types/icon.types';
-import { ListSeparator } from '../list/list-item.types';
 /**
  * The direction in which the menu should open.
  * - `left-start`: Menu opens to the left, aligned with the start of the trigger.

package/dist/types/components/menu-list/menu-list.types.d.ts

@@ -3,9 +3,8 @@
  * Available types are:
  * `menu`: regular vertical menu.
  *
- * @internal
  * @deprecated This type is no longer used.
- * @private
+ * @public
  */
 export type MenuListType = 'menu';
 //# sourceMappingURL=menu-list.types.d.ts.map

package/dist/types/components/select/option.types.d.ts

@@ -1,4 +1,4 @@
-import { Icon } from '../../interface';
+import { Icon } from '../../global/shared-types/icon.types';
 /**
  * Describes an option for limel-select.
  * @public

package/dist/types/components.d.ts

@@ -12,7 +12,8 @@ import { BreadcrumbsItem } from "./components/breadcrumbs/breadcrumbs.types";
 import { Button } from "./components/button/button.types";
 import { CalloutType } from "./components/callout/callout.types";
 import { DateType, Languages } from "./components/date-picker/date.types";
-import { Icon, Languages as Languages1, Link } from "./interface";
+import { Icon } from "./global/shared-types/icon.types";
+import { Link } from "./global/shared-types/link.types";
 import { Chip, ChipType } from "./components/chip-set/chip.types";
 import { CircularProgressSize } from "./components/circular-progress/circular-progress.types";
 import { ColorScheme, Language } from "./components/code-editor/code-editor.types";
@@ -23,9 +24,8 @@ 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";
 import { InputType } from "./components/input-field/input-field.types";
 import { ListType } from "./components/list/list.types";
@@ -45,7 +45,8 @@ export { BreadcrumbsItem } from "./components/breadcrumbs/breadcrumbs.types";
 export { Button } from "./components/button/button.types";
 export { CalloutType } from "./components/callout/callout.types";
 export { DateType, Languages } from "./components/date-picker/date.types";
-export { Icon, Languages as Languages1, Link } from "./interface";
+export { Icon } from "./global/shared-types/icon.types";
+export { Link } from "./global/shared-types/link.types";
 export { Chip, ChipType } from "./components/chip-set/chip.types";
 export { CircularProgressSize } from "./components/circular-progress/circular-progress.types";
 export { ColorScheme, Language } from "./components/code-editor/code-editor.types";
@@ -56,9 +57,8 @@ 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";
 export { InputType } from "./components/input-field/input-field.types";
 export { ListType } from "./components/list/list.types";
@@ -443,7 +443,7 @@ export namespace Components {
         /**
           * Defines the language for translations. Will translate the translatable strings on the components.
          */
-        "language": Languages1;
+        "language": Languages;
         /**
           * If supplied, the chip will become a clickable link.
          */
@@ -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
          */
@@ -1406,7 +1403,7 @@ export namespace Components {
         /**
           * If supplied, the info tile will be a clickable link.  Supplying a value also adds an elevated effect using a shadow, as well as `cursor: pointer`, which appears on hover. While we strongly recommend supplying a link whenever the component should act as a link, if this is not possible, and you need to provide interaction through a click handler, you can still get the correct styling by supplying a `Link` object with the `href` property set to `'#'`.
          */
-        "link"?: Link1;
+        "link"?: Link;
         /**
           * Set to `true` to put the component in the `loading` state. This does _not_ disable the link. To do so, the `disabled` property should be set to `true` as well.
          */
@@ -2040,7 +2037,7 @@ export namespace Components {
         /**
           * If supplied, the shortcut will be a clickable link.
          */
-        "link"?: Link1;
+        "link"?: Link;
     }
     /**
      * @exampleComponent limel-example-slider-basic
@@ -4276,7 +4273,7 @@ declare namespace LocalJSX {
         /**
           * Defines the language for translations. Will translate the translatable strings on the components.
          */
-        "language"?: Languages1;
+        "language"?: Languages;
         /**
           * If supplied, the chip will become a clickable link.
          */
@@ -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
          */
@@ -5335,7 +5329,7 @@ declare namespace LocalJSX {
         /**
           * If supplied, the info tile will be a clickable link.  Supplying a value also adds an elevated effect using a shadow, as well as `cursor: pointer`, which appears on hover. While we strongly recommend supplying a link whenever the component should act as a link, if this is not possible, and you need to provide interaction through a click handler, you can still get the correct styling by supplying a `Link` object with the `href` property set to `'#'`.
          */
-        "link"?: Link1;
+        "link"?: Link;
         /**
           * Set to `true` to put the component in the `loading` state. This does _not_ disable the link. To do so, the `disabled` property should be set to `true` as well.
          */
@@ -6025,7 +6019,7 @@ declare namespace LocalJSX {
         /**
           * If supplied, the shortcut will be a clickable link.
          */
-        "link"?: Link1;
+        "link"?: Link;
     }
     /**
      * @exampleComponent limel-example-slider-basic

package/dist/types/global/shared-types/separator.types.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Indicates that a separator should be rendered.
+ * Used in lists and menus to separate items into sections.
+ * @public
+ */
+export interface ListSeparator {
+  /**
+   * Indicates that a separator should be rendered.
+   */
+  separator: true;
+  /**
+   * Text to display in the separator.
+   * This can be used as a label for the section following the separator.
+   * If not specified, the separator will be rendered without a label.
+   */
+  text?: string;
+}
+//# sourceMappingURL=separator.types.d.ts.map

package/dist/types/interface.d.ts

@@ -16,7 +16,7 @@ export * from './components/help/help.types';
 export * from './components/icon/icon.types';
 export * from './components/info-tile/info-tile.types';
 export * from './components/input-field/input-field.types';
-export { ListComponent, ListSeparator, } from './components/list/list-item.types';
+export { ListComponent } from './components/list/list-item.types';
 export * from './components/list/list.types';
 export * from './components/menu/menu.types';
 export * from './components/menu-list/menu-list.types';
@@ -27,6 +27,5 @@ export * from './components/select/option.types';
 export * from './components/spinner/spinner.types';
 export * from './components/tab-panel/tab-panel.types';
 export * from './components/table/table.types';
-export * from './global/shared-types/link.types';
-export * from './global/shared-types/icon.types';
+export * from './global/shared-types/separator.types';
 //# sourceMappingURL=interface.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "37.6.0",
+  "version": "37.7.1",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -16,7 +16,7 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "api:update": "npm run build && ./api-update.sh",
+    "api:update": "npm run build && api-extractor run --local --verbose",
     "api:verify": "api-extractor run",
     "build": "cross-env-shell NODE_ENV=prod SASS_PATH=node_modules \"stencil build --config stencil.config.dist.ts\"",
     "dev": "cross-env-shell SASS_PATH=node_modules \"stencil build --dev --docs\"",
@@ -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.42.3",
     "@popperjs/core": "^2.11.8",
     "@rjsf/core": "^2.4.2",
     "@rollup/plugin-node-resolve": "^13.3.0",
@@ -54,11 +54,11 @@
     "@types/html-escaper": "^3.0.2",
     "@types/jest": "^27.4.0",
     "@types/lodash-es": "^4.17.12",
-    "@types/react": "^18.2.60",
+    "@types/react": "^18.2.62",
     "@types/react-dom": "^18.2.19",
     "@types/tabulator-tables": "^4.9.4",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
     "awesome-debounce-promise": "^2.1.0",
     "codemirror": "^5.65.9",
     "cross-env": "^7.0.3",
@@ -68,7 +68,7 @@
     "eslint-plugin-ban": "^1.6.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react": "^7.34.0",
     "eslint-plugin-sonarjs": "^0.24.0",
     "eslint-plugin-tsdoc": "^0.2.17",
     "flatpickr": "^4.6.13",

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"}