@saasbase-io/core-elements 1.7.0 → 1.8.0

package/dist/components/renderers/_updated/field/_username-field.d.ts

@@ -0,0 +1,283 @@
+import { LitElement } from '../../../../../node_modules/lit';
+import { UsernameFieldContent, UsernameFieldProps } from './field.types';
+/**
+ * A self-validating username field for auth widget forms.
+ * @element sb-username-field
+ *
+ * @part username-field (rtg-field)
+ * @part username-field-content (rtg-field-content): label + description wrapper
+ * @part username-field-label (rtg-field-label)
+ * @part username-field-mark (span): decorative marker with text or `"*"` in label
+ * @part username-field-description (rtg-field-description)
+ * @part username-field-input (rtg-input)
+ * @part username-field-error (rtg-field-error)
+ *
+ * @fires sb-username-field:validate
+ * { id, parentId, name, value, valid, type, message }
+ *  - id: inputId
+ *  - parentId: rootId
+ *  - type: "required" | "format" | "success"
+ */
+export declare class SbUsernameField extends LitElement implements UsernameFieldProps {
+    private static readonly _ROOT;
+    private static readonly _CONTENT;
+    private static readonly _LABEL;
+    private static readonly _MARK;
+    private static readonly _DESCRIPTION;
+    private static readonly _INPUT;
+    private static readonly _ERROR;
+    private static readonly _PATTERN;
+    /**
+     * The stable CSS part names exposed for external targeting.
+     */
+    static get parts(): {
+        root: string;
+        content: string;
+        label: string;
+        mark: string;
+        description: string;
+        input: string;
+        error: string;
+    };
+    /**
+     * The name of the custom event fired on validate.
+     */
+    static get validateEventName(): string;
+    /**
+     * A unique value used as a substring in the generated part/child IDs, when
+     * the `child-id` prop is not provided.
+     */
+    seed: string;
+    /**
+     * The `id` value given to the root child/part and used as the base of other
+     * child/part IDs.
+     */
+    childId?: string;
+    /**
+     * The `id` value given to the input child/part to override the auto-generated
+     * input ID, derived from the `rootId`.
+     */
+    fieldId?: string;
+    /**
+     * The `name` prop of the input part, used by the parent form.
+     */
+    name: string;
+    /**
+     * Whether the label and description are grouped together above the input, or
+     * split up with the input in-between them.
+     */
+    content: UsernameFieldContent;
+    /**
+     * The text content of the field label.
+     */
+    label: string;
+    /**
+     * The text used as the input placeholder.
+     */
+    placeholder?: string;
+    /**
+     * The text content of the field description.
+     */
+    description?: string;
+    /**
+     * The text rendered in the field label as a custom mark.
+     */
+    mark?: string;
+    /**
+     * When provided with `required`, a caret mark is rendered in the field label.
+     */
+    caret?: boolean;
+    /**
+     * Whether the field is in a disabled state.
+     */
+    disabled?: boolean;
+    /**
+     * When provided, the parent form cannot be submitted without this field.
+     */
+    required?: boolean;
+    /**
+     * The minimum number of characters required for a valid username.
+     */
+    minlength?: number;
+    /**
+     * The maximum number of characters accepted for a valid username.
+     */
+    maxlength?: number;
+    /**
+     * The regex pattern for a valid username, used in place of `_PATTERN`.
+     */
+    pattern?: string;
+    /**
+     * Error message shown when the field is required but empty upon submission.
+     */
+    requiredError: string;
+    /**
+     * Custom error message shown when the username is shorter than minlength.
+     */
+    minlengthError?: string;
+    /**
+     * Custom error message shown when the username is longer than maxlength.
+     */
+    maxlengthError?: string;
+    /**
+     * Error message shown when the field is invalid upon submission.
+     */
+    formatError: string;
+    /**
+     * Indicates that the field is in an invalid state.
+     */
+    private _invalid;
+    /**
+     * The text rendered in field error when in an invalid state.
+     */
+    private _error;
+    /**
+     * The current value of the username input.
+     */
+    private _value;
+    /**
+     * Reference to the nearest `form` ancestor.
+     */
+    private _form;
+    /**
+     * Overrides default behavior to render into light DOM.
+     */
+    protected createRenderRoot(): this;
+    /**
+     * The `id` of the root element. Equal to `childId` when provided, otherwise
+     * derived from the component's part name and `seed`.
+     */
+    get rootId(): string;
+    /**
+     * The `id` of the field content element, derived from `rootId` with the
+     * content part name appended.
+     */
+    get contentId(): string;
+    /**
+     * The `id` of the field label element, derived from `rootId` with the label
+     * part name appended.
+     */
+    get labelId(): string;
+    /**
+     * The `id` of the field description element, derived from `rootId` with the
+     * description part name appended.
+     */
+    get descriptionId(): string;
+    /**
+     * The `id` of the mark element, derived from `rootId` with the mark part name
+     * appended.
+     */
+    get markId(): string;
+    /**
+     * The `id` of the input element, equal to `fieldId` when provided, otherwise
+     * derived from `rootId` with the input part name appended.
+     */
+    get inputId(): string;
+    /**
+     * The `id` of the field error element, derived from `rootId` with the error
+     * part name appended.
+     */
+    get errorId(): string;
+    /**
+     * Returns a the normalized value of `_value` by trimming whitespace and
+     * converting letters to lowercase.
+     */
+    private get _normalizedValue();
+    /**
+     * Returns sanitized `minlength` and `maxlength` values, filtering out
+     * non-positive numbers and discarding `maxlength` if it is less than
+     * `minlength` to prevent conflicting length constraints.
+     */
+    private get _lengths();
+    /**
+     * Returns the resolved regex pattern, using a `RegExp` built from the
+     * `pattern` prop when provided, otherwise falling back to `_PATTERN`.
+     */
+    private get _pattern();
+    /**
+     * Adds the input, form submit, and form reset event listeners.
+     */
+    connectedCallback(): void;
+    /**
+     * Removes the input, form submit, and form reset event listeners.
+     */
+    disconnectedCallback(): void;
+    /**
+     * The public validate method that calls the private `_validate()` method for
+     * manual, external validation.
+     */
+    validate(): boolean;
+    /**
+     * Defines and dispatches the validate event.
+     */
+    private _dispatchValidate;
+    /**
+     * Handles the required condition validation, accepting empty non-required
+     * fields and non-empty required fields, otherwise dispatching and displaying
+     * the required error.
+     */
+    private _validateRequired;
+    /**
+     * Handles the minlength condition validation, determining if a valid
+     * `minlength` prop was provided, dispatching and displaying the minlength
+     * error if the value is shorter than accepted.
+     */
+    private _validateMinlength;
+    /**
+     * Handles the maxlength condition validation, determining if a valid
+     * `maxlength` prop was provided, dispatching and displaying the maxlength
+     * error if the value is longer than accepted.
+     */
+    private _validateMaxlength;
+    /**
+     * Handles the format condition validation, testing against `_pattern`, and
+     * dispatching and displaying the format error for an invalid value.
+     */
+    private _validateFormat;
+    /**
+     * Resets the `_invalid` and `_error` private props and dispatches the
+     * validate event, indicating a successfully validated and valid username.
+     */
+    private _doValidateSuccess;
+    /**
+     * Handles validation and dispatches the success event if the required,
+     * length, and format conditions are met.
+     */
+    private _validate;
+    /**
+     * Handles the input event, updating the private `_value` prop.
+     */
+    private _handleInput;
+    /**
+     * Handles the form submit event, running the `_validate()` method and
+     * preventing the default submission behavior if invalid.
+     */
+    private _handleFormSubmit;
+    /**
+     * Handles the form reset event, resetting the input element's `value` as well
+     * as the username field's private props: `_value`, `_invalid`, and `_error`.
+     */
+    private _handleFormReset;
+    /**
+     * Conditionally returns the mark template for the field label. When `caret`
+     * and `required` are provided, the mark becomes an asterisk. When `mark` is
+     * provided, its value is rendered inside the element.
+     * If both a caret and custom text mark have their conditions met, the custom
+     * mark will be prioritised and rendered instead of the asterisk.
+     */
+    private _renderMark;
+    /**
+     * Returns the field label template with the label text and optional mark.
+     */
+    private _renderLabel;
+    /**
+     * Returns the field description template if `description` is defined.
+     */
+    private _renderDescription;
+    /**
+     * Returns the field error template with the `_error` message if the
+     * `_invalid` state is `true`.
+     */
+    private _renderError;
+    render(): import('../../../../../node_modules/lit-html').TemplateResult<1>;
+}

package/dist/components/renderers/_updated/field/field.stories/username-field.stories.d.ts

@@ -0,0 +1,14 @@
+import { Meta, StoryObj } from '@storybook/web-components-vite';
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj;
+export declare const Basic: Story;
+export declare const Label: Story;
+export declare const Placeholder: Story;
+export declare const Description: Story;
+export declare const Content: Story;
+export declare const Disabled: Story;
+export declare const Caret: Story;
+export declare const Mark: Story;
+export declare const Validate: Story;
+export declare const Form: Story;

package/dist/components/renderers/_updated/field/field.types.d.ts

@@ -1,3 +1,4 @@
+type BaseFieldValidateType = "success" | "required" | "format";
 type BaseFieldContent = "split" | "group";
 type BaseFieldProps = {
     seed: string;
@@ -15,14 +16,24 @@ type BaseFieldProps = {
     requiredError: string;
     formatError: string;
 };
-export type EmailFieldValidateType = "success" | "required" | "format";
+export type EmailFieldValidateType = BaseFieldValidateType;
 export type EmailFieldContent = BaseFieldContent;
 export type EmailFieldProps = Omit<BaseFieldProps, "content"> & {
     content: EmailFieldContent;
 };
-export type PhoneFieldValidateType = "success" | "required" | "format";
+export type PhoneFieldValidateType = BaseFieldValidateType;
 export type PhoneFieldContent = BaseFieldContent;
 export type PhoneFieldProps = Omit<BaseFieldProps, "content"> & {
     content: PhoneFieldContent;
 };
+export type UsernameFieldValidateType = BaseFieldValidateType | "minlength" | "maxlength";
+export type UsernameFieldContent = BaseFieldContent;
+export type UsernameFieldProps = Omit<BaseFieldProps, "content"> & {
+    content: UsernameFieldContent;
+    minlength?: number;
+    maxlength?: number;
+    pattern?: string;
+    minlengthError?: string;
+    maxlengthError?: string;
+};
 export {};

package/dist/components/renderers/_updated/field/index.d.ts

@@ -1,9 +1,11 @@
 import { SbEmailField } from './_email-field';
 import { SbPhoneField } from './_phone-field';
-export { SbEmailField, SbPhoneField };
+import { SbUsernameField } from './_username-field';
+export { SbEmailField, SbPhoneField, SbUsernameField };
 declare global {
     interface HTMLElementTagNameMap {
         "sb-email-field": SbEmailField;
         "sb-phone-field": SbPhoneField;
+        "sb-username-field": SbUsernameField;
     }
 }