@ionic/core 8.8.19 → 8.8.20-dev.11787158518.168a2fea

package/dist/collection/components/select-modal/select-modal.js

@@ -3,20 +3,23 @@
  */
 import { getIonMode } from "../../global/ionic-global";
 import { Host, forceUpdate, h } from "@stencil/core";
+import { getOverlayLabelJustify, getOverlayLabelPlacement } from "../../utils/overlay-control-label";
 import { safeCall } from "../../utils/overlays";
+import { renderOptionLabel } from "../../utils/select-option-render";
 import { getClassMap } from "../../utils/theme";
 export class SelectModal {
-    constructor() {
-        // Tracks the option that received Enter-keydown so keyup only
-        // dismisses when the press started on the same option. Prevents
-        // Enter on the triggering ion-select from auto-dismissing.
-        this.pendingEnterTarget = null;
-        /**
-         * The text to display on the cancel button.
-         */
-        this.cancelText = 'Close';
-        this.options = [];
-    }
+    el;
+    // Tracks the option that received Enter-keydown so keyup only
+    // dismisses when the press started on the same option. Prevents
+    // Enter on the triggering ion-select from auto-dismissing.
+    pendingEnterTarget = null;
+    header;
+    /**
+     * The text to display on the cancel button.
+     */
+    cancelText = 'Close';
+    multiple;
+    options = [];
     closeModal() {
         const modal = this.el.closest('ion-modal');
         if (modal) {
@@ -42,7 +45,7 @@ export class SelectModal {
     callOptionHandler(ev) {
         const option = this.findOptionFromEvent(ev);
         const values = this.getValues(ev);
-        if (option === null || option === void 0 ? void 0 : option.handler) {
+        if (option?.handler) {
             safeCall(option.handler, values);
         }
     }
@@ -56,41 +59,92 @@ export class SelectModal {
         }
     }
     renderRadioOptions() {
+        const mode = getIonMode(this);
         const checked = this.options.filter((o) => o.checked).map((o) => o.value)[0];
-        return (h("ion-radio-group", { value: checked, onIonChange: (ev) => this.callOptionHandler(ev) }, this.options.map((option) => (h("ion-item", { lines: "none", class: Object.assign({
+        return (h("ion-radio-group", { value: checked, onIonChange: (ev) => this.callOptionHandler(ev) }, this.options.map((option, index) => {
+            /**
+             * Cast to `SelectOverlayOption` to access rich content
+             * fields (`startContent`, `endContent`, `description`)
+             * that are passed through from `ion-select` but not
+             * part of the public `SelectModalOption` interface.
+             */
+            const richOption = option;
+            const hasRichContent = !!richOption.startContent || !!richOption.endContent || !!richOption.description;
+            const optionLabelOptions = {
+                id: `modal-option-${index}`,
+                label: richOption.text,
+                startContent: richOption.startContent,
+                endContent: richOption.endContent,
+                description: richOption.description,
+            };
+            const defaultLabelPlacement = getOverlayLabelPlacement(mode, 'radio', 'modal');
+            const defaultJustify = getOverlayLabelJustify(mode, 'radio', 'modal');
+            return (h("ion-item", { lines: "none",
                 // TODO FW-4784
-                'item-radio-checked': option.value === checked
-            }, getClassMap(option.cssClass)) }, h("ion-radio", { value: option.value, disabled: option.disabled, justify: "start", labelPlacement: "end", onClick: () => this.closeModal(), onKeyDown: (ev) => {
-                if (ev.key === 'Enter' && !ev.repeat) {
-                    this.pendingEnterTarget = ev.currentTarget;
-                }
-            }, onKeyUp: (ev) => {
-                if (ev.key === ' ') {
-                    // Space selects and dismisses in one press.
-                    this.closeModal();
-                }
-                else if (ev.key === 'Enter') {
-                    const shouldClose = this.pendingEnterTarget === ev.currentTarget;
-                    this.pendingEnterTarget = null;
-                    if (shouldClose) {
+                disabled: option.disabled, class: {
+                    // TODO FW-4784
+                    'item-radio-checked': option.value === checked,
+                    ...getClassMap(option.cssClass),
+                } }, h("ion-radio", { class: {
+                    'select-option-has-rich-content': hasRichContent,
+                }, value: option.value, disabled: option.disabled, justify: richOption.justify ?? defaultJustify, labelPlacement: richOption.labelPlacement ?? defaultLabelPlacement, onClick: () => this.closeModal(), onKeyDown: (ev) => {
+                    if (ev.key === 'Enter' && !ev.repeat) {
+                        this.pendingEnterTarget = ev.currentTarget;
+                    }
+                }, onKeyUp: (ev) => {
+                    if (ev.key === ' ') {
+                        // Space selects and dismisses in one press.
                         this.closeModal();
                     }
-                }
-            } }, option.text))))));
+                    else if (ev.key === 'Enter') {
+                        const shouldClose = this.pendingEnterTarget === ev.currentTarget;
+                        this.pendingEnterTarget = null;
+                        if (shouldClose) {
+                            this.closeModal();
+                        }
+                    }
+                } }, renderOptionLabel(optionLabelOptions, 'select-option-label'))));
+        })));
     }
     renderCheckboxOptions() {
-        return this.options.map((option) => (h("ion-item", { class: Object.assign({
+        const mode = getIonMode(this);
+        return this.options.map((option, index) => {
+            /**
+             * Cast to `SelectOverlayOption` to access rich content
+             * fields (`startContent`, `endContent`, `description`)
+             * that are passed through from `ion-select` but not
+             * part of the public `SelectModalOption` interface.
+             */
+            const richOption = option;
+            const hasRichContent = !!richOption.startContent || !!richOption.endContent || !!richOption.description;
+            const optionLabelOptions = {
+                id: `modal-option-${index}`,
+                label: richOption.text,
+                startContent: richOption.startContent,
+                endContent: richOption.endContent,
+                description: richOption.description,
+            };
+            const defaultLabelPlacement = getOverlayLabelPlacement(mode, 'checkbox', 'modal');
+            const defaultJustify = getOverlayLabelJustify(mode, 'checkbox', 'modal');
+            return (h("ion-item", {
                 // TODO FW-4784
-                'item-checkbox-checked': option.checked
-            }, getClassMap(option.cssClass)) }, h("ion-checkbox", { value: option.value, disabled: option.disabled, checked: option.checked, justify: "start", labelPlacement: "end", onIonChange: (ev) => {
-                this.setChecked(ev);
-                this.callOptionHandler(ev);
-                // TODO FW-4784
-                forceUpdate(this);
-            } }, option.text))));
+                disabled: option.disabled, class: {
+                    // TODO FW-4784
+                    'item-checkbox-checked': option.checked,
+                    ...getClassMap(option.cssClass),
+                }
+            }, h("ion-checkbox", { class: {
+                    'select-option-has-rich-content': hasRichContent,
+                }, value: option.value, disabled: option.disabled, checked: option.checked, justify: richOption.justify ?? defaultJustify, labelPlacement: richOption.labelPlacement ?? defaultLabelPlacement, onIonChange: (ev) => {
+                    this.setChecked(ev);
+                    this.callOptionHandler(ev);
+                    // TODO FW-4784
+                    forceUpdate(this);
+                } }, renderOptionLabel(optionLabelOptions, 'select-option-label'))));
+        });
     }
     render() {
-        return (h(Host, { key: 'fda0bf6f93cd5ec9f3c64f88a52de849e0e140a2', class: getIonMode(this) }, h("ion-header", { key: '27c0b17175a53db9ff159feeeb96451a3f011dab' }, h("ion-toolbar", { key: '91a4155ebc317fbc9f1bb3e26a7e94754b953c9b' }, this.header !== undefined && h("ion-title", { key: 'f6dae8e4e381f322cc90efefd9bb6ef81d4d2f3e' }, this.header), h("ion-buttons", { key: 'e7760532fb2e7e7385ed6e62097d92d96ff20148', slot: "end" }, h("ion-button", { key: '4999b6fc46cba138186546dca67b7950855e6fb7', onClick: () => this.closeModal() }, this.cancelText)))), h("ion-content", { key: 'c73f80a4bc25b9061ea65cf11e5d811c1a4d8704' }, h("ion-list", { key: 'b21905d15b36ad5eb45845e768918d2763cf48b1' }, this.multiple === true ? this.renderCheckboxOptions() : this.renderRadioOptions()))));
+        return (h(Host, { key: '791e95b985dd4b135db17a25fc678e9f8b73c597', class: getIonMode(this) }, h("ion-header", { key: '697d18eef394c4c11c73afe69b9eadd1bad97d38' }, h("ion-toolbar", { key: '036968824ad8771020fe2b7604a6e72b73efc8ae' }, this.header !== undefined && h("ion-title", { key: '102e0346be83e879e733f9b410437b26216156aa' }, this.header), h("ion-buttons", { key: '436b997e990ce2f5e12e1651f8afc31ae231f7b0', slot: "end" }, h("ion-button", { key: 'ee4ddfd0612d33583aa0b93ebdb5257b10d4fda5', onClick: () => this.closeModal() }, this.cancelText)))), h("ion-content", { key: '38ea098f85ac69226e614e0a09f668e9209f7ea1' }, h("ion-list", { key: '20becc2537a1a027915fe0598203039ceb8ba4f3' }, this.multiple === true ? this.renderCheckboxOptions() : this.renderRadioOptions()))));
     }
     static get is() { return "ion-select-modal"; }
     static get encapsulation() { return "scoped"; }

package/dist/collection/components/select-modal/select-modal.md.css

@@ -1,3 +1,167 @@
+/**
+ * A heuristic that applies CSS to tablet
+ * viewports.
+ *
+ * Usage:
+ * @include tablet-viewport() {
+ *   :host {
+ *     background-color: green;
+ *   }
+ * }
+ */
+/**
+ * A heuristic that applies CSS to mobile
+ * viewports (i.e. phones, not tablets).
+ *
+ * Usage:
+ * @include mobile-viewport() {
+ *   :host {
+ *     background-color: blue;
+ *   }
+ * }
+ */
+/**
+ * Convert a font size to a dynamic font size.
+ * Fonts that participate in Dynamic Type should use
+ * dynamic font sizes.
+ * @param size - The initial font size including the unit (i.e. px or pt)
+ * @param unit (optional) - The unit to convert to. Use this if you want to
+ * convert to a unit other than $baselineUnit.
+ */
+/**
+ * Convert a font size to a dynamic font size but impose
+ * a maximum font size.
+ * @param size - The initial font size including the unit (i.e. px or pt)
+ * @param maxScale - The maximum scale of the font (i.e. 2.5 for a maximum 250% scale).
+ * @param unit (optional) - The unit to convert the initial font size to. Use this if you want to
+ * convert to a unit other than $baselineUnit.
+ */
+/**
+ * Convert a font size to a dynamic font size but impose
+ * a minimum font size.
+ * @param size - The initial font size including the unit (i.e. px or pt)
+ * @param minScale - The minimum scale of the font (i.e. 0.8 for a minimum 80% scale).
+ * @param unit (optional) - The unit to convert the initial font size to. Use this if you want to
+ * convert to a unit other than $baselineUnit.
+ */
+/**
+ * Convert a font size to a dynamic font size but impose
+ * maximum and minimum font sizes.
+ * @param size - The initial font size including the unit (i.e. px or pt)
+ * @param minScale - The minimum scale of the font (i.e. 0.8 for a minimum 80% scale).
+ * @param maxScale - The maximum scale of the font (i.e. 2.5 for a maximum 250% scale).
+ * @param unit (optional) - The unit to convert the initial font size to. Use this if you want to
+ * convert to a unit other than $baselineUnit.
+ */
+.action-sheet-button-label-has-rich-content,
+.alert-radio-label-has-rich-content,
+.alert-checkbox-label-has-rich-content,
+.select-option-label-has-rich-content {
+  display: flex;
+  align-items: center;
+  gap: 16px;
+}
+
+/**
+ * Outer label container has rich content
+ * (start, content, description, end) that needs the
+ * label to span the available row width.
+ */
+.action-sheet-button-label-has-rich-content,
+.alert-radio-label-has-rich-content,
+.alert-checkbox-label-has-rich-content,
+.select-option-content {
+  flex: 1;
+}
+
+.action-sheet-button-label-text,
+.alert-checkbox-label-text,
+.alert-radio-label-text,
+.select-option-label-text {
+  display: flex;
+  align-items: center;
+  gap: 12px;
+}
+
+.select-option-start,
+.select-option-end {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+}
+
+.select-option-description {
+  padding-left: 0;
+  padding-right: 0;
+  padding-top: 5px;
+  padding-bottom: 0;
+  display: block;
+  color: var(--ion-color-step-700, var(--ion-text-color-step-300, #4d4d4d));
+  font-size: 0.75rem;
+}
+
+/**
+ * Non-rich labels are plain text and should ellipsize when they
+ * overflow the row. Rich-content labels switch to flex so the
+ * start / content / end pieces can lay out side-by-side and wrap.
+ */
+.select-option-label:not(.select-option-label-has-rich-content) {
+  text-overflow: ellipsis;
+  white-space: nowrap;
+  overflow: hidden;
+}
+
+.select-option-label-has-rich-content {
+  display: flex;
+  align-items: center;
+}
+
+ion-radio.select-option-has-rich-content::part(label),
+ion-checkbox.select-option-has-rich-content::part(label),
+.select-option-content {
+  flex: 1;
+  /**
+   * Let rich content wrap instead of inheriting the label part's
+   * single-line truncation, so arbitrary slotted elements render
+   * without clipping.
+   */
+  white-space: normal;
+}
+
+/**
+ * Cap slotted children so they can't stretch the option
+ * row out of proportion, keeping rows visually uniform
+ * regardless of the content.
+ */
+.select-option-start > ion-avatar,
+.select-option-end > ion-avatar {
+  width: 40px;
+  height: 40px;
+}
+
+.select-option-start > ion-icon,
+.select-option-end > ion-icon {
+  font-size: 24px;
+}
+
+.select-option-start > ion-img,
+.select-option-start > img,
+.select-option-start > svg,
+.select-option-start > ion-thumbnail,
+.select-option-end > ion-img,
+.select-option-end > img,
+.select-option-end > svg,
+.select-option-end > ion-thumbnail {
+  width: 56px;
+  height: 56px;
+}
+
+.select-option-start > video,
+.select-option-end > video {
+  width: 114px;
+  height: 56px;
+}
+
 :host {
   height: 100%;
 }

package/dist/collection/components/select-modal/test/fixtures.js

@@ -3,8 +3,15 @@
  */
 import { expect } from "@playwright/test";
 export class SelectModalPage {
+    page;
+    multiple;
+    options = [];
+    // Locators
+    modal;
+    selectModal;
+    // Event spies
+    ionModalDidDismiss;
     constructor(page) {
-        this.options = [];
         this.page = page;
     }
     async setup(config, options, multiple = false) {

package/dist/collection/components/select-option/select-option.js

@@ -3,16 +3,60 @@
  */
 import { Host, h } from "@stencil/core";
 import { getIonMode } from "../../global/ionic-global";
+/**
+ * @virtualProp {"ios" | "md"} mode - The mode determines the platform behaviors of the component.
+ *
+ * @slot - Content is placed between the named slots if provided without a slot.
+ * @slot start - Content is placed to the left of the select option text in LTR, and to the right in RTL.
+ * @slot end - Content is placed to the right of the select option text in LTR, and to the left in RTL.
+ */
 export class SelectOption {
-    constructor() {
-        this.inputId = `ion-selopt-${selectOptionIds++}`;
-        /**
-         * If `true`, the user cannot interact with the select option. This property does not apply when `interface="action-sheet"` as `ion-action-sheet` does not allow for disabled buttons.
-         */
-        this.disabled = false;
-    }
+    inputId = `ion-selopt-${selectOptionIds++}`;
+    el;
+    /**
+     * If `true`, the user cannot interact with the select option.
+     */
+    disabled = false;
+    /**
+     * The text value of the option.
+     */
+    value;
+    /**
+     * Text that is placed underneath the option text to provide additional details about the option.
+     */
+    description;
+    /**
+     * Where the label is placed relative to the option's selection control
+     * (radio circle or checkbox box) when the option is rendered in an
+     * `alert`, `popover`, or `modal` interface.
+     * `"start"`: The label will appear to the left of the radio in LTR and to the right in RTL.
+     * `"end"`: The label will appear to the right of the radio in LTR and to the left in RTL.
+     *
+     * Applies to the `alert`, `popover`, and `modal` interfaces, but has no
+     * visible effect on radio options in `popover` or `modal` on `md` (the radio control is hidden there).
+     *
+     * When unset, the interface picks a default based on mode and control
+     * type.
+     */
+    labelPlacement;
+    /**
+     * How to pack the label and the option's selection control within a line.
+     * `"start"`: The label and radio will appear on the left in LTR and
+     * on the right in RTL.
+     * `"end"`: The label and radio will appear on the right in LTR and
+     * on the left in RTL.
+     * `"space-between"`: The label and radio will appear on opposite
+     * ends of the line with space between the two elements.
+     *
+     * Applies to the `alert`, `popover`, and `modal` interfaces, but has no
+     * visible effect on radio options in `popover` or `modal` on `md` (the radio control is hidden there).
+     *
+     * When unset, the interface picks a default based on mode and control
+     * type.
+     */
+    justify;
     render() {
-        return h(Host, { key: '824730b6c1e4f15b716e91b05840e890af5f1577', role: "option", id: this.inputId, class: getIonMode(this) });
+        return h(Host, { key: '01275b5a613c4b065b24e0d939f611f6ed1fc9ee', role: "option", id: this.inputId, class: getIonMode(this) });
     }
     static get is() { return "ion-select-option"; }
     static get encapsulation() { return "shadow"; }
@@ -40,7 +84,7 @@ export class SelectOption {
                 "optional": false,
                 "docs": {
                     "tags": [],
-                    "text": "If `true`, the user cannot interact with the select option. This property does not apply when `interface=\"action-sheet\"` as `ion-action-sheet` does not allow for disabled buttons."
+                    "text": "If `true`, the user cannot interact with the select option."
                 },
                 "getter": false,
                 "setter": false,
@@ -66,6 +110,63 @@ export class SelectOption {
                 "setter": false,
                 "reflect": false,
                 "attribute": "value"
+            },
+            "description": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Text that is placed underneath the option text to provide additional details about the option."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "attribute": "description"
+            },
+            "labelPlacement": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "'start' | 'end'",
+                    "resolved": "\"end\" | \"start\" | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Where the label is placed relative to the option's selection control\n(radio circle or checkbox box) when the option is rendered in an\n`alert`, `popover`, or `modal` interface.\n`\"start\"`: The label will appear to the left of the radio in LTR and to the right in RTL.\n`\"end\"`: The label will appear to the right of the radio in LTR and to the left in RTL.\n\nApplies to the `alert`, `popover`, and `modal` interfaces, but has no\nvisible effect on radio options in `popover` or `modal` on `md` (the radio control is hidden there).\n\nWhen unset, the interface picks a default based on mode and control\ntype."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "attribute": "label-placement"
+            },
+            "justify": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "'start' | 'end' | 'space-between'",
+                    "resolved": "\"end\" | \"space-between\" | \"start\" | undefined",
+                    "references": {}
+                },
+                "required": false,
+                "optional": true,
+                "docs": {
+                    "tags": [],
+                    "text": "How to pack the label and the option's selection control within a line.\n`\"start\"`: The label and radio will appear on the left in LTR and\non the right in RTL.\n`\"end\"`: The label and radio will appear on the right in LTR and\non the left in RTL.\n`\"space-between\"`: The label and radio will appear on opposite\nends of the line with space between the two elements.\n\nApplies to the `alert`, `popover`, and `modal` interfaces, but has no\nvisible effect on radio options in `popover` or `modal` on `md` (the radio control is hidden there).\n\nWhen unset, the interface picks a default based on mode and control\ntype."
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "attribute": "justify"
             }
         };
     }