@3t-transform/threeteeui 0.1.36 → 0.1.41

package/dist/types/components/molecules/tttx-form/lib/validityCheck.d.ts

@@ -1,17 +1,17 @@
-/**
- * Validates the input field on focusout event by checking its validity state,
- * sets an error message if there's an issue, and emits a "dataChanged" event to
- * the parent component with the field name and its new value.
- *
- * @param {Event} event - The focusout event triggered by the input field.
- * @return {void}
- */
-declare function validityCheck(event: {
-  target: any;
-  preventDefault: Function;
-}): {
-  target: any;
-  hasError: boolean;
-  errorMessage: string;
-};
-export default validityCheck;
+/**
+ * Validates the input field on focusout event by checking its validity state,
+ * sets an error message if there's an issue, and emits a "dataChanged" event to
+ * the parent component with the field name and its new value.
+ *
+ * @param {Event} event - The focusout event triggered by the input field.
+ * @return {void}
+ */
+declare function validityCheck(event: {
+  target: any;
+  preventDefault: Function;
+}): {
+  target: any;
+  hasError: boolean;
+  errorMessage: string;
+};
+export default validityCheck;

package/dist/types/components/molecules/tttx-form/tttx-form.d.ts

@@ -1,111 +1,133 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
-import { ChangeEvent } from 'react';
-export declare class TttxForm {
-  private fieldset;
-  private submitButton;
-  private template;
-  private _formSchema;
-  private _data;
-  formschema: any;
-  data: any;
-  dataSubmitted: EventEmitter<FormData>;
-  dataChanged: EventEmitter<{
-    name: string;
-    value: any;
-  }>;
-  onFormSchemaChange(newValue: any): void;
-  onDataChange(newValue: any): void;
-  /**
-   * Handles the focus event for a form field and emits a "dataChanged" event
-   * to the parent component with the field name and its new value.
-   *
-   * @param {ChangeEvent} event - The focus event triggered by the field.
-   * @return {void}
-   */
-  fieldChanged(event: ChangeEvent): void;
-  submit(): Promise<void>;
-  /**
-   * Submits the form data to the server.
-   *
-   * @param {SubmitEvent} event - The event object for the form submission.
-   * @returns {void}
-   *
-   * @example
-   * const form = document.getElementById('myForm');
-   * form.addEventListener('submit', (event) => {
-   *   doSubmit(event);
-   * });
-   */
-  doSubmit(event: SubmitEvent): void;
-  componentWillLoad(): void;
-  componentWillRender(): void;
-  /**
-   * Creates a new HTMLInputElement with the specified name, type, and placeholder (if any),
-   * and sets its autocomplete and autocapitalization properties to off.
-   *
-   * @param {string} formKey - The name of the input field, as specified in the form schema.
-   * @param {Object} formProperties - An object containing additional properties for the input field, such as its type and placeholder value.
-   * @param {string} formProperties.type - The type of the input field (e.g., "text", "email", "number", etc.).
-   * @param {string} [formProperties.placeholder] - An optional placeholder value to display in the input field.
-   * @return {HTMLInputElement} - The new input element.
-   */
-  createInput(formKey: any, formProperties: any): HTMLInputElement;
-  /**
-   * Applies validation attributes to an input element based on the specified validation object.
-   * If a certain property is present in the object, it will set the corresponding attribute on
-   * the input element (e.g., "required" will set the "required" and "data-required" attributes,
-   * "pattern" will set the "pattern" and "data-pattern" attributes, etc.).
-   *
-   * @param {HTMLInputElement} input - The input element to apply validation attributes to.
-   * @param {Object} validation - An object containing the validation rules for the input field.
-   * @param {Object} [validation.required] - An object containing a "message" property to display if the field is required.
-   * @param {Object} [validation.pattern] - An object containing a "pattern" property to match against the field value, and a "message" property to display if the pattern doesn't match.
-   * @param {Object} [validation.badInput] - An object containing a "message" property to display if the field value is invalid.
-   * @param {Object} [validation.minmax] - An object containing "min" and "max" properties to validate the field value against, and a "message" property to display if the value is out of range.
-   * @param {string} [validation.maxlength] - The maximum length of the input field.
-   * @return {void}
-   */
-  applyValidation(input: any, validation: any): void;
-  createErrorBubble(): HTMLDivElement;
-  /**
-   * Creates a new <label> element with the "inputBlock" class and the specified label text,
-   * and appends the input element and error bubble element to it. If the form property has
-   * no validation object, it adds an "optional" span element to the label.
-   *
-   * @param {Object} formProperties - An object containing properties for the form field, including its label text and validation rules.
-   * @param {HTMLInputElement} input - The input element to associate with the label.
-   * @param {HTMLDivElement} errorBubble - The error bubble element to display error messages in.
-   * @return {HTMLLabelElement} - The new label element.
-   */
-  createLabel(formProperties: any, input: any, errorBubble: any): HTMLLabelElement;
-  /**
-   * Populates the form template with input fields and labels based on the properties of the
-   * current form schema. For each property in the schema, it creates an input element, applies
-   * any validation rules to it, creates an error bubble and label element, and appends them
-   * to the form template. Finally, it creates and appends a submit button element to the form.
-   *
-   * @return {void}
-   */
-  populateFormFromSchema(): void;
-  /**
-   * Clones the form template and binds event listeners to its input elements. First, it checks if
-   * there is a form schema present. If so, it clones the template's content, binds events to form
-   * input elements, and appends the cloned form elements to the fieldset. The event listeners include
-   * "oninvalid" (to check input validity on submit), "onblur" (to check input validity on blur),
-   * "onkeyup" (to handle changes in input fields), and "onchange" (to handle changes in select fields).
-   *
-   * @return {void}
-   */
-  componentDidRender(): void;
-  validityCheckWrapper(event: any): void;
-  /**
-   * Renders the component's template as a form element with a fieldset container. The form's
-   * "onSubmit" event is bound to the "doSubmit" function, which handles the form submission
-   * and emits a "dataSubmitted" event with the form data. The fieldset element is assigned
-   * to the "fieldset" instance variable using a ref, so it can be populated with form elements
-   * later on.
-   *
-   * @return {JSX.Element} - The rendered form template as a JSX element.
-   */
-  render(): any;
-}
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { ChangeEvent } from 'react';
+export declare class TttxForm {
+  private form;
+  private fieldset;
+  private submitButton;
+  private template;
+  private _formSchema;
+  private _data;
+  formschema: any;
+  data: any;
+  dataSubmitted: EventEmitter<FormData>;
+  dataChanged: EventEmitter<{
+    name: string;
+    value: any;
+  }>;
+  onFormSchemaChange(newValue: any): void;
+  onDataChange(newValue: any): void;
+  /**
+   * Handles the focus event for a form field and emits a "dataChanged" event
+   * to the parent component with the field name and its new value.
+   *
+   * @param {ChangeEvent} event - The focus event triggered by the field.
+   * @return {void}
+   */
+  fieldChanged(event: ChangeEvent): void;
+  submit(): Promise<void>;
+  /**
+   * Submits the form data to the server.
+   *
+   * @param {SubmitEvent} event - The event object for the form submission.
+   * @returns {void}
+   *
+   * @example
+   * const form = document.getElementById('myForm');
+   * form.addEventListener('submit', (event) => {
+   *   doSubmit(event);
+   * });
+   */
+  doSubmit(event: SubmitEvent): void;
+  componentWillLoad(): void;
+  componentWillRender(): void;
+  /**
+   * Creates a new HTMLSelectElement with a set of options.
+   *
+   * @param {string} formKey - The name of the dropdown field, as specified in the form schema.
+   * @param {Object} formProperties - An object containing additional properties, such as the field type and options properties.
+   * @param {'select'} formProperties.type - The type of form field. In this case, it will always be "select".
+   * @param {Object} formProperties.validation - A set of validation rules for the field.
+   * @param {Object[]} formProperties.options - A list of properties to pass to the select options.
+   * @param {string} formProperties.options.label - The visible value of the option.
+   * @param {string} formProperties.options.value - The actual value of the option.
+   */
+  createSelect(formKey: string, formProperties: any): HTMLSelectElement;
+  /**
+   * Appends an option to a select element
+   *
+   * @param {HTMLSelectElement} select - The select elements to attach the option to.
+   * @param {value} value - The value of the option.
+   * @param {label} label - The label which will be displayed on the form for the option.
+   */
+  appendOption(select: any, optionProperties: any): void;
+  /**
+   * Creates a new HTMLInputElement with the specified name, type, and placeholder (if any),
+   * and sets its autocomplete and autocapitalization properties to off.
+   *
+   * @param {string} formKey - The name of the input field, as specified in the form schema.
+   * @param {Object} formProperties - An object containing additional properties for the input field, such as its type and placeholder value.
+   * @param {string} formProperties.type - The type of the input field (e.g., "text", "email", "number", etc.).
+   * @param {string} [formProperties.placeholder] - An optional placeholder value to display in the input field.
+   * @return {HTMLInputElement} - The new input element.
+   */
+  createInput(formKey: any, formProperties: any): HTMLInputElement;
+  /**
+   * Applies validation attributes to an input element based on the specified validation object.
+   * If a certain property is present in the object, it will set the corresponding attribute on
+   * the input element (e.g., "required" will set the "required" and "data-required" attributes,
+   * "pattern" will set the "pattern" and "data-pattern" attributes, etc.).
+   *
+   * @param {HTMLInputElement} input - The input element to apply validation attributes to.
+   * @param {Object} validation - An object containing the validation rules for the input field.
+   * @param {Object} [validation.required] - An object containing a "message" property to display if the field is required.
+   * @param {Object} [validation.pattern] - An object containing a "pattern" property to match against the field value, and a "message" property to display if the pattern doesn't match.
+   * @param {Object} [validation.badInput] - An object containing a "message" property to display if the field value is invalid.
+   * @param {Object} [validation.minmax] - An object containing "min" and "max" properties to validate the field value against, and a "message" property to display if the value is out of range.
+   * @param {string} [validation.maxlength] - The maximum length of the input field.
+   * @return {void}
+   */
+  applyValidation(input: any, validation: any): void;
+  createErrorBubble(): HTMLDivElement;
+  appendCheckboxInput(formProperties: any, input: any, label: any): void;
+  /**
+   * Creates a new <label> element with the "inputBlock" class and the specified label text,
+   * and appends the input element and error bubble element to it. If the form property has
+   * no validation object, it adds an "optional" span element to the label.
+   *
+   * @param {Object} formProperties - An object containing properties for the form field, including its label text and validation rules.
+   * @param {HTMLInputElement} input - The input element to associate with the label.
+   * @param {HTMLDivElement} errorBubble - The error bubble element to display error messages in.
+   * @return {HTMLLabelElement} - The new label element.
+   */
+  createLabel(formProperties: any, input: any, errorBubble: any): HTMLLabelElement;
+  /**
+   * Populates the form template with input fields and labels based on the properties of the
+   * current form schema. For each property in the schema, it creates an input element, applies
+   * any validation rules to it, creates an error bubble and label element, and appends them
+   * to the form template. Finally, it creates and appends a submit button element to the form.
+   *
+   * @return {void}
+   */
+  populateFormFromSchema(): void;
+  /**
+   * Clones the form template and binds event listeners to its input elements. First, it checks if
+   * there is a form schema present. If so, it clones the template's content, binds events to form
+   * input elements, and appends the cloned form elements to the fieldset. The event listeners include
+   * "oninvalid" (to check input validity on submit), "onblur" (to check input validity on blur),
+   * "onkeyup" (to handle changes in input fields), and "onchange" (to handle changes in select fields).
+   *
+   * @return {void}
+   */
+  componentDidRender(): void;
+  validityCheckWrapper(event: any): void;
+  /**
+   * Renders the component's template as a form element with a fieldset container. The form's
+   * "onSubmit" event is bound to the "doSubmit" function, which handles the form submission
+   * and emits a "dataSubmitted" event with the form data. The fieldset element is assigned
+   * to the "fieldset" instance variable using a ref, so it can be populated with form elements
+   * later on.
+   *
+   * @return {JSX.Element} - The rendered form template as a JSX element.
+   */
+  render(): any;
+}

package/dist/types/components/molecules/tttx-form/tttx-form.stories.d.ts

@@ -1,13 +1,278 @@
-declare const _default: {
-  title: string;
-  component: string;
-  parameters: {
-    actions: {
-      handles: string[];
-    };
-  };
-  decorators: import("@storybook/types").Addon_DecoratorFunction<unknown>[];
-};
-export default _default;
-export declare const ExampleFormFromJSON: () => string;
-export declare const PrePopulateForm: () => string;
+declare const _default: {
+  title: string;
+  component: string;
+  parameters: {
+    actions: {
+      handles: string[];
+    };
+  };
+  decorators: import("@storybook/types").Addon_DecoratorFunction<unknown>[];
+};
+export default _default;
+export declare const SingleFormItem: {
+  (args: any): string;
+  args: {
+    formSchema: {
+      properties: {
+        input: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+      };
+    };
+  };
+};
+export declare const ExampleFormFromJSON: {
+  (args: any): string;
+  args: {
+    formSchema: {
+      properties: {
+        title: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+          };
+        };
+        forename: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+        surname: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+        postcode: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+              pattern: {
+                pattern: string;
+                message: string;
+              };
+              maxlength: number;
+            };
+          };
+        };
+        age: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+              badInput: {
+                message: string;
+              };
+            };
+          };
+        };
+        dob: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+              minmax: {
+                min: string;
+                max: string;
+                message: string;
+              };
+            };
+          };
+        };
+        dropdown: {
+          form: {
+            type: string;
+            blankDefault: boolean;
+            label: string;
+            options: ({
+              label: string;
+              value: string;
+              placeholder: boolean;
+            } | {
+              label: string;
+              value: string;
+              placeholder?: undefined;
+            })[];
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+        permissions: {
+          form: {
+            type: string;
+            label: string;
+            inlineLabel: string;
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+      };
+    };
+  };
+};
+export declare const PrePopulateForm: {
+  (args: any): string;
+  args: {
+    data: {
+      title: string;
+      forename: string;
+      surname: string;
+      postcode: string;
+      age: string;
+      dob: string;
+    };
+    formSchema: {
+      properties: {
+        title: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+          };
+        };
+        forename: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+        surname: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+            };
+          };
+        };
+        postcode: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            validation: {
+              required: {
+                message: string;
+              };
+              pattern: {
+                pattern: string;
+                message: string;
+              };
+              maxlength: number;
+            };
+          };
+        };
+        age: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            readonly: boolean;
+            validation: {
+              required: {
+                message: string;
+              };
+              badInput: {
+                message: string;
+              };
+            };
+          };
+        };
+        dob: {
+          type: string;
+          format: string;
+          form: {
+            type: string;
+            placeholder: string;
+            label: string;
+            readonly: boolean;
+            validation: {
+              required: {
+                message: string;
+              };
+              minmax: {
+                min: string;
+                max: string;
+                message: string;
+              };
+            };
+          };
+        };
+      };
+    };
+  };
+};

package/dist/types/components/molecules/tttx-list/tttx-list.d.ts

@@ -1,11 +1,11 @@
-import { EventEmitter } from '../../../stencil-public-runtime';
-import { ListItem } from './interfaces';
-export declare class TttxList {
-  data: string | ListItem[];
-  name: string;
-  rowClick: EventEmitter;
-  private _data;
-  onRowClickHandler(item: ListItem): void;
-  renderListItem(item: ListItem): any;
-  render(): any;
-}
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { ListItem } from './interfaces';
+export declare class TttxList {
+  data: string | ListItem[];
+  name: string;
+  rowClick: EventEmitter;
+  private _data;
+  onRowClickHandler(item: ListItem): void;
+  renderListItem(item: ListItem): any;
+  render(): any;
+}

package/dist/types/components/molecules/tttx-list/tttx-list.stories.d.ts

@@ -1,14 +1,14 @@
-declare const _default: {
-  title: string;
-  component: string;
-  parameters: {
-    actions: {
-      handles: string[];
-    };
-  };
-  decorators: import("@storybook/types").Addon_DecoratorFunction<unknown>[];
-};
-export default _default;
-export declare const BasicStringList: any;
-export declare const BasicObjectList: any;
-export declare const BasicClickableList: any;
+declare const _default: {
+  title: string;
+  component: string;
+  parameters: {
+    actions: {
+      handles: string[];
+    };
+  };
+  decorators: import("@storybook/types").Addon_DecoratorFunction<unknown>[];
+};
+export default _default;
+export declare const BasicStringList: any;
+export declare const BasicObjectList: any;
+export declare const BasicClickableList: any;