@massimo-cassandro/minimo 1.20.1 → 1.20.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@massimo-cassandro/minimo",
-  "version": "1.20.1",
+  "version": "1.20.2",
   "description": "Light css framework & utilities",
   "type": "module",
   "main": "./index.js",

package/src/components/modal-alert/modal-alert.js

@@ -130,7 +130,32 @@ const defaults = {
  * `ok_btn_class`, `cancel_btn_text`, `cancel_btn_class`, `cancel_focus`, `use_warning_icon`)
  * are still accepted and internally mapped to their camelCase equivalent, see `legacyParamNames`.
  *
- * @param {ModalAlertParams} params - Dialog parameters (merged with defaults by type).
+ * The base param type below is intentionally `object` (not `ModalAlertParams`): TypeScript only
+ * expands dotted `@param` properties (needed for editor IntelliSense to list each property) when
+ * the base type is the literal `object`; a named typedef there would error (TS8032).
+ * @param {object} [params] - Dialog parameters (merged with defaults by type).
+ * @param {string} [params.type] - Dialog type: `success`, `error`, `warning`, `info`, or `confirm`.
+ * @param {string | null} [params.extraClass] - optional dialog extra class
+ * @param {(() => void) | null} [params.onOpen] - optional callback on dialog open
+ * @param {(() => void) | null} [params.onClose] - optional callback on dialog close
+ * @param {boolean} [params.animation] - if true, dialog will be animated
+ * @param {boolean} [params.showMarks] - if true, mark icons will be showed
+ * @param {((arg?: *) => void) | null} [params.callback] - optional callback dialog after user choice
+ * @param {number | null} [params.timer] - timer for autoclose (ms). `null` for disable
+ * @param {string | null} [params.title] - title text
+ * @param {string | null} [params.mes] - text message (plain or html)
+ * @param {string | null} [params.headingClass] - optional extra class for heading
+ * @param {string | null} [params.textClass] - optional extra class for text
+ * @param {string | null} [params.icon] - Icon markup used for the dialog; defaults to the type's icon.
+ * @param {string | null} [params.altIcon] - Alternate icon markup, used instead of `icon` when `useAltIcon` is `true`.
+ * @param {boolean} [params.useAltIcon] - When `true`, uses `altIcon` instead of `icon` (e.g. the `danger` icon on a `warning` dialog, or the `warning` icon on a `confirm` dialog).
+ * @param {DomBuilderItem | null} [params.extraBtn] - optional extra button (as domBuilder object)
+ * @param {boolean} [params.extraBtnFocus] - true if the extra button should be focused when the dialog box opens (overrides any focus assigned to the 'cancel' button)
+ * @param {string} [params.okBtnText] - text for 'ok' button
+ * @param {string} [params.okBtnClass] - alternative class for 'ok' button. It replaces the default one
+ * @param {string} [params.cancelBtnText] - text for 'cancel' button
+ * @param {string} [params.cancelBtnClass] - alternative class for 'cancel' button. It replaces the default one
+ * @param {boolean} [params.cancelBtnFocus] - true if the cancel button should be focused when the dialog box opens. It has no effect if an extraBtn is set
  * @returns {Promise<string | boolean | undefined>} Resolves when the dialog closes. If the
  *   dismissing button has a `data-malert-result` attribute, that string is used; otherwise, for
  *   `confirm` dialogs, resolves `true`/`false` for the OK/Cancel button; otherwise `undefined`.

package/src/components/slide-up-down-toggle/slide-up-down-toggle.js

@@ -55,6 +55,11 @@ import * as styles from './slide-up-down-toggle.module.css';
  *                                               if omitted the CSS value is used
  *   callback {() => void|null}  default null  — invoked after the transition ends
  *
+ * Kept here for reference: the three exported functions below re-declare these same properties
+ * as dotted `@param` entries with base type `object` instead of `SlideOptions`, since TypeScript
+ * only expands dotted `@param` properties (needed for editor IntelliSense to list each property)
+ * when the base type is the literal `object`; a named typedef there would error (TS8032).
+ *
  * ─── Return value ─────────────────────────────────────────────────────────────
  *
  * All three functions return a Promise<void> that resolves when the transition ends.
@@ -194,7 +199,10 @@ export function disposeSliding(target) {
  * CSS animates height to 0, then snaps display to none.
  *
  * @param {HTMLElement} target
- * @param {SlideOptions} [options]
+ * @param {object} [options]
+ * @param {boolean} [options.wrap=true] - auto-generates a wrapper `<div class="slide">` around `target` (see module docs above); when `false`, the `.slide` class is added directly to `target`.
+ * @param {number} [options.duration] - overrides the `--slide-duration` CSS var (ms); if omitted, the CSS value is used.
+ * @param {(() => void) | null} [options.callback] - invoked after the transition ends.
  * @returns {Promise<void>}
  */
 export async function slideUp(target, options = {}) {
@@ -210,7 +218,10 @@ export async function slideUp(target, options = {}) {
  * display snaps to block, then CSS animates height from 0 (via @starting-style) to auto.
  *
  * @param {HTMLElement} target
- * @param {SlideOptions} [options]
+ * @param {object} [options]
+ * @param {boolean} [options.wrap=true] - auto-generates a wrapper `<div class="slide">` around `target` (see module docs above); when `false`, the `.slide` class is added directly to `target`.
+ * @param {number} [options.duration] - overrides the `--slide-duration` CSS var (ms); if omitted, the CSS value is used.
+ * @param {(() => void) | null} [options.callback] - invoked after the transition ends.
  * @returns {Promise<void>}
  */
 export async function slideDown(target, options = {}) {
@@ -226,7 +237,10 @@ export async function slideDown(target, options = {}) {
  * Reads the current data-slide value on the slide element to decide direction.
  *
  * @param {HTMLElement} target
- * @param {SlideOptions} [options]
+ * @param {object} [options]
+ * @param {boolean} [options.wrap=true] - auto-generates a wrapper `<div class="slide">` around `target` (see module docs above); when `false`, the `.slide` class is added directly to `target`.
+ * @param {number} [options.duration] - overrides the `--slide-duration` CSS var (ms); if omitted, the CSS value is used.
+ * @param {(() => void) | null} [options.callback] - invoked after the transition ends.
  * @returns {Promise<void>}
  */
 export async function slideToggle(target, options = {}) {

package/src/utilities/relative-date.js

@@ -23,8 +23,22 @@
  * Returns an HTML `<time>` element string displaying the date in relative or absolute form.
  * Relative dates are auto-refreshed every minute via a shared `setInterval`.
  *
+ * The base param type below is intentionally `object` (not `RelativeDateOptions`): TypeScript only
+ * expands dotted `@param` properties (needed for editor IntelliSense to list each property) when
+ * the base type is the literal `object`; a named typedef there would error (TS8032).
  * @param {Date | string} date - Date to display (Date object or ISO string)
- * @param {RelativeDateOptions} [options={}]
+ * @param {object} [options={}]
+ * @param {boolean} [options.useRelativeTime=true] - Show times near the date as "in xx minutes" (before) or "now" (within `relativeTimeMinutesAfter`)
+ * @param {string} [options.nowString] - String to display when the date is right now
+ * @param {number} [options.relativeTimeMinutesBefore] - Minutes before the date within which to show "in xx minutes"
+ * @param {number} [options.relativeTimeMinutesAfter] - Minutes after the date within which to show the now string
+ * @param {boolean} [options.relativeTimeShowTime] - Show the actual time alongside relative date labels
+ * @param {string} [options.relativeTimeShowTimeMarkup] - HTML markup for the time portion; `@@time@@` is replaced with the localized time string
+ * @param {boolean} [options.firstLetterUpperCase] - Capitalize the first letter of the returned string
+ * @param {Intl.DateTimeFormatOptions} [options.dateFormat] - Format for non-relative dates (beyond day after tomorrow)
+ * @param {Intl.DateTimeFormatOptions} [options.timeFormat] - Format for time displayed in relative date labels
+ * @param {string[]} [options.relativeStrings] - Labels for yesterday / today / tomorrow / day after tomorrow (in chronological order)
+ * @param {string} [options.locale] - Locale string for date/time formatting
  * @returns {string} HTML `<time>` element as a string
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat