@dynamic-framework/ui-react 2.9.0 → 2.10.0

package/dist/types/components/DButtonIcon/warnMissingAccessibleName.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Warns, once per icon and only outside production builds, that an icon-only
+ * button has no accessible name.
+ *
+ * The control has no text to fall back on and its icon is hidden from the
+ * accessibility tree, so the name has to be given explicitly. `aria-label` is
+ * the direct way; on a button `aria-labelledby` and `title` count too, since
+ * `rest` reaches the DOM there, while an anchor drops them — hence `kind`, so
+ * the advice matches what the element can actually receive.
+ *
+ * A legacy icon-font icon used to leak its ligature as the name by accident —
+ * never a good one, being unlocalised and often meaningless ("more_vert") — and
+ * no longer does, so the omission is now visible instead of silent.
+ *
+ * The `process.env.NODE_ENV` guard is what bundlers constant-fold, so the whole
+ * call — and this module — drops out of a consumer's production bundle.
+ */
+export default function warnMissingAccessibleName(icon: string, kind: 'button' | 'link'): void;

package/dist/types/components/DIcon/DIcon.d.ts

@@ -1,5 +1,13 @@
 /// <reference types="react" />
 import type { DIconBaseProps } from '../DIconBase';
 type Props = DIconBaseProps;
+/**
+ * Thin wrapper over `DIconBase` that fills the icon-font configuration
+ * (`familyClass`, `familyPrefix`, `materialStyle`) from `DContextProvider`
+ * whenever the caller does not pass it explicitly.
+ *
+ * Name resolution itself — registry, then lucide-react, then the icon-font
+ * family — lives in `DIconBase`, so both components behave identically.
+ */
 export default function DIcon({ icon, familyClass: propFamilyClass, familyPrefix: propFamilyPrefix, materialStyle: propMaterialStyle, ...props }: Props): import("react").JSX.Element;
 export {};

package/dist/types/components/DIconBase/DIconBase.d.ts

@@ -17,7 +17,49 @@ type Props = BaseProps & {
     familyClass?: string;
     familyPrefix?: string;
     strokeWidth?: number;
+    /**
+     * Hides the icon from the accessibility tree. Defaults to `true`, because
+     * an icon is almost always decorative: it sits next to a visible label, or
+     * inside a control that already carries its own accessible name.
+     *
+     * Pass `ariaLabel` instead when the icon itself is the only carrier of
+     * meaning. `ariaHidden` wins over `ariaLabel`, since hiding is absolute;
+     * `ariaHidden={false}` alongside an `ariaLabel` is not a conflict, as both
+     * expose the icon and the name is kept. Setting `ariaHidden={false}` on its
+     * own exposes an unnamed graphic and warns outside production builds.
+     *
+     * It is forwarded to the icon so a hidden `<svg>` follows the wrapper, but a
+     * registry component that hardcodes its own `aria-hidden` rather than
+     * spreading the props it receives stays hidden regardless.
+     */
+    ariaHidden?: boolean;
+    /**
+     * Accessible name for an icon that carries meaning on its own. Renders
+     * `role="img"` alongside it and drops the default `aria-hidden`.
+     */
+    ariaLabel?: string;
 };
 export type DIconBaseProps = Props;
-export default function DIconBase({ icon, color, style, className, size, useListenerSize, hasCircle, materialStyle, familyClass, familyPrefix, strokeWidth, dataAttributes, }: Props): import("react").JSX.Element;
+/**
+ * Renders an icon, resolving the `icon` prop in this order:
+ *
+ * 1. **Icon registry** — a string name found in `DContextProvider`'s
+ *    `iconRegistry` renders the component registered under it. A component
+ *    passed directly skips this step and renders as-is.
+ * 2. **lucide-react** — a PascalCase name exported by lucide-react renders that
+ *    icon. When `materialStyle` is on, this step is skipped and the name is
+ *    emitted as the text content of the icon-font element instead.
+ * 3. **Icon-font family** — anything left over renders as
+ *    `<i class="{familyClass} {familyPrefix}{name}">`, the legacy path for
+ *    Material Symbols and Bootstrap Icons. Outside production builds, a name
+ *    that reaches this step while the family is still the package default logs
+ *    a one-time warning.
+ *
+ * A name that resolves nowhere and has no family configured renders `?`.
+ *
+ * Every path is hidden from the accessibility tree by default (`aria-hidden`),
+ * since icons are overwhelmingly decorative. See `ariaHidden` / `ariaLabel` to
+ * override that for an icon that carries meaning on its own.
+ */
+export default function DIconBase({ icon: iconProp, color, style, className, size, useListenerSize, hasCircle, materialStyle, familyClass, familyPrefix, strokeWidth, ariaHidden, ariaLabel, dataAttributes, }: Props): import("react").JSX.Element;
 export {};

package/dist/types/components/DIconBase/resolveIconFromRegistry.d.ts

@@ -0,0 +1,14 @@
+import type { IconComponent, IconValue } from '../interface';
+/**
+ * Resolves a string icon name against the registry supplied through
+ * `DContextProvider`'s `iconRegistry` prop.
+ *
+ * This is the single implementation shared by `DIcon` and `DIconBase`, so both
+ * public entry points — and every Dynamic UI component that renders an icon
+ * through them — resolve names identically.
+ *
+ * A non-string `icon` is returned untouched: a component passed directly needs
+ * no lookup. A name missing from the registry is also returned untouched, so
+ * the caller can fall through to lucide-react and then to the icon-font family.
+ */
+export default function resolveIconFromRegistry(icon: IconValue, iconRegistry?: Record<string, IconComponent>): IconValue;

package/dist/types/components/DIconBase/warnUnknownIcon.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Warns, once per name and only outside production builds, that an icon name
+ * resolved to neither the registry nor lucide-react and is falling back to the
+ * default icon font, which this package no longer ships.
+ *
+ * Whether that fallback renders depends on the host app: if it loads the font
+ * itself the `<i>` shows the glyph, and if it does not, nothing appears. The
+ * message states both possibilities instead of assuming the second.
+ *
+ * The `process.env.NODE_ENV` guard is what bundlers constant-fold, so the whole
+ * call — and this module — drops out of a consumer's production bundle.
+ */
+export default function warnUnknownIcon(name: string, familyClass: string, familyPrefix: string): void;

package/dist/types/components/DInputRange/DInputRange.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import type { BaseProps } from '../interface';
-declare const ForwardedDInputRange: import("react").ForwardRefExoticComponent<Omit<Omit<Omit<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "type">, "label" | keyof BaseProps | "ariaLabel" | "filledValue"> & BaseProps & {
+declare const ForwardedDInputRange: import("react").ForwardRefExoticComponent<Omit<Omit<Omit<import("react").DetailedHTMLProps<import("react").InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "type">, "label" | "ariaLabel" | keyof BaseProps | "filledValue"> & BaseProps & {
     label?: string | undefined;
     ariaLabel?: string | undefined;
     filledValue?: boolean | undefined;

package/dist/types/components/config.d.ts

@@ -1 +1,11 @@
 export declare const PREFIX_BS = "bs-";
+/**
+ * Default icon-font family configured by `DContextProvider`.
+ *
+ * `DIconBase` compares the family it receives against these values to tell an
+ * unconfigured consumer apart from one that deliberately opted into an icon
+ * font (Material Symbols, Bootstrap Icons). Only the former gets the
+ * development warning for an unresolved icon name.
+ */
+export declare const DEFAULT_ICON_FAMILY_CLASS = "bi";
+export declare const DEFAULT_ICON_FAMILY_PREFIX = "bi-";

package/dist/types/icons/coreIcons.d.ts

@@ -0,0 +1,24 @@
+/**
+ * The lucide-react icons Dynamic UI renders on its own, without the consumer
+ * asking for them by name.
+ *
+ * Two sources feed this list:
+ *
+ * - The `iconMap` defaults of `DContextProvider` (`src/contexts/DContext.tsx`),
+ *   used by close buttons, chevrons, alert states, input adornments and the
+ *   stepper checkmark.
+ * - Names hard-coded in component JSX or in a prop default, such as
+ *   `DDropdown`'s toggle or `DVoucher`'s action buttons.
+ *
+ * Any bundler-level optimisation that narrows lucide-react down to the icons a
+ * widget actually uses must keep this set, or Dynamic UI components break for
+ * reasons the widget author cannot see in their own source. That is why the
+ * list ships in the package as `dist/icons-core.json` and is exported here.
+ *
+ * `src/icons/coreIcons.spec.ts` scans `src/components/**` and fails when an
+ * internally used icon name is missing from this list or absent from
+ * lucide-react, so the two cannot drift apart.
+ */
+export declare const CORE_LUCIDE_ICONS: readonly ["AlertCircle", "AlertTriangle", "Calendar", "Check", "CheckCircle", "ChevronDown", "ChevronLeft", "ChevronRight", "ChevronUp", "Eye", "EyeOff", "Info", "Minus", "Plus", "Search", "Upload", "X", "Circle", "CircleCheck", "CircleCheckBig", "Download", "FileText", "MoreVertical", "Paperclip", "RefreshCw", "Share2", "Trash"];
+/** A name from {@link CORE_LUCIDE_ICONS}. */
+export type CoreLucideIcon = typeof CORE_LUCIDE_ICONS[number];

package/dist/types/icons/index.d.ts

@@ -0,0 +1,2 @@
+export { CORE_LUCIDE_ICONS } from './coreIcons';
+export type { CoreLucideIcon } from './coreIcons';

package/dist/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './components';
 export * from './contexts';
 export * from './utils';
 export * from './hooks';
+export * from './icons';

package/package.json

@@ -3,7 +3,7 @@
   "sideEffects": [
     "*.css"
   ],
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "React Dynamic Framework",
   "license": "https://github.com/dynamic-framework/dynamic-ui/blob/master/LICENSE.md",
   "repository": {
@@ -45,10 +45,11 @@
     "test:coverage": "jest --testPathPatterns=\\.spec\\.tsx?$ --coverage",
     "test:a11y": "jest --testPathPatterns=\\.a11y\\.test\\.tsx$",
     "test:storybook": "test-storybook",
-    "build": "npm run clean && npm run build:react && npm run build:scss && npm run cp",
+    "build": "npm run clean && npm run build:react && npm run build:scss && npm run build:icons-core && npm run cp",
     "build:react": "tsc -p ./tsconfig.build.json && rollup -c rollup.config.mjs",
     "build:react:watch": "tsc -p ./tsconfig.build.json && rollup -c rollup.config.mjs",
     "build:scss": "node scripts/build-scss.js",
+    "build:icons-core": "npx tsx scripts/build-icons-core.ts",
     "build:scss:watch": "npx nodemon --watch src --ext scss --exec 'npm run build:scss'",
     "dev:ts": "tsc -p tsconfig.build.json",
     "dev:rollup": "rollup -c rollup.config.mjs",
@@ -88,7 +89,7 @@
     "node": ">=22.0.0"
   },
   "main": "./dist/index.js",
-  "module": "./dist/index.esm.js",
+  "module": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "files": [
     "dist/",
@@ -107,7 +108,6 @@
     "file-selector": "~2.1.2",
     "google-libphonenumber": "~3.2.43",
     "html2canvas": "^1.4.1",
-    "jspdf": "^4.0.0",
     "lucide-react": "^0.553.0",
     "react-datepicker": "~8.3.0",
     "react-error-boundary": "^6.1.0",

package/dist/types/components/DVoucher/hooks/useScreenshotDownload.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/components/DVoucher/hooks/useScreenshotWebShare.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useCountdown.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useDisableBodyScrollEffect.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useDisableInputWheel.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useFormatCurrency.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useInputCurrency.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useItemSelection.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useMediaBreakpointUp.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useMediaQuery.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/usePortal.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useProvidedRefOrCreate.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/hooks/tests/useStackState.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/attr-accept.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/buildUrl.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/changeQueryString.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/configureI18n.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/formatCurrency.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/getCssVariable.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/getKeyboardFocusableElements.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/getQueryString.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/mediaQuery.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/sanitizeHref.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/utils/tests/validatePhoneNumber.spec.d.ts

@@ -1 +0,0 @@
-export {};