@digital-realty/ix-textbox 2.0.1 → 2.0.5

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 ix-textbox
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2023 ix-textbox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,62 +1,68 @@
-# \<ix-textbox>
-
-This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
-
-## Installation
-
-```bash
-npm i @digital-realty/ix-textbox
-```
-
-## Usage
-
-```html
-<script type="module">
-  import '@digital-realty/ix-textbox.js';
-</script>
-
-<ix-textbox></ix-textbox>
-```
-
-## Linting and formatting
-
-To scan the project for linting and formatting errors, run
-
-```bash
-npm run lint
-```
-
-To automatically fix linting and formatting errors, run
-
-```bash
-npm run format
-```
-
-## Testing with Web Test Runner
-
-To execute a single test run:
-
-```bash
-npm run test
-```
-
-To run the tests in interactive watch mode run:
-
-```bash
-npm run test:watch
-```
-
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Local Demo with `web-dev-server`
-
-```bash
-npm start
-```
-
-To run a local development server that serves the basic demo located in `demo/index.html`
+# \<ix-textbox>
+
+This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
+
+## Installation
+
+```bash
+npm i @digital-realty/ix-textbox
+```
+
+## Usage
+
+```html
+<script type="module">
+  import '@digital-realty/ix-textbox.js';
+</script>
+
+<ix-textbox></ix-textbox>
+```
+### In React
+```html
+<script type="module">
+  import { IxTextbox } from '@digital-realty/ix-textbox/IxTextbox'
+</script>
+```
+
+## Linting and formatting
+
+To scan the project for linting and formatting errors, run
+
+```bash
+npm run lint
+```
+
+To automatically fix linting and formatting errors, run
+
+```bash
+npm run format
+```
+
+## Testing with Web Test Runner
+
+To execute a single test run:
+
+```bash
+npm run test
+```
+
+To run the tests in interactive watch mode run:
+
+```bash
+npm run test:watch
+```
+
+
+## Tooling configs
+
+For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.
+
+If you customize the configuration a lot, you can consider moving them to individual files.
+
+## Local Demo with `web-dev-server`
+
+```bash
+npm start
+```
+
+To run a local development server that serves the basic demo located in `demo/index.html`

package/dist/src/IxTextbox.d.ts

@@ -1,105 +1,111 @@
-import { LitElement } from 'lit';
-import '@material/web/textfield/filled-text-field.js';
-import '@material/web/textfield/outlined-text-field.js';
-import { TextFieldType, UnsupportedTextFieldType } from './types/index.js';
-export declare class IxTextbox extends LitElement {
-    outlined: boolean;
-    type: TextFieldType | UnsupportedTextFieldType;
-    disabled: boolean;
-    /**
-     * Gets or sets whether or not the text field is in a visually invalid state.
-     *
-     * Calling `reportValidity()` will automatically update `error`.
-     */
-    error: boolean;
-    /**
-     * The error message that replaces supporting text when `error` is true. If
-     * `errorText` is an empty string, then the supporting text will continue to
-     * show.
-     *
-     * Calling `reportValidity()` will automatically update `errorText` to the
-     * native `validationMessage`.
-     */
-    errorText: string;
-    label: string;
-    required: boolean;
-    /**
-     * The current value of the text field. It is always a string.
-     */
-    value: string;
-    /**
-     * An optional prefix to display before the input value.
-     */
-    prefixText: string;
-    /**
-     * An optional suffix to display after the input value.
-     */
-    suffixText: string;
-    /**
-     * Whether or not the text field has a leading icon. Used for SSR.
-     */
-    hasLeadingIcon: boolean;
-    /**
-     * Whether or not the text field has a trailing icon. Used for SSR.
-     */
-    hasTrailingIcon: boolean;
-    /**
-     * Conveys additional information below the text field, such as how it should
-     * be used.
-     */
-    supportingText: string;
-    /**
-     * Override the input text CSS `direction`. Useful for RTL languages that use
-     * LTR notation for fractions.
-     */
-    textDirection: string;
-    /**
-     * The number of rows to display for a `type="textarea"` text field.
-     * Defaults to 2.
-     */
-    rows: number;
-    /**
-     * Defines the greatest value in the range of permitted values.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max
-     */
-    max: string;
-    /**
-     * The maximum number of characters a user can enter into the text field. Set
-     * to -1 for none.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength
-     */
-    maxLength: number;
-    /**
-     * Defines the most negative value in the range of permitted values.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min
-     */
-    min: string;
-    /**
-     * The minimum number of characters a user can enter into the text field. Set
-     * to -1 for none.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength
-     */
-    minLength: number;
-    /**
-     * A regular expression that the text field's value must match to pass
-     * constraint validation.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern
-     */
-    pattern: string;
-    placeholder: string;
-    /**
-     * Indicates whether or not a user should be able to edit the text field's
-     * value.
-     *
-     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly
-     */
-    readOnly: boolean;
-    onChange: Function;
-    _handleChange(e: Event): void;
-    render(): import("lit-html").TemplateResult<1>;
-}
+import { LitElement } from 'lit';
+import '@material/web/textfield/filled-text-field.js';
+import '@material/web/textfield/outlined-text-field.js';
+import { TextFieldType, UnsupportedTextFieldType } from './types/index.js';
+export declare class IxTextbox extends LitElement {
+    outlined: boolean;
+    type: TextFieldType | UnsupportedTextFieldType;
+    disabled: boolean;
+    /**
+     * Gets or sets whether or not the text field is in a visually invalid state.
+     *
+     * Calling `reportValidity()` will automatically update `error`.
+     */
+    error: boolean;
+    /**
+     * The error message that replaces supporting text when `error` is true. If
+     * `errorText` is an empty string, then the supporting text will continue to
+     * show.
+     *
+     * Calling `reportValidity()` will automatically update `errorText` to the
+     * native `validationMessage`.
+     */
+    errorText: string;
+    label: string;
+    required: boolean;
+    /**
+     * The current value of the text field. It is always a string.
+     */
+    value: string;
+    /**
+     * An optional prefix to display before the input value.
+     */
+    prefixText: string;
+    /**
+     * An optional suffix to display after the input value.
+     */
+    suffixText: string;
+    /**
+     * Whether or not the text field has a leading icon. Used for SSR.
+     */
+    hasLeadingIcon: boolean;
+    /**
+     * Whether or not the text field has a trailing icon. Used for SSR.
+     */
+    hasTrailingIcon: boolean;
+    /**
+     * Conveys additional information below the text field, such as how it should
+     * be used.
+     */
+    supportingText: string;
+    /**
+     * Override the input text CSS `direction`. Useful for RTL languages that use
+     * LTR notation for fractions.
+     */
+    textDirection: string;
+    /**
+     * The number of rows to display for a `type="textarea"` text field.
+     * Defaults to 2.
+     */
+    rows: number;
+    /**
+     * Defines the greatest value in the range of permitted values.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max
+     */
+    max: string;
+    /**
+     * The maximum number of characters a user can enter into the text field. Set
+     * to -1 for none.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength
+     */
+    maxLength: number;
+    /**
+     * Defines the most negative value in the range of permitted values.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min
+     */
+    min: string;
+    /**
+     * The minimum number of characters a user can enter into the text field. Set
+     * to -1 for none.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength
+     */
+    minLength: number;
+    /**
+     * A regular expression that the text field's value must match to pass
+     * constraint validation.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#pattern
+     */
+    pattern: string;
+    placeholder: string;
+    /**
+     * Indicates whether or not a user should be able to edit the text field's
+     * value.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#readonly
+     */
+    readOnly: boolean;
+    mdTextfield: HTMLInputElement;
+    handleChange(e: Event): void;
+    getValidityStatus(): boolean;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'ix-textbox': IxTextbox;
+    }
+}