@ionic/core 8.8.18 → 8.8.19-dev.11786730389.1a1927bf

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: '8b8bef0f5a55f18048708c34d3ea3ff0ff2f1d47', 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"
             }
         };
     }

package/dist/collection/components/select-popover/select-popover.ios.css

@@ -1,3 +1,221 @@
+/**
+ * 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;
+}
+
+/**
+ * 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.
+ */
+/**
+ * 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;
+ *   }
+ * }
+ */
+/**
+ * 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-start > ion-img,
+.select-option-start > ion-thumbnail,
+.select-option-start > img,
+.select-option-start > svg,
+.select-option-end > ion-avatar,
+.select-option-end > ion-img,
+.select-option-end > ion-thumbnail,
+.select-option-end > img,
+.select-option-end > svg {
+  width: 44px;
+  height: 44px;
+}
+
+.select-option-start > ion-icon,
+.select-option-end > ion-icon {
+  font-size: 28px;
+}
+
+.action-sheet-button-label-text {
+  justify-content: center;
+}
+
+.select-option-has-rich-content {
+  -webkit-padding-end: 16px;
+  padding-inline-end: 16px;
+}
+
 /**
  * Convert a font size to a dynamic font size.
  * Fonts that participate in Dynamic Type should use

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

@@ -2,23 +2,40 @@
  * (C) Ionic http://ionicframework.com - MIT License
  */
 import { Host, h, forceUpdate } 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";
 import { getIonMode } from "../../global/ionic-global";
 /**
  * @internal
  */
 export class SelectPopover {
-    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;
-        /**
-         * An array of options for the popover
-         */
-        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;
+    /**
+     * The header text of the popover
+     */
+    header;
+    /**
+     * The subheader text of the popover
+     */
+    subHeader;
+    /**
+     * The text content of the popover body
+     */
+    message;
+    /**
+     * If true, the select accepts multiple values
+     */
+    multiple;
+    /**
+     * An array of options for the popover
+     */
+    options = [];
     findOptionFromEvent(ev) {
         const { options } = this;
         return options.find((o) => o.value === ev.target.value);
@@ -31,7 +48,7 @@ export class SelectPopover {
     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);
         }
     }
@@ -76,43 +93,93 @@ export class SelectPopover {
         }
     }
     renderCheckboxOptions(options) {
-        return options.map((option) => (h("ion-item", { class: Object.assign({
-                // 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);
+        const mode = getIonMode(this);
+        return 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 `SelectPopoverOption` interface.
+             */
+            const richOption = option;
+            const hasRichContent = !!richOption.startContent || !!richOption.endContent || !!richOption.description;
+            const optionLabelOptions = {
+                id: `popover-option-${index}`,
+                label: richOption.text,
+                startContent: richOption.startContent,
+                endContent: richOption.endContent,
+                description: richOption.description,
+            };
+            const defaultLabelPlacement = getOverlayLabelPlacement(mode, 'checkbox');
+            const defaultJustify = getOverlayLabelJustify(mode, 'checkbox');
+            return (h("ion-item", {
                 // 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'))));
+        });
     }
     renderRadioOptions(options) {
+        const mode = getIonMode(this);
         const checked = options.filter((o) => o.checked).map((o) => o.value)[0];
-        return (h("ion-radio-group", { value: checked, onIonChange: (ev) => this.callOptionHandler(ev) }, options.map((option) => (h("ion-item", { class: Object.assign({
+        return (h("ion-radio-group", { value: checked, onIonChange: (ev) => this.callOptionHandler(ev) }, 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 `SelectPopoverOption` interface.
+             */
+            const richOption = option;
+            const hasRichContent = !!richOption.startContent || !!richOption.endContent || !!richOption.description;
+            const optionLabelOptions = {
+                id: `popover-option-${index}`,
+                label: richOption.text,
+                startContent: richOption.startContent,
+                endContent: richOption.endContent,
+                description: richOption.description,
+            };
+            return (h("ion-item", {
                 // TODO FW-4784
-                'item-radio-checked': option.value === checked
-            }, getClassMap(option.cssClass)) }, h("ion-radio", { value: option.value, disabled: option.disabled, onClick: () => this.dismissParentPopover(), 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.dismissParentPopover();
+                disabled: option.disabled, class: {
+                    // TODO FW-4784
+                    'item-radio-checked': option.value === checked,
+                    ...getClassMap(option.cssClass),
                 }
-                else if (ev.key === 'Enter') {
-                    const shouldDismiss = this.pendingEnterTarget === ev.currentTarget;
-                    this.pendingEnterTarget = null;
-                    if (shouldDismiss) {
+            }, h("ion-radio", { class: {
+                    'select-option-has-rich-content': hasRichContent,
+                }, value: option.value, disabled: option.disabled, justify: richOption.justify ?? getOverlayLabelJustify(mode, 'radio'), labelPlacement: richOption.labelPlacement ?? getOverlayLabelPlacement(mode, 'radio'), onClick: () => this.dismissParentPopover(), 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.dismissParentPopover();
                     }
-                }
-            } }, option.text))))));
+                    else if (ev.key === 'Enter') {
+                        const shouldDismiss = this.pendingEnterTarget === ev.currentTarget;
+                        this.pendingEnterTarget = null;
+                        if (shouldDismiss) {
+                            this.dismissParentPopover();
+                        }
+                    }
+                } }, renderOptionLabel(optionLabelOptions, 'select-option-label'))));
+        })));
     }
     render() {
         const { header, message, options, subHeader } = this;
         const hasSubHeaderOrMessage = subHeader !== undefined || message !== undefined;
-        return (h(Host, { key: 'e7449a1ecfcdbf45a79f8e26a00253c4e146448a', class: getIonMode(this) }, h("ion-list", { key: '52abdfc8668c3429a0dcefef8ddedb6647fdd894' }, header !== undefined && h("ion-list-header", { key: '978e5c03728756feafcc60a0e10e6ec59bf2ae11' }, header), hasSubHeaderOrMessage && (h("ion-item", { key: 'e93c44e7f07a76def16e4b11f0fb4780d84ed402' }, h("ion-label", { key: 'bba1aac43b0bc7f4f00978dd8301985233f3725c', class: "ion-text-wrap" }, subHeader !== undefined && h("h3", { key: 'ad96f6017cf2cc5219540bded2c4f1ca3b532de2' }, subHeader), message !== undefined && h("p", { key: '3fd038921dc40c4d0c29734433984b279ccaeec3' }, message)))), this.renderOptions(options))));
+        return (h(Host, { key: 'd0c107e0ca78955a3cfcd9f098a527fb35eff14d', class: getIonMode(this) }, h("ion-list", { key: '1e103312e22bf78d2201a0f88cc4fed789f62a2b' }, header !== undefined && h("ion-list-header", { key: '657439905dc480112ed8d7f8d4a01464724de2bd' }, header), hasSubHeaderOrMessage && (h("ion-item", { key: 'e0eaa0250bf233cf846adba5ddc141bf3430c2a8' }, h("ion-label", { key: 'ad1cff877f9d582fbc64f9049603146fd1a1a6f9', class: "ion-text-wrap" }, subHeader !== undefined && h("h3", { key: 'ead921d395b614a99c89a8ffe2a102a620f80767' }, subHeader), message !== undefined && h("p", { key: '3a47e7091528930f33324ccd04d6734217155244' }, message)))), this.renderOptions(options))));
     }
     static get is() { return "ion-select-popover"; }
     static get encapsulation() { return "scoped"; }