vira 28.19.4 → 28.19.6

package/dist/elements/shared-text-input-logic.d.ts

@@ -1,63 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type AttributeValues } from 'element-vir';
-/**
- * Inputs shared between the multiple input elements.
- *
- * @category Internal
- */
-export type SharedTextInputElementInputs = {
-    value: string;
-} & PartialWithUndefined<{
-    /** Shown when no other text is present. Input restrictions do not apply to this property. */
-    placeholder: string;
-    /** Set to true to trigger disabled styles and to block all user input. */
-    disabled: boolean;
-    /**
-     * Only letters in the given string or matches to the given RegExp will be allowed.
-     * blockedInputs takes precedence over this input.
-     *
-     * For example: if allowedInputs is set to "abcd" and blockedInputs is set to "d", only "a",
-     * "b", or "c" letters will be allowed.
-     */
-    allowedInputs: string | RegExp;
-    /** Any letters in the given string or matches to the given RegExp will be blocked. */
-    blockedInputs: string | RegExp;
-    /** Disable all browser helps like spellchecking, autocomplete, etc. */
-    disableBrowserHelps: boolean;
-    /** Set this to true to make the whole element size to only fit the input text. */
-    fitText: boolean;
-    /** A set of attributes that will be applied to the inner native text element. */
-    attributePassthrough: AttributeValues;
-}>;
-/**
- * Inputs used to check if the current input element value is allowed.
- *
- * @category Internal
- */
-export type IsAllowedInputs = {
-    value: string;
-    allowed: string | RegExp | undefined;
-    blocked: string | RegExp | undefined;
-};
-/**
- * Filters out blocked text from an input element's value.
- *
- * @category Internal
- */
-export declare function filterTextInputValue(inputs: IsAllowedInputs): {
-    filtered: string;
-    blocked: string;
-};
-/**
- * A function to be called when an input element's value changes.
- *
- * @category Internal
- */
-export declare function textInputListener({ inputs, previousValue, event, inputBlockedCallback, newValueCallback, }: {
-    inputs: SharedTextInputElementInputs;
-    /** The value of the input element before this listener fired. */
-    previousValue: string;
-    event: Event;
-    inputBlockedCallback: (blockedInput: string) => void;
-    newValueCallback: (newValue: string) => void;
-}): void;

package/dist/elements/shared-text-input-logic.js

@@ -1,101 +0,0 @@
-import { check, checkWrap } from '@augment-vir/assert';
-import { extractEventTarget } from '@augment-vir/web';
-function doesMatch({ input, matcher }) {
-    if (!input || !matcher) {
-        return true;
-    }
-    if (input.length > 1) {
-        return input.split('').every((singleInput) => doesMatch({ input: singleInput, matcher }));
-    }
-    if (matcher instanceof RegExp) {
-        return !!input.match(matcher);
-    }
-    else {
-        return matcher.includes(input);
-    }
-}
-function isAllowed({ value, allowed, blocked }) {
-    const isAllowedCharacter = allowed
-        ? doesMatch({
-            input: value,
-            matcher: allowed,
-        })
-        : true;
-    const isBlockedCharacter = blocked
-        ? doesMatch({
-            input: value,
-            matcher: blocked,
-        })
-        : false;
-    return isAllowedCharacter && !isBlockedCharacter;
-}
-/**
- * Filters out blocked text from an input element's value.
- *
- * @category Internal
- */
-export function filterTextInputValue(inputs) {
-    if (!inputs.value) {
-        return { filtered: inputs.value, blocked: '' };
-    }
-    const { filtered, blocked } = inputs.value.split('').reduce((accum, letter) => {
-        const allowed = isAllowed({ ...inputs, value: letter });
-        if (allowed) {
-            accum.filtered.push(letter);
-        }
-        else {
-            accum.blocked.push(letter);
-        }
-        return accum;
-    }, {
-        filtered: [],
-        blocked: [],
-    });
-    return {
-        filtered: filtered.join(''),
-        blocked: blocked.join(''),
-    };
-}
-/**
- * A function to be called when an input element's value changes.
- *
- * @category Internal
- */
-export function textInputListener({ inputs, previousValue, event, inputBlockedCallback, newValueCallback, }) {
-    const inputElement = extractEventTarget(event, HTMLInputElement);
-    /**
-     * This is usually a single character, but can be a bunch of characters in some circumstances.
-     * For example, when a bunch of characters are pasted, this will be the entire pasted contents.
-     *
-     * When a password manager auto fills the password, at least for Safari + iCloud Keychain, it'll
-     * fire a `CustomEvent` (rather than the typical `InputEvent`) and `event.data` won't be
-     * populated.
-     */
-    const changedText = (check.hasKey(event, 'data') && checkWrap.isString(event.data)) || '';
-    /**
-     * When changedText is falsy, that means an operation other than inserting characters happened.
-     * Such as: deleting, cutting the text, etc.
-     */
-    if (changedText) {
-        const { blocked } = filterTextInputValue({
-            value: changedText,
-            allowed: inputs.allowedInputs,
-            blocked: inputs.blockedInputs,
-        });
-        if (blocked.length) {
-            inputBlockedCallback(blocked);
-        }
-    }
-    const finalValue = filterTextInputValue({
-        value: inputElement.value,
-        allowed: inputs.allowedInputs,
-        blocked: inputs.blockedInputs,
-    }).filtered;
-    if (inputElement.value !== finalValue) {
-        // this prevents blocked inputs by simply overwriting them
-        inputElement.value = finalValue;
-    }
-    if (previousValue !== finalValue) {
-        newValueCallback(finalValue);
-    }
-}

package/dist/elements/vira-bold-text.element.d.ts

@@ -1,9 +0,0 @@
-/**
- * Use this element to reserve space for bolded text, even if it isn't bold yet.
- *
- * @category Elements
- */
-export declare const ViraBoldText: import("element-vir").DeclarativeElementDefinition<"vira-bold", {
-    bold: boolean;
-    text: string;
-}, {}, {}, "vira-bold-bold", "vira-bold-bold-weight", readonly [], readonly []>;

package/dist/elements/vira-button.element.d.ts

@@ -1,31 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type ViraIconSvg } from '../icons/index.js';
-/**
- * Button styles available for {@link ViraButton}.
- *
- * @category Button
- */
-export declare enum ViraButtonStyle {
-    Default = "vira-button-default",
-    Outline = "vira-button-outline"
-}
-/**
- * A custom button with default styling.
- *
- * @category Button
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-button
- */
-export declare const ViraButton: import("element-vir").DeclarativeElementDefinition<"vira-button", PartialWithUndefined<{
-    text: string;
-    icon: Pick<ViraIconSvg, "svgTemplate">;
-    disabled: boolean;
-    buttonStyle: ViraButtonStyle;
-    /**
-     * When set to `true`, the given icon (if any) will take up its full dimensions, potentially
-     * increasing the button's size.
-     *
-     * @default false
-     */
-    expandToFitIcon: boolean;
-}>, {}, {}, "vira-button-outline-style" | "vira-button-disabled" | "vira-button-expand-to-fit-icon", "vira-button-primary-color" | "vira-button-primary-hover-color" | "vira-button-primary-active-color" | "vira-button-secondary-color" | "vira-button-padding" | "vira-button-internal-foreground-color" | "vira-button-internal-background-color", readonly [], readonly []>;

package/dist/elements/vira-card.element.d.ts

@@ -1,18 +0,0 @@
-/**
- * State options for {@link ViraCard}.
- *
- * @category Internal
- */
-export declare enum ViraCardState {
-    Error = "error",
-    Success = "success"
-}
-/**
- * A simple wrapper "card" element that is just a `<slot>` with some styles.
- *
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-card
- */
-export declare const ViraCard: import("element-vir").DeclarativeElementDefinition<"vira-card", {
-    cardState?: ViraCardState | undefined;
-}, {}, {}, "vira-card-error" | "vira-card-success", "vira-card-border" | "vira-card-border-radius" | "vira-card-padding", readonly [], readonly []>;

package/dist/elements/vira-checkbox.element.d.ts

@@ -1,34 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type AttributeValues, type CSSResult } from 'element-vir';
-import { ViraIcon } from './vira-icon.element.js';
-/**
- * All inner elements supported by {@link ViraCheckbox}.
- *
- * @category Internals
- */
-export type ViraCheckboxInnerElements = 'label' | 'custom-checkbox' | 'text' | typeof ViraIcon.tagName;
-/**
- * Inputs for {@link ViraCheckbox}.
- *
- * @category Internal
- */
-export type ViraCheckboxInputs = PartialWithUndefined<{
-    stylePassthrough: Partial<Record<ViraCheckboxInnerElements, CSSResult>>;
-    attributePassthrough: Partial<Record<ViraCheckboxInnerElements, AttributeValues>>;
-    disabled: boolean;
-    label: string;
-    hasError: boolean;
-    horizontal: boolean;
-}> & {
-    value: boolean;
-};
-/**
- * A custom checkbox.
- *
- * @category Input
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-checkbox
- */
-export declare const ViraCheckbox: import("element-vir").DeclarativeElementDefinition<"vira-checkbox", Readonly<ViraCheckboxInputs>, {}, {
-    valueChange: import("element-vir").DefineEvent<boolean>;
-}, "vira-checkbox-horizontal", "vira-checkbox-", readonly [], readonly []>;

package/dist/elements/vira-collapsible-wrapper.element.d.ts

@@ -1,14 +0,0 @@
-/**
- * A wrapper element that can collapse and expand to fit its content dynamically and efficiently.
- *
- * @category Collapsible
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-collapsible-wrapper
- */
-export declare const ViraCollapsibleWrapper: import("element-vir").DeclarativeElementDefinition<"vira-collapsible-wrapper", {
-    expanded: boolean;
-}, {
-    contentHeight: number;
-}, {
-    expandChange: import("element-vir").DefineEvent<boolean>;
-}, "vira-collapsible-wrapper-expanded", "vira-collapsible-wrapper-", readonly ["header"], readonly []>;

package/dist/elements/vira-dropdown.element.d.ts

@@ -1,46 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type ViraIconSvg } from '../icons/icon-svg.js';
-import { type ShowPopUpResult } from '../util/pop-up-manager.js';
-import { type MenuItem } from './pop-up/pop-up-menu-item.js';
-import { type PopUpTriggerPosition } from './pop-up/vira-pop-up-trigger.element.js';
-/**
- * Test ids for {@link ViraDropdown}.
- *
- * @category Internal
- */
-export declare const viraDropdownTestIds: {
-    trigger: string;
-    icon: string;
-    prefix: string;
-};
-/**
- * A dropdown element that uses pop-up menus.
- *
- * @category Dropdown
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/dropdown/vira-dropdown
- */
-export declare const ViraDropdown: import("element-vir").DeclarativeElementDefinition<"vira-dropdown", {
-    options: ReadonlyArray<Readonly<MenuItem>>;
-    /** The selected id from the given options. */
-    selected: ReadonlyArray<PropertyKey>;
-} & PartialWithUndefined<{
-    /** Text to show if nothing is selected. */
-    placeholder: string;
-    /**
-     * If false, this will behave like a single select dropdown, otherwise you can select
-     * multiple.
-     */
-    isMultiSelect: boolean;
-    icon: ViraIconSvg;
-    selectionPrefix: string;
-    isDisabled: boolean;
-    /** For debugging purposes only. Very bad for actual production code use. */
-    z_debug_forceOpenState: boolean;
-} & PopUpTriggerPosition>, {
-    /** `undefined` means the pop up is not currently showing. */
-    showPopUpResult: ShowPopUpResult | undefined;
-}, {
-    selectedChange: import("element-vir").DefineEvent<PropertyKey[]>;
-    openChange: import("element-vir").DefineEvent<ShowPopUpResult | undefined>;
-}, "vira-dropdown-", "vira-dropdown-", readonly [], readonly []>;

package/dist/elements/vira-error.element.d.ts

@@ -1,7 +0,0 @@
-/**
- * An error wrapper that applies error coloring (red, by default).
- *
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-error
- */
-export declare const ViraError: import("element-vir").DeclarativeElementDefinition<"vira-error", {}, {}, {}, "vira-error-", "vira-error-font-weight", readonly [], readonly []>;

package/dist/elements/vira-icon.element.d.ts

@@ -1,13 +0,0 @@
-import { type ViraIconSvg } from '../icons/icon-svg.js';
-/**
- * An element that renders a single {@link ViraIconSvg}.
- *
- * @category Icon
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-icon
- */
-export declare const ViraIcon: import("element-vir").DeclarativeElementDefinition<"vira-icon", {
-    icon: Pick<ViraIconSvg, "svgTemplate"> | undefined;
-    /** Ignores the given icon's embedded size and causes the <svg> element to fill its parent. */
-    fitContainer?: boolean | undefined;
-}, {}, {}, "vira-icon-fit-container", "vira-icon-", readonly [], readonly []>;

package/dist/elements/vira-image.element.d.ts

@@ -1,45 +0,0 @@
-import { type Dimensions } from '@augment-vir/common';
-import { type Duration, type DurationUnit } from 'date-vir';
-/**
- * An `<img>` element wrapper that handles size constraints and includes slots for loading and error
- * indicators.
- *
- * Use CSS properties to constrain the image. In particular, set `min-height` and `min-width` on
- * this to control the size of the loader and error slots.
- *
- * @category Image
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-image
- */
-export declare const ViraImage: import("element-vir").DeclarativeElementDefinition<"vira-image", {
-    /** The URL of the image to load. This is passed directly to the `<img>` element. */
-    imageUrl: string;
-    /**
-     * The dimension which should dominantly constrain the image size. Whichever dimension this is
-     * set to is the dimension that the image will grow to match. This is only relevant if you apply
-     * size constraints on ViraImage via CSS in its parent.
-     *
-     * @default 'width'
-     */
-    dominantDimension?: keyof Dimensions | undefined;
-    /** For debugging only: artificially set a delay for the image loading so you can see the loader. */
-    _debugLoadDelay?: Duration<DurationUnit.Milliseconds> | undefined;
-}, {
-    /**
-     * To avoid race conditions between `<img>` element events and potential input changing,
-     * save the loaded state of an URL's image by the image's URL.
-     */
-    loadedUrls: Readonly<{
-        [url: string]: true;
-    }>;
-    /**
-     * To avoid race conditions between `<img>` element events and potential input changing,
-     * save the errored state of an URL's image by the image's URL.
-     */
-    erroredUrls: Readonly<{
-        [url: string]: true;
-    }>;
-}, {
-    imageLoad: import("element-vir").DefineEvent<void>;
-    imageError: import("element-vir").DefineEvent<unknown>;
-}, "vira-image-height-constrained", "vira-image-", readonly ["loading", "error"], readonly []>;

package/dist/elements/vira-input.element.d.ts

@@ -1,62 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type ViraIconSvg } from '../icons/index.js';
-export * from './shared-text-input-logic.js';
-/**
- * Input types for {@link ViraInput}.
- *
- * @category Internal
- */
-export declare enum ViraInputType {
-    Default = "text",
-    Password = "password",
-    Email = "email"
-}
-/**
- * A single line input element with all listeners properly attached. Multiple types are allowed with
- * {@link ViraInputType}.
- *
- * @category Input
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-input
- */
-export declare const ViraInput: import("element-vir").DeclarativeElementDefinition<"vira-input", Readonly<PartialWithUndefined<{
-    icon: Pick<ViraIconSvg, "svgTemplate">;
-    /** A suffix that, if provided, is shown following the input field. */
-    suffix: string;
-    /** A label that is shown above the input, if provided. */
-    label: string;
-    /** If true, applies error styling. */
-    hasError: boolean;
-    showClearButton: boolean;
-    type: ViraInputType;
-}> & {
-    value: string;
-} & PartialWithUndefined<{
-    placeholder: string;
-    disabled: boolean;
-    allowedInputs: string | RegExp;
-    blockedInputs: string | RegExp;
-    disableBrowserHelps: boolean;
-    fitText: boolean;
-    attributePassthrough: import("element-vir").AttributeValues;
-}>>, {
-    forcedInputWidth: number;
-    showPassword: boolean;
-    /**
-     * Used to couple the label and input together. This is not applied if no label is
-     * provided.
-     */
-    randomId: string;
-}, {
-    /**
-     * Fires whenever a user input created a new value. Does not fire if all input letters are
-     * filtered out due to input restrictions.
-     */
-    valueChange: import("element-vir").DefineEvent<string>;
-    /**
-     * Fires when inputs are blocked. Useful for showing warnings or error messages to inform
-     * the user why their input did not propagate if it was blocked. This does not fire for text
-     * that was blocked out of programmatic "value" property assignments.
-     */
-    inputBlocked: import("element-vir").DefineEvent<string>;
-}, "vira-input-disabled" | "vira-input-fit-text" | "vira-input-clear-button-shown" | "vira-input-error", "vira-input-action-button-color" | "vira-input-clear-button-hover-color" | "vira-input-clear-button-active-color" | "vira-input-show-password-button-hover-color" | "vira-input-show-password-button-active-color" | "vira-input-padding-horizontal" | "vira-input-padding-vertical", readonly [], readonly []>;

package/dist/elements/vira-link.element.d.ts

@@ -1,73 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-import { type AttributeValues, type CSSResult } from 'element-vir';
-import { type SpaRoute, type SpaRouter } from 'spa-router-vir';
-/**
- * The route properties required for using {@link ViraLink} with a route.
- *
- * @category Internal
- */
-export type ViraLinkRoute = Readonly<{
-    route: SpaRoute<any, any, any>;
-    router: Pick<SpaRouter<any, any, any>, 'createRouteUrl' | 'setRouteOnDirectNavigation'>;
-    scrollToTop?: boolean;
-}>;
-/**
- * A hyperlink wrapper element that can be configured to emit route change events rather than just
- * being a raw link.
- *
- * @category Link
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-link
- */
-export declare const ViraLink: import("element-vir").DeclarativeElementDefinition<"vira-link", (((Required<Pick<{
-    /**
-     * A full raw URL link that will navigate the current window away or open a new tab. If this
-     * property is provided for the inputs, don't provide a route property.
-     */
-    link: {
-        url: string;
-        newTab: boolean;
-    };
-    /**
-     * A route that'll change that current page without navigating the window. If this property
-     * is provided for the inputs, don't provide a link property.
-     */
-    route: ViraLinkRoute;
-}, "link">> & Partial<Record<"route", never>>) | (Required<Pick<{
-    /**
-     * A full raw URL link that will navigate the current window away or open a new tab. If this
-     * property is provided for the inputs, don't provide a route property.
-     */
-    link: {
-        url: string;
-        newTab: boolean;
-    };
-    /**
-     * A route that'll change that current page without navigating the window. If this property
-     * is provided for the inputs, don't provide a link property.
-     */
-    route: ViraLinkRoute;
-}, "route">> & Partial<Record<"link", never>>)) & Omit<{
-    /**
-     * A full raw URL link that will navigate the current window away or open a new tab. If this
-     * property is provided for the inputs, don't provide a route property.
-     */
-    link: {
-        url: string;
-        newTab: boolean;
-    };
-    /**
-     * A route that'll change that current page without navigating the window. If this property
-     * is provided for the inputs, don't provide a link property.
-     */
-    route: ViraLinkRoute;
-}, "link" | "route">) & PartialWithUndefined<{
-    /** Styles that will be applied directly to the inner elements. */
-    stylePassthrough: Readonly<PartialWithUndefined<{
-        a: CSSResult;
-    }>>;
-    /** Attributes that will be applied directly to the inner elements. */
-    attributePassthrough: Readonly<PartialWithUndefined<{
-        a: AttributeValues;
-    }>>;
-}>, {}, {}, "vira-link-", "vira-link-hover-color", readonly [], readonly []>;

package/dist/elements/vira-modal.element.d.ts

@@ -1,39 +0,0 @@
-import { type PartialWithUndefined } from '@augment-vir/common';
-/**
- * A modal element that uses the built-in `dialog` element.
- *
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-modal
- */
-export declare const ViraModal: import("element-vir").DeclarativeElementDefinition<"vira-modal", Readonly<{
-    open: boolean;
-} & PartialWithUndefined<{
-    /** If this isn't set, make sure to use the modal title slot to fill it in. */
-    modalTitle: string;
-    /**
-     * If `true`, the following conditions trigger the modal to close:
-     *
-     * - The user clicks the "x" close button
-     * - The `open` input is set to `false`
-     *
-     * If set to `false` (the default), the following conditions trigger the modal to close:
-     *
-     * - The user clicks outside of the modal
-     * - The user presses the "Escape" key
-     * - The user clicks the "x" close button
-     * - The `open` input is set to `false`
-     *
-     * @default false
-     */
-    blockLightDismissal: boolean;
-    modalSubtitle: string;
-    isMobileSize: boolean;
-}>>, {
-    dialogElement: HTMLDialogElement | undefined;
-    contentElement: HTMLDivElement | undefined;
-    previousOpenValue: undefined | boolean;
-    /** Remove listeners. */
-    cleanup: undefined | (() => void);
-}, {
-    modalClose: import("element-vir").DefineEvent<void>;
-}, "vira-modal-phone-size", "vira-modal-backdrop-color" | "vira-modal-backdrop-filter" | "vira-modal-subtitle-color" | "vira-modal-close-button-hover-radius" | "vira-modal-close-button-hover-background-color", readonly ["modalTitle"], readonly []>;

package/dist/elements/vira-overflow-switch.element.d.ts

@@ -1,21 +0,0 @@
-/**
- * An element switches between two slots based on their overflow.
- *
- * @category Elements
- * @see https://electrovir.github.io/vira/book/elements/vira-overflow-switch
- */
-export declare const ViraOverflowSwitch: import("element-vir").DeclarativeElementDefinition<"vira-overflow-switch", Readonly<((Required<Pick<{
-    automaticallySwitch: boolean;
-    useSmall: boolean;
-}, "automaticallySwitch">> & Partial<Record<"useSmall", never>>) | (Required<Pick<{
-    automaticallySwitch: boolean;
-    useSmall: boolean;
-}, "useSmall">> & Partial<Record<"automaticallySwitch", never>>)) & Omit<{
-    automaticallySwitch: boolean;
-    useSmall: boolean;
-}, "automaticallySwitch" | "useSmall">>, {
-    isOverflowing: boolean;
-    resizeObserver: undefined | ResizeObserver;
-    /** Called on cleanup to clear all listeners. */
-    cleanup: undefined | (() => void);
-}, {}, "vira-overflow-switch-show-small", "vira-overflow-switch-", readonly ["large", "small"], readonly []>;