@itwin/core-react 3.6.0 → 3.7.0-dev.1

package/lib/cjs/core-react/form/Field.js.map

@@ -1 +1 @@
-{"version":3,"file":"Field.js","sourceRoot":"","sources":["../../../../src/core-react/form/Field.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA+B;AAC/B,wDAAuF;AACvF,iCAAiE;AAcjE;;GAEG;AACH,MAAa,KAAM,SAAQ,KAAK,CAAC,SAAqB;IACpD,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAC;QAGP,2BAAsB,GAAG,CAAC,WAA4B,EAA0B,EAAE;YACxF,IAAI,aAAa,GAA2B,EAAE,CAAC;YAE/C,IAAI,WAAW,YAAY,KAAK,EAAE;gBAChC,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,CAClD,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CACjC,CAAC,CAAC;aACJ;iBAAM,IAAI,WAAW,KAAK,SAAS,EAAE;gBACpC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CACpD,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CACxC,CAAC,CAAC;aACJ;YAED,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;IAhBF,CAAC;IAkBe,MAAM;QACpB,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtE,OAAO,CACL,oBAAC,kBAAW,CAAC,QAAQ,QAClB,CAAC,OAAqC,EAAE,EAAE,CAAC,CAC1C,6BAAK,SAAS,EAAC,iBAAiB;YAC7B,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,+BAAO,SAAS,EAAC,iBAAiB,EAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,IAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAS;YAE5J,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,SAAS,IAAI,CACjD,oBAAC,qBAAK,IACJ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EACjB,KAAK,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACrC,QAAQ,EAAE,CAAC,KAA0C,EAAE,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,EAC5H,SAAS,EAAC,iBAAiB,EAC3B,IAAI,EAAC,OAAO,GACZ,CACH;YACA,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,CAClD,oBAAC,wBAAQ,IACP,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EACjB,OAAO,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACvC,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,GACxF,CACH;YACA,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,kBAAkB,IAAI,CAC1D,oBAAC,wBAAQ,IACP,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EACjB,KAAK,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACrC,QAAQ,EAAE,CAAC,KAA6C,EAAE,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,EAC/H,SAAS,EAAC,oBAAoB,GAC9B,CACH;YACA,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CACxE,oBAAC,sBAAM,IACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;gBACjB,uBAAuB;gBACvB,KAAK,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACrC,QAAQ,EAAE,CAAC,QAAa,EAAE,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAC9E,OAAO,EAAE,aAAa,EACtB,SAAS,EAAC,kBAAkB,EAC5B,IAAI,EAAC,OAAO,GACZ,CACH,CACG,CACP,CACoB,CACxB,CAAC;IACJ,CAAC;CACF;AAvED,sBAuEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module Form\n */\n\nimport * as React from \"react\";\nimport { Checkbox, Input, Select, SelectOption, Textarea } from \"@itwin/itwinui-react\";\nimport { FieldDef, FormContext, FormContextState } from \"./Form\";\n\n// cSpell:ignore multilinetextbox\n\n/** Properties used to create a [[Field]] in a [[Form]]\n * @public @deprecated in 3.0.\n */\nexport interface FieldProps extends FieldDef {\n  /* The unique field name */\n  id: string;\n}\n\ntype FieldDefOptions = FieldDef[\"options\"];\n\n/** Component that represents a single field in an input form. Only four type of editors are supported. Field gets/sets state data from/to the context control by the form.\n * @public @deprecated in 3.0.\n */\nexport class Field extends React.Component<FieldProps> {\n  constructor(props: FieldProps) {\n    super(props);\n  }\n\n  private _generateSelectOptions = (propOptions: FieldDefOptions): SelectOption<string>[] => {\n    let selectOptions: SelectOption<string>[] = [];\n\n    if (propOptions instanceof Array) {\n      selectOptions = propOptions.map((option: string) => (\n        { value: option, label: option }\n      ));\n    } else if (propOptions !== undefined) {\n      selectOptions = Object.keys(propOptions).map((key) => (\n        { value: key, label: propOptions[key] }\n      ));\n    }\n\n    return selectOptions;\n  };\n\n  public override render() {\n    const selectOptions = this._generateSelectOptions(this.props.options);\n\n    return (\n      <FormContext.Consumer>\n        {(context: FormContextState | undefined) => (\n          <div className=\"core-form-group\">\n            {this.props.editor!.toLowerCase() !== \"checkbox\" && this.props.label && <label className=\"core-form-label\" htmlFor={this.props.id}>{this.props.label}</label>}\n\n            {this.props.editor!.toLowerCase() === \"textbox\" && (\n              <Input\n                id={this.props.id}\n                value={context!.values[this.props.id]}\n                onChange={(event: React.ChangeEvent<HTMLInputElement>) => context!.setValues({ [this.props.id]: event.currentTarget.value })}\n                className=\"core-form-input\"\n                size=\"small\"\n              />\n            )}\n            {this.props.editor!.toLowerCase() === \"checkbox\" && (\n              <Checkbox\n                label={this.props.label}\n                id={this.props.id}\n                checked={context!.values[this.props.id]}\n                onChange={() => context!.setValues({ [this.props.id]: !context!.values[this.props.id] })}\n              />\n            )}\n            {this.props.editor!.toLowerCase() === \"multilinetextbox\" && (\n              <Textarea\n                id={this.props.id}\n                value={context!.values[this.props.id]}\n                onChange={(event: React.ChangeEvent<HTMLTextAreaElement>) => context!.setValues({ [this.props.id]: event.currentTarget.value })}\n                className=\"core-form-textarea\"\n              />\n            )}\n            {this.props.editor!.toLowerCase() === \"dropdown\" && this.props.options && (\n              <Select\n                id={this.props.id}\n                // name={this.props.id}\n                value={context!.values[this.props.id]}\n                onChange={(newValue: any) => context!.setValues({ [this.props.id]: newValue })}\n                options={selectOptions}\n                className=\"core-form-select\"\n                size=\"small\"\n              />\n            )}\n          </div>\n        )}\n      </FormContext.Consumer>\n    );\n  }\n}\n"]}
+{"version":3,"file":"Field.js","sourceRoot":"","sources":["../../../../src/core-react/form/Field.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA+B;AAC/B,wDAAuF;AACvF,iCAAiE;AAcjE;;GAEG;AACH,MAAa,KAAM,SAAQ,KAAK,CAAC,SAAqB;IACpD,YAAY,KAAiB;QAC3B,KAAK,CAAC,KAAK,CAAC,CAAC;QAGP,2BAAsB,GAAG,CAAC,WAA4B,EAA0B,EAAE;YACxF,IAAI,aAAa,GAA2B,EAAE,CAAC;YAE/C,IAAI,WAAW,YAAY,KAAK,EAAE;gBAChC,aAAa,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,CAClD,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CACjC,CAAC,CAAC;aACJ;iBAAM,IAAI,WAAW,KAAK,SAAS,EAAE;gBACpC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CACpD,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CACxC,CAAC,CAAC;aACJ;YAED,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;IAhBF,CAAC;IAkBe,MAAM;QACpB,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtE,OAAO,CACL,oBAAC,kBAAW,CAAC,QAAQ,QAClB,CAAC,OAAqC,EAAE,EAAE,CAAC,CAC1C,6BAAK,SAAS,EAAC,iBAAiB;YAC7B,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,+BAAO,SAAS,EAAC,iBAAiB,EAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,IAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAS;YAE5J,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,SAAS,IAAI,CACjD,oBAAC,qBAAK,IACJ,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EACjB,KAAK,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACrC,QAAQ,EAAE,CAAC,KAA0C,EAAE,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,EAC5H,SAAS,EAAC,iBAAiB,EAC3B,IAAI,EAAC,OAAO,GACZ,CACH;YACA,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,CAClD,oBAAC,wBAAQ,IACP,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EACjB,OAAO,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACvC,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,GACxF,CACH;YACA,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,kBAAkB,IAAI,CAC1D,oBAAC,wBAAQ,IACP,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EACjB,KAAK,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACrC,QAAQ,EAAE,CAAC,KAA6C,EAAE,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,EAC/H,SAAS,EAAC,oBAAoB,GAC9B,CACH;YACA,IAAI,CAAC,KAAK,CAAC,MAAO,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CACxE,oBAAC,sBAAM,IACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;gBACjB,uBAAuB;gBACvB,KAAK,EAAE,OAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EACrC,QAAQ,EAAE,CAAC,QAAa,EAAE,EAAE,CAAC,OAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAC9E,OAAO,EAAE,aAAa,EACtB,SAAS,EAAC,kBAAkB,EAC5B,IAAI,EAAC,OAAO,GACZ,CACH,CACG,CACP,CACoB,CACxB,CAAC;IACJ,CAAC;CACF;AAvED,sBAuEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Form\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Checkbox, Input, Select, SelectOption, Textarea } from \"@itwin/itwinui-react\";\r\nimport { FieldDef, FormContext, FormContextState } from \"./Form\";\r\n\r\n// cSpell:ignore multilinetextbox\r\n\r\n/** Properties used to create a [[Field]] in a [[Form]]\r\n * @public @deprecated in 3.0. Removed Forms implementation\r\n */\r\nexport interface FieldProps extends FieldDef {\r\n  /* The unique field name */\r\n  id: string;\r\n}\r\n\r\ntype FieldDefOptions = FieldDef[\"options\"];\r\n\r\n/** Component that represents a single field in an input form. Only four type of editors are supported. Field gets/sets state data from/to the context control by the form.\r\n * @public @deprecated in 3.0. Removed Forms implementation\r\n */\r\nexport class Field extends React.Component<FieldProps> {\r\n  constructor(props: FieldProps) {\r\n    super(props);\r\n  }\r\n\r\n  private _generateSelectOptions = (propOptions: FieldDefOptions): SelectOption<string>[] => {\r\n    let selectOptions: SelectOption<string>[] = [];\r\n\r\n    if (propOptions instanceof Array) {\r\n      selectOptions = propOptions.map((option: string) => (\r\n        { value: option, label: option }\r\n      ));\r\n    } else if (propOptions !== undefined) {\r\n      selectOptions = Object.keys(propOptions).map((key) => (\r\n        { value: key, label: propOptions[key] }\r\n      ));\r\n    }\r\n\r\n    return selectOptions;\r\n  };\r\n\r\n  public override render() {\r\n    const selectOptions = this._generateSelectOptions(this.props.options);\r\n\r\n    return (\r\n      <FormContext.Consumer>\r\n        {(context: FormContextState | undefined) => (\r\n          <div className=\"core-form-group\">\r\n            {this.props.editor!.toLowerCase() !== \"checkbox\" && this.props.label && <label className=\"core-form-label\" htmlFor={this.props.id}>{this.props.label}</label>}\r\n\r\n            {this.props.editor!.toLowerCase() === \"textbox\" && (\r\n              <Input\r\n                id={this.props.id}\r\n                value={context!.values[this.props.id]}\r\n                onChange={(event: React.ChangeEvent<HTMLInputElement>) => context!.setValues({ [this.props.id]: event.currentTarget.value })}\r\n                className=\"core-form-input\"\r\n                size=\"small\"\r\n              />\r\n            )}\r\n            {this.props.editor!.toLowerCase() === \"checkbox\" && (\r\n              <Checkbox\r\n                label={this.props.label}\r\n                id={this.props.id}\r\n                checked={context!.values[this.props.id]}\r\n                onChange={() => context!.setValues({ [this.props.id]: !context!.values[this.props.id] })}\r\n              />\r\n            )}\r\n            {this.props.editor!.toLowerCase() === \"multilinetextbox\" && (\r\n              <Textarea\r\n                id={this.props.id}\r\n                value={context!.values[this.props.id]}\r\n                onChange={(event: React.ChangeEvent<HTMLTextAreaElement>) => context!.setValues({ [this.props.id]: event.currentTarget.value })}\r\n                className=\"core-form-textarea\"\r\n              />\r\n            )}\r\n            {this.props.editor!.toLowerCase() === \"dropdown\" && this.props.options && (\r\n              <Select\r\n                id={this.props.id}\r\n                // name={this.props.id}\r\n                value={context!.values[this.props.id]}\r\n                onChange={(newValue: any) => context!.setValues({ [this.props.id]: newValue })}\r\n                options={selectOptions}\r\n                className=\"core-form-select\"\r\n                size=\"small\"\r\n              />\r\n            )}\r\n          </div>\r\n        )}\r\n      </FormContext.Consumer>\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/cjs/core-react/form/Form.d.ts

@@ -1,132 +1,132 @@
-/** @packageDocumentation
- * @module Form
- */
-import "./Form.scss";
-import * as React from "react";
-/** The available editors for the fields in a [[Form]].
- * @public @deprecated in 3.0.
- */
-export declare type FieldEditor = "textbox" | "multilinetextbox" | "dropdown" | "checkbox";
-/** Interface used to define each [[Field]] in a [[Form]]
- * @public @deprecated in 3.0.
- */
-export interface FieldDef {
-    label?: string;
-    editor?: FieldEditor;
-    options?: string[] | {
-        [key: string]: string;
-    };
-    value?: any;
-}
-/** Key/value pairs for all the field values with key being the field HTML Id.
- * @public @deprecated in 3.0.
- */
-export interface FieldValues {
-    [key: string]: any;
-}
-/** The state data used by [[Form]] to hold state of each [[Field]] and the result of submit button processing.
- * @public @deprecated in 3.0.
- */
-interface FormState {
-    values: FieldValues;
-    errorMsg: string;
-    submitSuccess?: boolean;
-}
-/**
- * FormContextState combines the Form's state data with the callbacks used to update the value of the state data.
- * @public @deprecate
- */
-export interface FormContextState extends FormState {
-    setValues: (values: FieldValues) => void;
-}
-/** React context used by Form as a Provider and by the Fields as Consumers and updaters.
- * @public @deprecated in 3.0.
- */
-export declare const FormContext: React.Context<FormContextState | undefined>;
-/** Key/value pairs for all the field definitions to be displayed in a [[Form]].
- * @public
- */
-export interface FieldDefinitions {
-    [key: string]: FieldDef;
-}
-/** Properties that define [[Form]] including the callback to be called when the Submit button is pressed.
- * @public
- */
-export interface FormProps {
-    /** Required async callback the processes the Form data and throws and Error if the data cannot be processed.  */
-    handleFormSubmit: (values: FieldValues) => Promise<void>;
-    /** Definition used to create each Field in the Form. */
-    fields: FieldDefinitions;
-    /** Optional label which will override default Submit button label. */
-    submitButtonLabel?: string;
-}
-/** Component used to create a Form using supplied properties to specify the fields of the Form.
- * @example
- * // Example of using a form as contents of a modal dialog.
- * export class ExampleForm extends React.Component {
- *   public static open() {
- *   const form = new ExampleForm({});
- *   ModalDialogManager.openDialog(form.render());
- * }
- *
- * protected async handleSubmit(values: FieldValues): Promise<void> {
- *   await this.processFormSubmission(values);
- *   ModalDialogManager.closeDialog();
- *   const msg = JSON.stringify(values);
- *   IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "Form Submitted", msg));
- * }
- *
- * protected async processFormSubmission(values: FieldValues): Promise<void> {
- *   // if error occurs during async processing throw an Error and return error message back to form.
- *   throw new Error("Error processing form");
- * }
- *
- * protected handleCancel() {
- *   ModalDialogManager.closeDialog();
- * }
- *
- * public render() {
- *   const fields: FieldDefinitions = {
- *     Name: {
- *       label: this._nameLabel,
- *       editor: "textbox",
- *       value: "John Smith",
- *     },
- *     PickList: {
- *       label: this._pickListLabel,
- *       editor: "dropdown",
- *       value: "one",
- *       options: ["one", "two", "three", "four"],
- *     },
- *   };
- *
- *   return (
- *     <div>
- *       <Dialog title="Example Form"
- *         opened={true}
- *         onClose={() => this.handleCancel()}>
- *         <Form handleFormSubmit={(values: FieldValues) => this.handleSubmit(values)}
- *           fields={fields}
- *         />
- *       </Dialog>
- *     </div >
- *   );
- * }
- * @public @deprecate
- */
-export declare class Form extends React.Component<FormProps, FormState> {
-    private _submitButtonLabel;
-    private _errorPrefix;
-    private _errorSuffix;
-    constructor(props: FormProps);
-    /**
-     * Returns whether there is an errorMsg message in the state/context
-     * @param errorMsg - The form errorMsg
-     */
-    private haveError;
-    private _setValues;
-    private _handleSubmit;
-    render(): JSX.Element;
-}
-export {};
+/** @packageDocumentation
+ * @module Form
+ */
+import "./Form.scss";
+import * as React from "react";
+/** The available editors for the fields in a [[Form]].
+ * @public @deprecated in 3.0. Forms functionality was removed.
+ */
+export declare type FieldEditor = "textbox" | "multilinetextbox" | "dropdown" | "checkbox";
+/** Interface used to define each [[Field]] in a [[Form]]
+ * @public @deprecated in 3.0.F orms functionality was removed.
+ */
+export interface FieldDef {
+    label?: string;
+    editor?: FieldEditor;
+    options?: string[] | {
+        [key: string]: string;
+    };
+    value?: any;
+}
+/** Key/value pairs for all the field values with key being the field HTML Id.
+ * @public @deprecated in 3.0. Forms functionality was removed.
+ */
+export interface FieldValues {
+    [key: string]: any;
+}
+/** The state data used by [[Form]] to hold state of each [[Field]] and the result of submit button processing.
+ * @public @deprecated in 3.0. Forms functionality was removed.
+ */
+interface FormState {
+    values: FieldValues;
+    errorMsg: string;
+    submitSuccess?: boolean;
+}
+/**
+ * FormContextState combines the Form's state data with the callbacks used to update the value of the state data.
+ * @public @deprecate
+ */
+export interface FormContextState extends FormState {
+    setValues: (values: FieldValues) => void;
+}
+/** React context used by Form as a Provider and by the Fields as Consumers and updaters.
+ * @public @deprecated in 3.0. Forms functionality was removed.
+ */
+export declare const FormContext: React.Context<FormContextState | undefined>;
+/** Key/value pairs for all the field definitions to be displayed in a [[Form]].
+ * @public
+ */
+export interface FieldDefinitions {
+    [key: string]: FieldDef;
+}
+/** Properties that define [[Form]] including the callback to be called when the Submit button is pressed.
+ * @public
+ */
+export interface FormProps {
+    /** Required async callback the processes the Form data and throws and Error if the data cannot be processed.  */
+    handleFormSubmit: (values: FieldValues) => Promise<void>;
+    /** Definition used to create each Field in the Form. */
+    fields: FieldDefinitions;
+    /** Optional label which will override default Submit button label. */
+    submitButtonLabel?: string;
+}
+/** Component used to create a Form using supplied properties to specify the fields of the Form.
+ * @example
+ * // Example of using a form as contents of a modal dialog.
+ * export class ExampleForm extends React.Component {
+ *   public static open() {
+ *   const form = new ExampleForm({});
+ *   UiFramework.dialogs.modal.openDialog(form.render());
+ * }
+ *
+ * protected async handleSubmit(values: FieldValues): Promise<void> {
+ *   await this.processFormSubmission(values);
+ *   UiFramework.dialogs.modal.closeDialog();
+ *   const msg = JSON.stringify(values);
+ *   IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "Form Submitted", msg));
+ * }
+ *
+ * protected async processFormSubmission(values: FieldValues): Promise<void> {
+ *   // if error occurs during async processing throw an Error and return error message back to form.
+ *   throw new Error("Error processing form");
+ * }
+ *
+ * protected handleCancel() {
+ *   UiFramework.dialogs.modal.closeDialog();
+ * }
+ *
+ * public render() {
+ *   const fields: FieldDefinitions = {
+ *     Name: {
+ *       label: this._nameLabel,
+ *       editor: "textbox",
+ *       value: "John Smith",
+ *     },
+ *     PickList: {
+ *       label: this._pickListLabel,
+ *       editor: "dropdown",
+ *       value: "one",
+ *       options: ["one", "two", "three", "four"],
+ *     },
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <Dialog title="Example Form"
+ *         opened={true}
+ *         onClose={() => this.handleCancel()}>
+ *         <Form handleFormSubmit={(values: FieldValues) => this.handleSubmit(values)}
+ *           fields={fields}
+ *         />
+ *       </Dialog>
+ *     </div >
+ *   );
+ * }
+ * @public @deprecate
+ */
+export declare class Form extends React.Component<FormProps, FormState> {
+    private _submitButtonLabel;
+    private _errorPrefix;
+    private _errorSuffix;
+    constructor(props: FormProps);
+    /**
+     * Returns whether there is an errorMsg message in the state/context
+     * @param errorMsg - The form errorMsg
+     */
+    private haveError;
+    private _setValues;
+    private _handleSubmit;
+    render(): JSX.Element;
+}
+export {};
 //# sourceMappingURL=Form.d.ts.map

package/lib/cjs/core-react/form/Form.js

@@ -1,132 +1,132 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/* eslint-disable deprecation/deprecation */
-/** @packageDocumentation
- * @module Form
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Form = exports.FormContext = void 0;
-require("./Form.scss");
-const React = require("react");
-const UiCore_1 = require("../UiCore");
-const Field_1 = require("./Field");
-const itwinui_react_1 = require("@itwin/itwinui-react");
-/** React context used by Form as a Provider and by the Fields as Consumers and updaters.
- * @public @deprecated in 3.0.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-exports.FormContext = React.createContext(undefined);
-exports.FormContext.displayName = "core-react:FormContext";
-/** Component used to create a Form using supplied properties to specify the fields of the Form.
- * @example
- * // Example of using a form as contents of a modal dialog.
- * export class ExampleForm extends React.Component {
- *   public static open() {
- *   const form = new ExampleForm({});
- *   ModalDialogManager.openDialog(form.render());
- * }
- *
- * protected async handleSubmit(values: FieldValues): Promise<void> {
- *   await this.processFormSubmission(values);
- *   ModalDialogManager.closeDialog();
- *   const msg = JSON.stringify(values);
- *   IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "Form Submitted", msg));
- * }
- *
- * protected async processFormSubmission(values: FieldValues): Promise<void> {
- *   // if error occurs during async processing throw an Error and return error message back to form.
- *   throw new Error("Error processing form");
- * }
- *
- * protected handleCancel() {
- *   ModalDialogManager.closeDialog();
- * }
- *
- * public render() {
- *   const fields: FieldDefinitions = {
- *     Name: {
- *       label: this._nameLabel,
- *       editor: "textbox",
- *       value: "John Smith",
- *     },
- *     PickList: {
- *       label: this._pickListLabel,
- *       editor: "dropdown",
- *       value: "one",
- *       options: ["one", "two", "three", "four"],
- *     },
- *   };
- *
- *   return (
- *     <div>
- *       <Dialog title="Example Form"
- *         opened={true}
- *         onClose={() => this.handleCancel()}>
- *         <Form handleFormSubmit={(values: FieldValues) => this.handleSubmit(values)}
- *           fields={fields}
- *         />
- *       </Dialog>
- *     </div >
- *   );
- * }
- * @public @deprecate
- */
-class Form extends React.Component {
-    constructor(props) {
-        super(props);
-        this._submitButtonLabel = UiCore_1.UiCore.translate("form.submitButtonLabel");
-        this._errorPrefix = UiCore_1.UiCore.translate("form.errorPrefix");
-        this._errorSuffix = UiCore_1.UiCore.translate("form.errorSuffix");
-        this._setValues = (values) => {
-            this.setState((prevState) => ({ values: { ...prevState.values, ...values } }));
-        };
-        this._handleSubmit = (event, values) => {
-            event.preventDefault();
-            // istanbul ignore next
-            if (!this.props.handleFormSubmit || !values || 0 === values.length)
-                throw new Error("A handleFormSubmit function and values must be defined");
-            this.props.handleFormSubmit(values)
-                .then(() => {
-                // Currently we don't need to do anything if successful. Typically the hosting dialog will close when the
-                // submission is successful.
-                // console.log(rtnMsg);
-            })
-                .catch((reason) => {
-                this.setState({ submitSuccess: false, errorMsg: reason.message });
-            });
-        };
-        // set initial values for field values
-        const values = {};
-        Object.keys(props.fields).forEach((key) => values[key] = props.fields[key].value);
-        this.state = {
-            errorMsg: "",
-            values,
-        };
-    }
-    /**
-     * Returns whether there is an errorMsg message in the state/context
-     * @param errorMsg - The form errorMsg
-     */
-    haveError(errorMsg) {
-        return errorMsg && errorMsg.length;
-    }
-    render() {
-        const { submitSuccess, errorMsg } = this.state;
-        const { fields, submitButtonLabel } = this.props;
-        const context = { ...this.state, setValues: this._setValues };
-        return (React.createElement(exports.FormContext.Provider, { value: context },
-            React.createElement("div", { className: "core-form-wrapper" },
-                React.createElement("form", { onSubmit: (event) => this._handleSubmit(event, this.state.values), noValidate: true },
-                    React.createElement("div", { className: "core-form-container" },
-                        Object.keys(fields).map((key) => React.createElement(Field_1.Field, { key: key, id: key, ...this.props.fields[key] })),
-                        React.createElement("div", { className: "core-form-footer" },
-                            React.createElement("div", { className: "core-form-buttons" },
-                                React.createElement(itwinui_react_1.Button, { type: "submit", styleType: "high-visibility" }, submitButtonLabel ? submitButtonLabel : this._submitButtonLabel)),
-                            submitSuccess === false && this.haveError(errorMsg) && (React.createElement("div", { className: "core-form-alert", role: "alert" }, `${this._errorPrefix}-${errorMsg} ${this._errorSuffix}`))))))));
-    }
-}
-exports.Form = Form;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module Form
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Form = exports.FormContext = void 0;
+require("./Form.scss");
+const React = require("react");
+const UiCore_1 = require("../UiCore");
+const Field_1 = require("./Field");
+const itwinui_react_1 = require("@itwin/itwinui-react");
+/** React context used by Form as a Provider and by the Fields as Consumers and updaters.
+ * @public @deprecated in 3.0. Forms functionality was removed.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+exports.FormContext = React.createContext(undefined);
+exports.FormContext.displayName = "core-react:FormContext";
+/** Component used to create a Form using supplied properties to specify the fields of the Form.
+ * @example
+ * // Example of using a form as contents of a modal dialog.
+ * export class ExampleForm extends React.Component {
+ *   public static open() {
+ *   const form = new ExampleForm({});
+ *   UiFramework.dialogs.modal.openDialog(form.render());
+ * }
+ *
+ * protected async handleSubmit(values: FieldValues): Promise<void> {
+ *   await this.processFormSubmission(values);
+ *   UiFramework.dialogs.modal.closeDialog();
+ *   const msg = JSON.stringify(values);
+ *   IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "Form Submitted", msg));
+ * }
+ *
+ * protected async processFormSubmission(values: FieldValues): Promise<void> {
+ *   // if error occurs during async processing throw an Error and return error message back to form.
+ *   throw new Error("Error processing form");
+ * }
+ *
+ * protected handleCancel() {
+ *   UiFramework.dialogs.modal.closeDialog();
+ * }
+ *
+ * public render() {
+ *   const fields: FieldDefinitions = {
+ *     Name: {
+ *       label: this._nameLabel,
+ *       editor: "textbox",
+ *       value: "John Smith",
+ *     },
+ *     PickList: {
+ *       label: this._pickListLabel,
+ *       editor: "dropdown",
+ *       value: "one",
+ *       options: ["one", "two", "three", "four"],
+ *     },
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <Dialog title="Example Form"
+ *         opened={true}
+ *         onClose={() => this.handleCancel()}>
+ *         <Form handleFormSubmit={(values: FieldValues) => this.handleSubmit(values)}
+ *           fields={fields}
+ *         />
+ *       </Dialog>
+ *     </div >
+ *   );
+ * }
+ * @public @deprecate
+ */
+class Form extends React.Component {
+    constructor(props) {
+        super(props);
+        this._submitButtonLabel = UiCore_1.UiCore.translate("form.submitButtonLabel");
+        this._errorPrefix = UiCore_1.UiCore.translate("form.errorPrefix");
+        this._errorSuffix = UiCore_1.UiCore.translate("form.errorSuffix");
+        this._setValues = (values) => {
+            this.setState((prevState) => ({ values: { ...prevState.values, ...values } }));
+        };
+        this._handleSubmit = (event, values) => {
+            event.preventDefault();
+            // istanbul ignore next
+            if (!this.props.handleFormSubmit || !values || 0 === values.length)
+                throw new Error("A handleFormSubmit function and values must be defined");
+            this.props.handleFormSubmit(values)
+                .then(() => {
+                // Currently we don't need to do anything if successful. Typically the hosting dialog will close when the
+                // submission is successful.
+                // console.log(rtnMsg);
+            })
+                .catch((reason) => {
+                this.setState({ submitSuccess: false, errorMsg: reason.message });
+            });
+        };
+        // set initial values for field values
+        const values = {};
+        Object.keys(props.fields).forEach((key) => values[key] = props.fields[key].value);
+        this.state = {
+            errorMsg: "",
+            values,
+        };
+    }
+    /**
+     * Returns whether there is an errorMsg message in the state/context
+     * @param errorMsg - The form errorMsg
+     */
+    haveError(errorMsg) {
+        return errorMsg && errorMsg.length;
+    }
+    render() {
+        const { submitSuccess, errorMsg } = this.state;
+        const { fields, submitButtonLabel } = this.props;
+        const context = { ...this.state, setValues: this._setValues };
+        return (React.createElement(exports.FormContext.Provider, { value: context },
+            React.createElement("div", { className: "core-form-wrapper" },
+                React.createElement("form", { onSubmit: (event) => this._handleSubmit(event, this.state.values), noValidate: true },
+                    React.createElement("div", { className: "core-form-container" },
+                        Object.keys(fields).map((key) => React.createElement(Field_1.Field, { key: key, id: key, ...this.props.fields[key] })),
+                        React.createElement("div", { className: "core-form-footer" },
+                            React.createElement("div", { className: "core-form-buttons" },
+                                React.createElement(itwinui_react_1.Button, { type: "submit", styleType: "high-visibility" }, submitButtonLabel ? submitButtonLabel : this._submitButtonLabel)),
+                            submitSuccess === false && this.haveError(errorMsg) && (React.createElement("div", { className: "core-form-alert", role: "alert" }, `${this._errorPrefix}-${errorMsg} ${this._errorSuffix}`))))))));
+    }
+}
+exports.Form = Form;
 //# sourceMappingURL=Form.js.map

package/lib/cjs/core-react/form/Form.js.map

@@ -1 +1 @@
-{"version":3,"file":"Form.js","sourceRoot":"","sources":["../../../../src/core-react/form/Form.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,uBAAqB;AACrB,+BAA+B;AAC/B,sCAAmC;AACnC,mCAAgC;AAChC,wDAA8C;AAuD9C;;GAEG;AACH,gEAAgE;AACnD,QAAA,WAAW,GAAG,KAAK,CAAC,aAAa,CAA+B,SAAS,CAAC,CAAC;AACxF,mBAAW,CAAC,WAAW,GAAG,wBAAwB,CAAC;AAqBnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAa,IAAK,SAAQ,KAAK,CAAC,SAA+B;IAK7D,YAAY,KAAgB;QAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;QALP,uBAAkB,GAAG,eAAM,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;QAChE,iBAAY,GAAG,eAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACpD,iBAAY,GAAG,eAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAuBpD,eAAU,GAAG,CAAC,MAAmB,EAAE,EAAE;YAC3C,IAAI,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,KAAuC,EAAE,MAAmB,EAAE,EAAE;YACvF,KAAK,CAAC,cAAc,EAAE,CAAC;YAEvB,uBAAuB;YACvB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM;gBAChE,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;YAE5E,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC;iBAChC,IAAI,CAAC,GAAG,EAAE;gBACT,yGAAyG;gBACzG,4BAA4B;gBAC5B,uBAAuB;YACzB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,MAAa,EAAE,EAAE;gBACvB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAtCA,sCAAsC;QACtC,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAElF,IAAI,CAAC,KAAK,GAAG;YACX,QAAQ,EAAE,EAAE;YACZ,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,SAAS,CAAC,QAAgB;QAChC,OAAO,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC;IACrC,CAAC;IAwBe,MAAM;QACpB,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC/C,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjD,MAAM,OAAO,GAAqB,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QAEhF,OAAO,CACL,oBAAC,mBAAW,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO;YAClC,6BAAK,SAAS,EAAC,mBAAmB;gBAChC,8BAAM,QAAQ,EAAE,CAAC,KAAuC,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,IAAI;oBACzH,6BAAK,SAAS,EAAC,qBAAqB;wBACjC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,oBAAC,aAAK,IAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,KAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAI,CAAC;wBAC3F,6BAAK,SAAS,EAAC,kBAAkB;4BAC/B,6BAAK,SAAS,EAAC,mBAAmB;gCAChC,oBAAC,sBAAM,IAAC,IAAI,EAAC,QAAQ,EAAC,SAAS,EAAC,iBAAiB,IAC9C,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CACzD,CACL;4BACL,aAAa,KAAK,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CACtD,6BAAK,SAAS,EAAC,iBAAiB,EAAC,IAAI,EAAC,OAAO,IAAE,GAAG,IAAI,CAAC,YAAY,IAAI,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,CAAO,CAC9G,CACG,CACF,CACD,CACH,CACe,CACxB,CAAC;IACJ,CAAC;CACF;AA3ED,oBA2EC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module Form\n */\n\nimport \"./Form.scss\";\nimport * as React from \"react\";\nimport { UiCore } from \"../UiCore\";\nimport { Field } from \"./Field\";\nimport { Button } from \"@itwin/itwinui-react\";\n\n// cSpell:ignore multilinetextbox\n\n/** The available editors for the fields in a [[Form]].\n * @public @deprecated in 3.0.\n */\nexport type FieldEditor = \"textbox\" | \"multilinetextbox\" | \"dropdown\" | \"checkbox\";\n\n/** Interface used to define each [[Field]] in a [[Form]]\n * @public @deprecated in 3.0.\n */\nexport interface FieldDef {\n  /* The label text for the field */\n  label?: string;\n\n  /* The editor for the field */\n  editor?: FieldEditor;\n\n  /* The drop down items for the field */\n  options?: string[] | { [key: string]: string };\n\n  /* The initial field value */\n  value?: any;\n}\n\n/** Key/value pairs for all the field values with key being the field HTML Id.\n * @public @deprecated in 3.0.\n */\nexport interface FieldValues {\n  [key: string]: any;\n}\n\n/** The state data used by [[Form]] to hold state of each [[Field]] and the result of submit button processing.\n * @public @deprecated in 3.0.\n */\ninterface FormState {\n  /* The field values */\n  values: FieldValues;\n\n  /* The errorMsg message return in catch of async submit button processing */\n  errorMsg: string;\n\n  /* Whether the form has been successfully submitted */\n  submitSuccess?: boolean;\n}\n\n/**\n * FormContextState combines the Form's state data with the callbacks used to update the value of the state data.\n * @public @deprecate\n */\nexport interface FormContextState extends FormState {\n  setValues: (values: FieldValues) => void;\n}\n\n/** React context used by Form as a Provider and by the Fields as Consumers and updaters.\n * @public @deprecated in 3.0.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const FormContext = React.createContext<FormContextState | undefined>(undefined);\nFormContext.displayName = \"core-react:FormContext\";\n\n/** Key/value pairs for all the field definitions to be displayed in a [[Form]].\n * @public\n */\nexport interface FieldDefinitions {\n  [key: string]: FieldDef;\n}\n\n/** Properties that define [[Form]] including the callback to be called when the Submit button is pressed.\n * @public\n */\nexport interface FormProps {\n  /** Required async callback the processes the Form data and throws and Error if the data cannot be processed.  */\n  handleFormSubmit: (values: FieldValues) => Promise<void>;\n  /** Definition used to create each Field in the Form. */\n  fields: FieldDefinitions;\n  /** Optional label which will override default Submit button label. */\n  submitButtonLabel?: string;\n}\n\n/** Component used to create a Form using supplied properties to specify the fields of the Form.\n * @example\n * // Example of using a form as contents of a modal dialog.\n * export class ExampleForm extends React.Component {\n *   public static open() {\n *   const form = new ExampleForm({});\n *   ModalDialogManager.openDialog(form.render());\n * }\n *\n * protected async handleSubmit(values: FieldValues): Promise<void> {\n *   await this.processFormSubmission(values);\n *   ModalDialogManager.closeDialog();\n *   const msg = JSON.stringify(values);\n *   IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"Form Submitted\", msg));\n * }\n *\n * protected async processFormSubmission(values: FieldValues): Promise<void> {\n *   // if error occurs during async processing throw an Error and return error message back to form.\n *   throw new Error(\"Error processing form\");\n * }\n *\n * protected handleCancel() {\n *   ModalDialogManager.closeDialog();\n * }\n *\n * public render() {\n *   const fields: FieldDefinitions = {\n *     Name: {\n *       label: this._nameLabel,\n *       editor: \"textbox\",\n *       value: \"John Smith\",\n *     },\n *     PickList: {\n *       label: this._pickListLabel,\n *       editor: \"dropdown\",\n *       value: \"one\",\n *       options: [\"one\", \"two\", \"three\", \"four\"],\n *     },\n *   };\n *\n *   return (\n *     <div>\n *       <Dialog title=\"Example Form\"\n *         opened={true}\n *         onClose={() => this.handleCancel()}>\n *         <Form handleFormSubmit={(values: FieldValues) => this.handleSubmit(values)}\n *           fields={fields}\n *         />\n *       </Dialog>\n *     </div >\n *   );\n * }\n * @public @deprecate\n */\nexport class Form extends React.Component<FormProps, FormState> {\n  private _submitButtonLabel = UiCore.translate(\"form.submitButtonLabel\");\n  private _errorPrefix = UiCore.translate(\"form.errorPrefix\");\n  private _errorSuffix = UiCore.translate(\"form.errorSuffix\");\n\n  constructor(props: FormProps) {\n    super(props);\n\n    // set initial values for field values\n    const values: FieldValues = {};\n    Object.keys(props.fields).forEach((key) => values[key] = props.fields[key].value);\n\n    this.state = {\n      errorMsg: \"\",\n      values,\n    };\n  }\n\n  /**\n   * Returns whether there is an errorMsg message in the state/context\n   * @param errorMsg - The form errorMsg\n   */\n  private haveError(errorMsg: string) {\n    return errorMsg && errorMsg.length;\n  }\n\n  private _setValues = (values: FieldValues) => {\n    this.setState((prevState) => ({ values: { ...prevState.values, ...values } }));\n  };\n\n  private _handleSubmit = (event: React.FormEvent<HTMLFormElement>, values: FieldValues) => {\n    event.preventDefault();\n\n    // istanbul ignore next\n    if (!this.props.handleFormSubmit || !values || 0 === values.length)\n      throw new Error(\"A handleFormSubmit function and values must be defined\");\n\n    this.props.handleFormSubmit(values)\n      .then(() => {\n        // Currently we don't need to do anything if successful. Typically the hosting dialog will close when the\n        // submission is successful.\n        // console.log(rtnMsg);\n      })\n      .catch((reason: Error) => {\n        this.setState({ submitSuccess: false, errorMsg: reason.message });\n      });\n  };\n\n  public override render() {\n    const { submitSuccess, errorMsg } = this.state;\n    const { fields, submitButtonLabel } = this.props;\n    const context: FormContextState = { ...this.state, setValues: this._setValues };\n\n    return (\n      <FormContext.Provider value={context}>\n        <div className=\"core-form-wrapper\">\n          <form onSubmit={(event: React.FormEvent<HTMLFormElement>) => this._handleSubmit(event, this.state.values)} noValidate={true}>\n            <div className=\"core-form-container\">\n              {Object.keys(fields).map((key) => <Field key={key} id={key} {...this.props.fields[key]} />)}\n              <div className=\"core-form-footer\">\n                <div className=\"core-form-buttons\">\n                  <Button type=\"submit\" styleType=\"high-visibility\">\n                    {submitButtonLabel ? submitButtonLabel : this._submitButtonLabel}\n                  </Button>\n                </div>\n                {submitSuccess === false && this.haveError(errorMsg) && (\n                  <div className=\"core-form-alert\" role=\"alert\">{`${this._errorPrefix}-${errorMsg} ${this._errorSuffix}`}</div>\n                )}\n              </div>\n            </div>\n          </form>\n        </div>\n      </FormContext.Provider>\n    );\n  }\n}\n"]}
+{"version":3,"file":"Form.js","sourceRoot":"","sources":["../../../../src/core-react/form/Form.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,uBAAqB;AACrB,+BAA+B;AAC/B,sCAAmC;AACnC,mCAAgC;AAChC,wDAA8C;AAuD9C;;GAEG;AACH,gEAAgE;AACnD,QAAA,WAAW,GAAG,KAAK,CAAC,aAAa,CAA+B,SAAS,CAAC,CAAC;AACxF,mBAAW,CAAC,WAAW,GAAG,wBAAwB,CAAC;AAqBnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAa,IAAK,SAAQ,KAAK,CAAC,SAA+B;IAK7D,YAAY,KAAgB;QAC1B,KAAK,CAAC,KAAK,CAAC,CAAC;QALP,uBAAkB,GAAG,eAAM,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;QAChE,iBAAY,GAAG,eAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACpD,iBAAY,GAAG,eAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAuBpD,eAAU,GAAG,CAAC,MAAmB,EAAE,EAAE;YAC3C,IAAI,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACjF,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,KAAuC,EAAE,MAAmB,EAAE,EAAE;YACvF,KAAK,CAAC,cAAc,EAAE,CAAC;YAEvB,uBAAuB;YACvB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM;gBAChE,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;YAE5E,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC;iBAChC,IAAI,CAAC,GAAG,EAAE;gBACT,yGAAyG;gBACzG,4BAA4B;gBAC5B,uBAAuB;YACzB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,MAAa,EAAE,EAAE;gBACvB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;YACpE,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QAtCA,sCAAsC;QACtC,MAAM,MAAM,GAAgB,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QAElF,IAAI,CAAC,KAAK,GAAG;YACX,QAAQ,EAAE,EAAE;YACZ,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,SAAS,CAAC,QAAgB;QAChC,OAAO,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC;IACrC,CAAC;IAwBe,MAAM;QACpB,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC/C,MAAM,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACjD,MAAM,OAAO,GAAqB,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QAEhF,OAAO,CACL,oBAAC,mBAAW,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO;YAClC,6BAAK,SAAS,EAAC,mBAAmB;gBAChC,8BAAM,QAAQ,EAAE,CAAC,KAAuC,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,IAAI;oBACzH,6BAAK,SAAS,EAAC,qBAAqB;wBACjC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,oBAAC,aAAK,IAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,GAAG,KAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,GAAI,CAAC;wBAC3F,6BAAK,SAAS,EAAC,kBAAkB;4BAC/B,6BAAK,SAAS,EAAC,mBAAmB;gCAChC,oBAAC,sBAAM,IAAC,IAAI,EAAC,QAAQ,EAAC,SAAS,EAAC,iBAAiB,IAC9C,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CACzD,CACL;4BACL,aAAa,KAAK,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CACtD,6BAAK,SAAS,EAAC,iBAAiB,EAAC,IAAI,EAAC,OAAO,IAAE,GAAG,IAAI,CAAC,YAAY,IAAI,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,CAAO,CAC9G,CACG,CACF,CACD,CACH,CACe,CACxB,CAAC;IACJ,CAAC;CACF;AA3ED,oBA2EC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Form\r\n */\r\n\r\nimport \"./Form.scss\";\r\nimport * as React from \"react\";\r\nimport { UiCore } from \"../UiCore\";\r\nimport { Field } from \"./Field\";\r\nimport { Button } from \"@itwin/itwinui-react\";\r\n\r\n// cSpell:ignore multilinetextbox\r\n\r\n/** The available editors for the fields in a [[Form]].\r\n * @public @deprecated in 3.0. Forms functionality was removed.\r\n */\r\nexport type FieldEditor = \"textbox\" | \"multilinetextbox\" | \"dropdown\" | \"checkbox\";\r\n\r\n/** Interface used to define each [[Field]] in a [[Form]]\r\n * @public @deprecated in 3.0.F orms functionality was removed.\r\n */\r\nexport interface FieldDef {\r\n  /* The label text for the field */\r\n  label?: string;\r\n\r\n  /* The editor for the field */\r\n  editor?: FieldEditor;\r\n\r\n  /* The drop down items for the field */\r\n  options?: string[] | { [key: string]: string };\r\n\r\n  /* The initial field value */\r\n  value?: any;\r\n}\r\n\r\n/** Key/value pairs for all the field values with key being the field HTML Id.\r\n * @public @deprecated in 3.0. Forms functionality was removed.\r\n */\r\nexport interface FieldValues {\r\n  [key: string]: any;\r\n}\r\n\r\n/** The state data used by [[Form]] to hold state of each [[Field]] and the result of submit button processing.\r\n * @public @deprecated in 3.0. Forms functionality was removed.\r\n */\r\ninterface FormState {\r\n  /* The field values */\r\n  values: FieldValues;\r\n\r\n  /* The errorMsg message return in catch of async submit button processing */\r\n  errorMsg: string;\r\n\r\n  /* Whether the form has been successfully submitted */\r\n  submitSuccess?: boolean;\r\n}\r\n\r\n/**\r\n * FormContextState combines the Form's state data with the callbacks used to update the value of the state data.\r\n * @public @deprecate\r\n */\r\nexport interface FormContextState extends FormState {\r\n  setValues: (values: FieldValues) => void;\r\n}\r\n\r\n/** React context used by Form as a Provider and by the Fields as Consumers and updaters.\r\n * @public @deprecated in 3.0. Forms functionality was removed.\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport const FormContext = React.createContext<FormContextState | undefined>(undefined);\r\nFormContext.displayName = \"core-react:FormContext\";\r\n\r\n/** Key/value pairs for all the field definitions to be displayed in a [[Form]].\r\n * @public\r\n */\r\nexport interface FieldDefinitions {\r\n  [key: string]: FieldDef;\r\n}\r\n\r\n/** Properties that define [[Form]] including the callback to be called when the Submit button is pressed.\r\n * @public\r\n */\r\nexport interface FormProps {\r\n  /** Required async callback the processes the Form data and throws and Error if the data cannot be processed.  */\r\n  handleFormSubmit: (values: FieldValues) => Promise<void>;\r\n  /** Definition used to create each Field in the Form. */\r\n  fields: FieldDefinitions;\r\n  /** Optional label which will override default Submit button label. */\r\n  submitButtonLabel?: string;\r\n}\r\n\r\n/** Component used to create a Form using supplied properties to specify the fields of the Form.\r\n * @example\r\n * // Example of using a form as contents of a modal dialog.\r\n * export class ExampleForm extends React.Component {\r\n *   public static open() {\r\n *   const form = new ExampleForm({});\r\n *   UiFramework.dialogs.modal.openDialog(form.render());\r\n * }\r\n *\r\n * protected async handleSubmit(values: FieldValues): Promise<void> {\r\n *   await this.processFormSubmission(values);\r\n *   UiFramework.dialogs.modal.closeDialog();\r\n *   const msg = JSON.stringify(values);\r\n *   IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"Form Submitted\", msg));\r\n * }\r\n *\r\n * protected async processFormSubmission(values: FieldValues): Promise<void> {\r\n *   // if error occurs during async processing throw an Error and return error message back to form.\r\n *   throw new Error(\"Error processing form\");\r\n * }\r\n *\r\n * protected handleCancel() {\r\n *   UiFramework.dialogs.modal.closeDialog();\r\n * }\r\n *\r\n * public render() {\r\n *   const fields: FieldDefinitions = {\r\n *     Name: {\r\n *       label: this._nameLabel,\r\n *       editor: \"textbox\",\r\n *       value: \"John Smith\",\r\n *     },\r\n *     PickList: {\r\n *       label: this._pickListLabel,\r\n *       editor: \"dropdown\",\r\n *       value: \"one\",\r\n *       options: [\"one\", \"two\", \"three\", \"four\"],\r\n *     },\r\n *   };\r\n *\r\n *   return (\r\n *     <div>\r\n *       <Dialog title=\"Example Form\"\r\n *         opened={true}\r\n *         onClose={() => this.handleCancel()}>\r\n *         <Form handleFormSubmit={(values: FieldValues) => this.handleSubmit(values)}\r\n *           fields={fields}\r\n *         />\r\n *       </Dialog>\r\n *     </div >\r\n *   );\r\n * }\r\n * @public @deprecate\r\n */\r\nexport class Form extends React.Component<FormProps, FormState> {\r\n  private _submitButtonLabel = UiCore.translate(\"form.submitButtonLabel\");\r\n  private _errorPrefix = UiCore.translate(\"form.errorPrefix\");\r\n  private _errorSuffix = UiCore.translate(\"form.errorSuffix\");\r\n\r\n  constructor(props: FormProps) {\r\n    super(props);\r\n\r\n    // set initial values for field values\r\n    const values: FieldValues = {};\r\n    Object.keys(props.fields).forEach((key) => values[key] = props.fields[key].value);\r\n\r\n    this.state = {\r\n      errorMsg: \"\",\r\n      values,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Returns whether there is an errorMsg message in the state/context\r\n   * @param errorMsg - The form errorMsg\r\n   */\r\n  private haveError(errorMsg: string) {\r\n    return errorMsg && errorMsg.length;\r\n  }\r\n\r\n  private _setValues = (values: FieldValues) => {\r\n    this.setState((prevState) => ({ values: { ...prevState.values, ...values } }));\r\n  };\r\n\r\n  private _handleSubmit = (event: React.FormEvent<HTMLFormElement>, values: FieldValues) => {\r\n    event.preventDefault();\r\n\r\n    // istanbul ignore next\r\n    if (!this.props.handleFormSubmit || !values || 0 === values.length)\r\n      throw new Error(\"A handleFormSubmit function and values must be defined\");\r\n\r\n    this.props.handleFormSubmit(values)\r\n      .then(() => {\r\n        // Currently we don't need to do anything if successful. Typically the hosting dialog will close when the\r\n        // submission is successful.\r\n        // console.log(rtnMsg);\r\n      })\r\n      .catch((reason: Error) => {\r\n        this.setState({ submitSuccess: false, errorMsg: reason.message });\r\n      });\r\n  };\r\n\r\n  public override render() {\r\n    const { submitSuccess, errorMsg } = this.state;\r\n    const { fields, submitButtonLabel } = this.props;\r\n    const context: FormContextState = { ...this.state, setValues: this._setValues };\r\n\r\n    return (\r\n      <FormContext.Provider value={context}>\r\n        <div className=\"core-form-wrapper\">\r\n          <form onSubmit={(event: React.FormEvent<HTMLFormElement>) => this._handleSubmit(event, this.state.values)} noValidate={true}>\r\n            <div className=\"core-form-container\">\r\n              {Object.keys(fields).map((key) => <Field key={key} id={key} {...this.props.fields[key]} />)}\r\n              <div className=\"core-form-footer\">\r\n                <div className=\"core-form-buttons\">\r\n                  <Button type=\"submit\" styleType=\"high-visibility\">\r\n                    {submitButtonLabel ? submitButtonLabel : this._submitButtonLabel}\r\n                  </Button>\r\n                </div>\r\n                {submitSuccess === false && this.haveError(errorMsg) && (\r\n                  <div className=\"core-form-alert\" role=\"alert\">{`${this._errorPrefix}-${errorMsg} ${this._errorSuffix}`}</div>\r\n                )}\r\n              </div>\r\n            </div>\r\n          </form>\r\n        </div>\r\n      </FormContext.Provider>\r\n    );\r\n  }\r\n}\r\n"]}