mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-18 19:21:34 +08:00
b78b454e08
The Ionic Framework team would like to re-evaluate our approach to improving customization options when building mobile applications. We are looking at other solutions that a) make customizing an app UI easier and b) are applicable to a broader set of developers.
1016 lines
30 KiB
TypeScript
1016 lines
30 KiB
TypeScript
import type { ComponentInterface, EventEmitter } from '@stencil/core';
|
|
import { Component, Element, Event, Host, Method, Prop, State, Watch, h, forceUpdate } from '@stencil/core';
|
|
import { createLegacyFormController } from '@utils/forms';
|
|
import type { LegacyFormController } from '@utils/forms';
|
|
import { printIonWarning } from '@utils/logging';
|
|
import { isRTL } from '@utils/rtl';
|
|
import { caretDownSharp } from 'ionicons/icons';
|
|
|
|
import { getIonMode } from '../../global/ionic-global';
|
|
import type {
|
|
ActionSheetButton,
|
|
ActionSheetOptions,
|
|
AlertInput,
|
|
AlertOptions,
|
|
Color,
|
|
CssClassMap,
|
|
OverlaySelect,
|
|
PopoverOptions,
|
|
SelectChangeEventDetail,
|
|
SelectInterface,
|
|
SelectPopoverOption,
|
|
StyleEventDetail,
|
|
} from '../../interface';
|
|
import { findItemLabel, focusElement, getAriaLabel, renderHiddenInput, inheritAttributes } from '../../utils/helpers';
|
|
import type { Attributes } from '../../utils/helpers';
|
|
import { actionSheetController, alertController, popoverController } from '../../utils/overlays';
|
|
import { createColorClasses, hostContext } from '../../utils/theme';
|
|
import { watchForOptions } from '../../utils/watch-options';
|
|
|
|
import type { SelectCompareFn } from './select-interface';
|
|
|
|
// TODO(FW-2832): types
|
|
|
|
/**
|
|
* @virtualProp {"ios" | "md"} mode - The mode determines which platform styles to use.
|
|
*
|
|
* @part placeholder - The text displayed in the select when there is no value.
|
|
* @part text - The displayed value of the select.
|
|
* @part icon - The select icon container.
|
|
*/
|
|
@Component({
|
|
tag: 'ion-select',
|
|
styleUrls: {
|
|
ios: 'select.ios.scss',
|
|
md: 'select.md.scss',
|
|
},
|
|
shadow: true,
|
|
})
|
|
export class Select implements ComponentInterface {
|
|
private inputId = `ion-sel-${selectIds++}`;
|
|
private overlay?: OverlaySelect;
|
|
private focusEl?: HTMLButtonElement;
|
|
private mutationO?: MutationObserver;
|
|
private legacyFormController!: LegacyFormController;
|
|
private inheritedAttributes: Attributes = {};
|
|
private nativeWrapperEl: HTMLElement | undefined;
|
|
|
|
// This flag ensures we log the deprecation warning at most once.
|
|
private hasLoggedDeprecationWarning = false;
|
|
|
|
@Element() el!: HTMLIonSelectElement;
|
|
|
|
@State() isExpanded = false;
|
|
|
|
/**
|
|
* The text to display on the cancel button.
|
|
*/
|
|
@Prop() cancelText = 'Cancel';
|
|
|
|
/**
|
|
* The color to use from your application's color palette.
|
|
* Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
|
|
* For more information on colors, see [theming](/docs/theming/basics).
|
|
*
|
|
* This property is only available when using the modern select syntax.
|
|
*/
|
|
@Prop({ reflect: true }) color?: Color;
|
|
|
|
/**
|
|
* A property name or function used to compare object values
|
|
*/
|
|
@Prop() compareWith?: string | SelectCompareFn | null;
|
|
|
|
/**
|
|
* If `true`, the user cannot interact with the select.
|
|
*/
|
|
@Prop() disabled = false;
|
|
|
|
/**
|
|
* The fill for the item. If `'solid'` the item will have a background. If
|
|
* `'outline'` the item will be transparent with a border. Only available in `md` mode.
|
|
*/
|
|
@Prop() fill?: 'outline' | 'solid';
|
|
|
|
/**
|
|
* The interface the select should use: `action-sheet`, `popover` or `alert`.
|
|
*/
|
|
@Prop() interface: SelectInterface = 'alert';
|
|
|
|
/**
|
|
* Any additional options that the `alert`, `action-sheet` or `popover` interface
|
|
* can take. See the [ion-alert docs](./alert), the
|
|
* [ion-action-sheet docs](./action-sheet) and the
|
|
* [ion-popover docs](./popover) for the
|
|
* create options for each interface.
|
|
*
|
|
* Note: `interfaceOptions` will not override `inputs` or `buttons` with the `alert` interface.
|
|
*/
|
|
@Prop() interfaceOptions: any = {};
|
|
|
|
/**
|
|
* How to pack the label and select within a line.
|
|
* `justify` does not apply when the label and select
|
|
* are on different lines when `labelPlacement` is set to
|
|
* `'floating'` or `'stacked'`.
|
|
* `'start'`: The label and select will appear on the left in LTR and
|
|
* on the right in RTL.
|
|
* `'end'`: The label and select will appear on the right in LTR and
|
|
* on the left in RTL.
|
|
* `'space-between'`: The label and select will appear on opposite
|
|
* ends of the line with space between the two elements.
|
|
*/
|
|
@Prop() justify: 'start' | 'end' | 'space-between' = 'space-between';
|
|
|
|
/**
|
|
* The visible label associated with the select.
|
|
*/
|
|
@Prop() label?: string;
|
|
|
|
/**
|
|
* Where to place the label relative to the select.
|
|
* `'start'`: The label will appear to the left of the select in LTR and to the right in RTL.
|
|
* `'end'`: The label will appear to the right of the select in LTR and to the left in RTL.
|
|
* `'floating'`: The label will appear smaller and above the select when the select is focused or it has a value. Otherwise it will appear on top of the select.
|
|
* `'stacked'`: The label will appear smaller and above the select regardless even when the select is blurred or has no value.
|
|
* `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("...").
|
|
* When using `'floating'` or `'stacked'` we recommend initializing the select with either a `value` or a `placeholder`.
|
|
*/
|
|
@Prop() labelPlacement?: 'start' | 'end' | 'floating' | 'stacked' | 'fixed' = 'start';
|
|
|
|
/**
|
|
* Set the `legacy` property to `true` to forcibly use the legacy form control markup.
|
|
* Ionic will only opt components in to the modern form markup when they are
|
|
* using either the `aria-label` attribute or the `label` property. As a result,
|
|
* the `legacy` property should only be used as an escape hatch when you want to
|
|
* avoid this automatic opt-in behavior.
|
|
* Note that this property will be removed in an upcoming major release
|
|
* of Ionic, and all form components will be opted-in to using the modern form markup.
|
|
*/
|
|
@Prop() legacy?: boolean;
|
|
|
|
/**
|
|
* If `true`, the select can accept multiple values.
|
|
*/
|
|
@Prop() multiple = false;
|
|
|
|
/**
|
|
* The name of the control, which is submitted with the form data.
|
|
*/
|
|
@Prop() name: string = this.inputId;
|
|
|
|
/**
|
|
* The text to display on the ok button.
|
|
*/
|
|
@Prop() okText = 'OK';
|
|
|
|
/**
|
|
* The text to display when the select is empty.
|
|
*/
|
|
@Prop() placeholder?: string;
|
|
|
|
/**
|
|
* The text to display instead of the selected option's value.
|
|
*/
|
|
@Prop() selectedText?: string | null;
|
|
|
|
/**
|
|
* The shape of the select. If "round" it will have an increased border radius.
|
|
*/
|
|
@Prop() shape?: 'round';
|
|
|
|
/**
|
|
* the value of the select.
|
|
*/
|
|
@Prop({ mutable: true }) value?: any | null;
|
|
|
|
/**
|
|
* Emitted when the value has changed.
|
|
*/
|
|
@Event() ionChange!: EventEmitter<SelectChangeEventDetail>;
|
|
|
|
/**
|
|
* Emitted when the selection is cancelled.
|
|
*/
|
|
@Event() ionCancel!: EventEmitter<void>;
|
|
|
|
/**
|
|
* Emitted when the overlay is dismissed.
|
|
*/
|
|
@Event() ionDismiss!: EventEmitter<void>;
|
|
|
|
/**
|
|
* Emitted when the select has focus.
|
|
*/
|
|
@Event() ionFocus!: EventEmitter<void>;
|
|
|
|
/**
|
|
* Emitted when the select loses focus.
|
|
*/
|
|
@Event() ionBlur!: EventEmitter<void>;
|
|
|
|
/**
|
|
* Emitted when the styles change.
|
|
* @internal
|
|
*/
|
|
@Event() ionStyle!: EventEmitter<StyleEventDetail>;
|
|
|
|
@Watch('disabled')
|
|
@Watch('placeholder')
|
|
@Watch('isExpanded')
|
|
styleChanged() {
|
|
this.emitStyle();
|
|
}
|
|
|
|
@Watch('value')
|
|
valueChanged() {
|
|
this.emitStyle();
|
|
}
|
|
|
|
private setValue(value?: any | null) {
|
|
this.value = value;
|
|
this.ionChange.emit({ value });
|
|
}
|
|
|
|
componentWillLoad() {
|
|
this.inheritedAttributes = inheritAttributes(this.el, ['aria-label']);
|
|
}
|
|
|
|
async connectedCallback() {
|
|
const { el } = this;
|
|
|
|
this.legacyFormController = createLegacyFormController(el);
|
|
|
|
this.updateOverlayOptions();
|
|
this.emitStyle();
|
|
|
|
this.mutationO = watchForOptions<HTMLIonSelectOptionElement>(this.el, 'ion-select-option', async () => {
|
|
this.updateOverlayOptions();
|
|
|
|
/**
|
|
* We need to re-render the component
|
|
* because one of the new ion-select-option
|
|
* elements may match the value. In this case,
|
|
* the rendered selected text should be updated.
|
|
*/
|
|
forceUpdate(this);
|
|
});
|
|
}
|
|
|
|
disconnectedCallback() {
|
|
if (this.mutationO) {
|
|
this.mutationO.disconnect();
|
|
this.mutationO = undefined;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Open the select overlay. The overlay is either an alert, action sheet, or popover,
|
|
* depending on the `interface` property on the `ion-select`.
|
|
*
|
|
* @param event The user interface event that called the open.
|
|
*/
|
|
@Method()
|
|
async open(event?: UIEvent): Promise<any> {
|
|
if (this.disabled || this.isExpanded) {
|
|
return undefined;
|
|
}
|
|
this.isExpanded = true;
|
|
const overlay = (this.overlay = await this.createOverlay(event));
|
|
overlay.onDidDismiss().then(() => {
|
|
this.overlay = undefined;
|
|
this.isExpanded = false;
|
|
this.ionDismiss.emit();
|
|
this.setFocus();
|
|
});
|
|
|
|
await overlay.present();
|
|
|
|
// focus selected option for popovers
|
|
if (this.interface === 'popover') {
|
|
let indexOfSelected = this.childOpts.map((o) => o.value).indexOf(this.value);
|
|
indexOfSelected = indexOfSelected > -1 ? indexOfSelected : 0; // default to first option if nothing selected
|
|
const selectedItem = overlay.querySelector<HTMLElement>(
|
|
`.select-interface-option:nth-child(${indexOfSelected + 1})`
|
|
);
|
|
|
|
if (selectedItem) {
|
|
focusElement(selectedItem);
|
|
|
|
/**
|
|
* Browsers such as Firefox do not
|
|
* correctly delegate focus when manually
|
|
* focusing an element with delegatesFocus.
|
|
* We work around this by manually focusing
|
|
* the interactive element.
|
|
* ion-radio and ion-checkbox are the only
|
|
* elements that ion-select-popover uses, so
|
|
* we only need to worry about those two components
|
|
* when focusing.
|
|
*/
|
|
const interactiveEl = selectedItem.querySelector<HTMLElement>('ion-radio, ion-checkbox');
|
|
if (interactiveEl) {
|
|
interactiveEl.focus();
|
|
}
|
|
}
|
|
}
|
|
|
|
return overlay;
|
|
}
|
|
|
|
private createOverlay(ev?: UIEvent): Promise<OverlaySelect> {
|
|
let selectInterface = this.interface;
|
|
if (selectInterface === 'action-sheet' && this.multiple) {
|
|
console.warn(
|
|
`Select interface cannot be "${selectInterface}" with a multi-value select. Using the "alert" interface instead.`
|
|
);
|
|
selectInterface = 'alert';
|
|
}
|
|
|
|
if (selectInterface === 'popover' && !ev) {
|
|
console.warn(
|
|
`Select interface cannot be a "${selectInterface}" without passing an event. Using the "alert" interface instead.`
|
|
);
|
|
selectInterface = 'alert';
|
|
}
|
|
|
|
if (selectInterface === 'action-sheet') {
|
|
return this.openActionSheet();
|
|
}
|
|
if (selectInterface === 'popover') {
|
|
return this.openPopover(ev!);
|
|
}
|
|
return this.openAlert();
|
|
}
|
|
|
|
private updateOverlayOptions(): void {
|
|
const overlay = this.overlay as any;
|
|
if (!overlay) {
|
|
return;
|
|
}
|
|
const childOpts = this.childOpts;
|
|
const value = this.value;
|
|
switch (this.interface) {
|
|
case 'action-sheet':
|
|
overlay.buttons = this.createActionSheetButtons(childOpts, value);
|
|
break;
|
|
case 'popover':
|
|
const popover = overlay.querySelector('ion-select-popover');
|
|
if (popover) {
|
|
popover.options = this.createPopoverOptions(childOpts, value);
|
|
}
|
|
break;
|
|
case 'alert':
|
|
const inputType = this.multiple ? 'checkbox' : 'radio';
|
|
overlay.inputs = this.createAlertInputs(childOpts, inputType, value);
|
|
break;
|
|
}
|
|
}
|
|
|
|
private createActionSheetButtons(data: HTMLIonSelectOptionElement[], selectValue: any): ActionSheetButton[] {
|
|
const actionSheetButtons = data.map((option) => {
|
|
const value = getOptionValue(option);
|
|
|
|
// Remove hydrated before copying over classes
|
|
const copyClasses = Array.from(option.classList)
|
|
.filter((cls) => cls !== 'hydrated')
|
|
.join(' ');
|
|
const optClass = `${OPTION_CLASS} ${copyClasses}`;
|
|
|
|
return {
|
|
role: isOptionSelected(selectValue, value, this.compareWith) ? 'selected' : '',
|
|
text: option.textContent,
|
|
cssClass: optClass,
|
|
handler: () => {
|
|
this.setValue(value);
|
|
},
|
|
} as ActionSheetButton;
|
|
});
|
|
|
|
// Add "cancel" button
|
|
actionSheetButtons.push({
|
|
text: this.cancelText,
|
|
role: 'cancel',
|
|
handler: () => {
|
|
this.ionCancel.emit();
|
|
},
|
|
});
|
|
|
|
return actionSheetButtons;
|
|
}
|
|
|
|
private createAlertInputs(
|
|
data: HTMLIonSelectOptionElement[],
|
|
inputType: 'checkbox' | 'radio',
|
|
selectValue: any
|
|
): AlertInput[] {
|
|
const alertInputs = data.map((option) => {
|
|
const value = getOptionValue(option);
|
|
|
|
// Remove hydrated before copying over classes
|
|
const copyClasses = Array.from(option.classList)
|
|
.filter((cls) => cls !== 'hydrated')
|
|
.join(' ');
|
|
const optClass = `${OPTION_CLASS} ${copyClasses}`;
|
|
|
|
return {
|
|
type: inputType,
|
|
cssClass: optClass,
|
|
label: option.textContent || '',
|
|
value,
|
|
checked: isOptionSelected(selectValue, value, this.compareWith),
|
|
disabled: option.disabled,
|
|
};
|
|
});
|
|
|
|
return alertInputs;
|
|
}
|
|
|
|
private createPopoverOptions(data: HTMLIonSelectOptionElement[], selectValue: any): SelectPopoverOption[] {
|
|
const popoverOptions = data.map((option) => {
|
|
const value = getOptionValue(option);
|
|
|
|
// Remove hydrated before copying over classes
|
|
const copyClasses = Array.from(option.classList)
|
|
.filter((cls) => cls !== 'hydrated')
|
|
.join(' ');
|
|
const optClass = `${OPTION_CLASS} ${copyClasses}`;
|
|
|
|
return {
|
|
text: option.textContent || '',
|
|
cssClass: optClass,
|
|
value,
|
|
checked: isOptionSelected(selectValue, value, this.compareWith),
|
|
disabled: option.disabled,
|
|
handler: (selected: any) => {
|
|
this.setValue(selected);
|
|
if (!this.multiple) {
|
|
this.close();
|
|
}
|
|
},
|
|
};
|
|
});
|
|
|
|
return popoverOptions;
|
|
}
|
|
|
|
private async openPopover(ev: UIEvent) {
|
|
const { fill } = this;
|
|
const interfaceOptions = this.interfaceOptions;
|
|
const mode = getIonMode(this);
|
|
const showBackdrop = mode === 'md' ? false : true;
|
|
const multiple = this.multiple;
|
|
const value = this.value;
|
|
|
|
let event: Event | CustomEvent = ev;
|
|
let size = 'auto';
|
|
|
|
if (this.legacyFormController.hasLegacyControl()) {
|
|
const item = this.el.closest('ion-item');
|
|
|
|
// If the select is inside of an item containing a floating
|
|
// or stacked label then the popover should take up the
|
|
// full width of the item when it presents
|
|
if (item && (item.classList.contains('item-label-floating') || item.classList.contains('item-label-stacked'))) {
|
|
event = {
|
|
...ev,
|
|
detail: {
|
|
ionShadowTarget: item,
|
|
},
|
|
};
|
|
size = 'cover';
|
|
}
|
|
} else {
|
|
/**
|
|
* The popover should take up the full width
|
|
* when using a fill in MD mode.
|
|
*/
|
|
if (mode === 'md' && fill !== undefined) {
|
|
size = 'cover';
|
|
|
|
/**
|
|
* Otherwise the popover
|
|
* should be positioned relative
|
|
* to the native element.
|
|
*/
|
|
} else {
|
|
event = {
|
|
...ev,
|
|
detail: {
|
|
ionShadowTarget: this.nativeWrapperEl,
|
|
},
|
|
};
|
|
}
|
|
}
|
|
|
|
const popoverOpts: PopoverOptions = {
|
|
mode,
|
|
event,
|
|
alignment: 'center',
|
|
size,
|
|
showBackdrop,
|
|
...interfaceOptions,
|
|
|
|
component: 'ion-select-popover',
|
|
cssClass: ['select-popover', interfaceOptions.cssClass],
|
|
componentProps: {
|
|
header: interfaceOptions.header,
|
|
subHeader: interfaceOptions.subHeader,
|
|
message: interfaceOptions.message,
|
|
multiple,
|
|
value,
|
|
options: this.createPopoverOptions(this.childOpts, value),
|
|
},
|
|
};
|
|
|
|
/**
|
|
* Workaround for Stencil to autodefine
|
|
* ion-select-popover and ion-popover when
|
|
* using Custom Elements build.
|
|
*/
|
|
// eslint-disable-next-line
|
|
if (false) {
|
|
// eslint-disable-next-line
|
|
// @ts-ignore
|
|
document.createElement('ion-select-popover');
|
|
document.createElement('ion-popover');
|
|
}
|
|
|
|
return popoverController.create(popoverOpts);
|
|
}
|
|
|
|
private async openActionSheet() {
|
|
const mode = getIonMode(this);
|
|
const interfaceOptions = this.interfaceOptions;
|
|
const actionSheetOpts: ActionSheetOptions = {
|
|
mode,
|
|
...interfaceOptions,
|
|
|
|
buttons: this.createActionSheetButtons(this.childOpts, this.value),
|
|
cssClass: ['select-action-sheet', interfaceOptions.cssClass],
|
|
};
|
|
|
|
/**
|
|
* Workaround for Stencil to autodefine
|
|
* ion-action-sheet when
|
|
* using Custom Elements build.
|
|
*/
|
|
// eslint-disable-next-line
|
|
if (false) {
|
|
// eslint-disable-next-line
|
|
// @ts-ignore
|
|
document.createElement('ion-action-sheet');
|
|
}
|
|
|
|
return actionSheetController.create(actionSheetOpts);
|
|
}
|
|
|
|
private async openAlert() {
|
|
const label = this.getLabel();
|
|
const labelText = label ? label.textContent : null;
|
|
|
|
const interfaceOptions = this.interfaceOptions;
|
|
const inputType = this.multiple ? 'checkbox' : 'radio';
|
|
const mode = getIonMode(this);
|
|
|
|
const alertOpts: AlertOptions = {
|
|
mode,
|
|
...interfaceOptions,
|
|
|
|
header: interfaceOptions.header ? interfaceOptions.header : labelText,
|
|
inputs: this.createAlertInputs(this.childOpts, inputType, this.value),
|
|
buttons: [
|
|
{
|
|
text: this.cancelText,
|
|
role: 'cancel',
|
|
handler: () => {
|
|
this.ionCancel.emit();
|
|
},
|
|
},
|
|
{
|
|
text: this.okText,
|
|
handler: (selectedValues: any) => {
|
|
this.setValue(selectedValues);
|
|
},
|
|
},
|
|
],
|
|
cssClass: [
|
|
'select-alert',
|
|
interfaceOptions.cssClass,
|
|
this.multiple ? 'multiple-select-alert' : 'single-select-alert',
|
|
],
|
|
};
|
|
|
|
/**
|
|
* Workaround for Stencil to autodefine
|
|
* ion-alert when
|
|
* using Custom Elements build.
|
|
*/
|
|
// eslint-disable-next-line
|
|
if (false) {
|
|
// eslint-disable-next-line
|
|
// @ts-ignore
|
|
document.createElement('ion-alert');
|
|
}
|
|
|
|
return alertController.create(alertOpts);
|
|
}
|
|
|
|
/**
|
|
* Close the select interface.
|
|
*/
|
|
private close(): Promise<boolean> {
|
|
if (!this.overlay) {
|
|
return Promise.resolve(false);
|
|
}
|
|
return this.overlay.dismiss();
|
|
}
|
|
|
|
private getLabel() {
|
|
return findItemLabel(this.el);
|
|
}
|
|
|
|
private hasValue(): boolean {
|
|
return this.getText() !== '';
|
|
}
|
|
|
|
private get childOpts() {
|
|
return Array.from(this.el.querySelectorAll('ion-select-option'));
|
|
}
|
|
|
|
private getText(): string {
|
|
const selectedText = this.selectedText;
|
|
if (selectedText != null && selectedText !== '') {
|
|
return selectedText;
|
|
}
|
|
return generateText(this.childOpts, this.value, this.compareWith);
|
|
}
|
|
|
|
private setFocus() {
|
|
if (this.focusEl) {
|
|
this.focusEl.focus();
|
|
}
|
|
}
|
|
|
|
private emitStyle() {
|
|
if (this.legacyFormController.hasLegacyControl()) {
|
|
this.ionStyle.emit({
|
|
interactive: true,
|
|
'interactive-disabled': this.disabled,
|
|
select: true,
|
|
'select-disabled': this.disabled,
|
|
'has-placeholder': this.placeholder !== undefined,
|
|
'has-value': this.hasValue(),
|
|
'has-focus': this.isExpanded,
|
|
});
|
|
}
|
|
}
|
|
|
|
private onClick = (ev: UIEvent) => {
|
|
this.setFocus();
|
|
this.open(ev);
|
|
};
|
|
|
|
private onFocus = () => {
|
|
this.ionFocus.emit();
|
|
};
|
|
|
|
private onBlur = () => {
|
|
this.ionBlur.emit();
|
|
};
|
|
|
|
private renderLabel() {
|
|
const { label } = this;
|
|
if (label === undefined) {
|
|
return;
|
|
}
|
|
|
|
return (
|
|
<div class="label-text-wrapper">
|
|
<div class="label-text">{this.label}</div>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Renders the border container
|
|
* when fill="outline".
|
|
*/
|
|
private renderLabelContainer() {
|
|
const mode = getIonMode(this);
|
|
const hasOutlineFill = mode === 'md' && this.fill === 'outline';
|
|
|
|
if (hasOutlineFill) {
|
|
/**
|
|
* The outline fill has a special outline
|
|
* that appears around the select and the label.
|
|
* Certain stacked and floating label placements cause the
|
|
* label to translate up and create a "cut out"
|
|
* inside of that border by using the notch-spacer element.
|
|
*/
|
|
return [
|
|
<div class="select-outline-container">
|
|
<div class="select-outline-start"></div>
|
|
<div class="select-outline-notch">
|
|
<div class="notch-spacer" aria-hidden="true">
|
|
{this.label}
|
|
</div>
|
|
</div>
|
|
<div class="select-outline-end"></div>
|
|
</div>,
|
|
this.renderLabel(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* If not using the outline style,
|
|
* we can render just the label.
|
|
*/
|
|
return this.renderLabel();
|
|
}
|
|
|
|
private renderSelect() {
|
|
const { disabled, el, isExpanded, labelPlacement, justify, placeholder, fill, shape } = this;
|
|
const mode = getIonMode(this);
|
|
const hasFloatingOrStackedLabel = labelPlacement === 'floating' || labelPlacement === 'stacked';
|
|
const justifyEnabled = !hasFloatingOrStackedLabel;
|
|
const rtl = isRTL(el) ? 'rtl' : 'ltr';
|
|
const inItem = hostContext('ion-item', this.el);
|
|
const shouldRenderHighlight = mode === 'md' && fill !== 'outline' && !inItem;
|
|
|
|
return (
|
|
<Host
|
|
onClick={this.onClick}
|
|
class={createColorClasses(this.color, {
|
|
[mode]: true,
|
|
'in-item': inItem,
|
|
'select-disabled': disabled,
|
|
'select-expanded': isExpanded,
|
|
'has-value': this.hasValue(),
|
|
'has-placeholder': placeholder !== undefined,
|
|
'ion-focusable': true,
|
|
[`select-${rtl}`]: true,
|
|
[`select-fill-${fill}`]: fill !== undefined,
|
|
[`select-justify-${justify}`]: justifyEnabled,
|
|
[`select-shape-${shape}`]: shape !== undefined,
|
|
[`select-label-placement-${labelPlacement}`]: true,
|
|
})}
|
|
>
|
|
<label class="select-wrapper" id="select-label">
|
|
{this.renderLabelContainer()}
|
|
<div class="native-wrapper" ref={(el) => (this.nativeWrapperEl = el)}>
|
|
{this.renderSelectText()}
|
|
{!hasFloatingOrStackedLabel && this.renderSelectIcon()}
|
|
{this.renderListbox()}
|
|
</div>
|
|
{/**
|
|
* The icon in a floating/stacked select
|
|
* must be centered with the entire select,
|
|
* not just the native control. As a result,
|
|
* we need to render the icon outside of
|
|
* the native wrapper.
|
|
*/}
|
|
{hasFloatingOrStackedLabel && this.renderSelectIcon()}
|
|
{shouldRenderHighlight && <div class="select-highlight"></div>}
|
|
</label>
|
|
</Host>
|
|
);
|
|
}
|
|
|
|
// TODO FW-3194 - Remove this
|
|
private renderLegacySelect() {
|
|
if (!this.hasLoggedDeprecationWarning) {
|
|
printIonWarning(
|
|
`Using ion-select with an ion-label has been deprecated. To migrate, remove the ion-label and use the "label" property on ion-select instead.
|
|
|
|
Example: <ion-select label="Favorite Color">...</ion-select>
|
|
|
|
For inputs that do not have a visible label, developers should use "aria-label" so screen readers can announce the purpose of the select.
|
|
`,
|
|
this.el
|
|
);
|
|
|
|
if (this.legacy) {
|
|
printIonWarning(
|
|
`ion-select is being used with the "legacy" property enabled which will forcibly enable the legacy form markup. This property will be removed in an upcoming major release of Ionic where this form control will use the modern form markup.
|
|
Developers can dismiss this warning by removing their usage of the "legacy" property and using the new select syntax.`,
|
|
this.el
|
|
);
|
|
}
|
|
this.hasLoggedDeprecationWarning = true;
|
|
}
|
|
|
|
const { disabled, el, inputId, isExpanded, name, placeholder, value } = this;
|
|
const mode = getIonMode(this);
|
|
const { labelText, labelId } = getAriaLabel(el, inputId);
|
|
|
|
renderHiddenInput(true, el, name, parseValue(value), disabled);
|
|
|
|
const displayValue = this.getText();
|
|
|
|
let selectText = displayValue;
|
|
if (selectText === '' && placeholder !== undefined) {
|
|
selectText = placeholder;
|
|
}
|
|
|
|
// If there is a label then we need to concatenate it with the
|
|
// current value (or placeholder) and a comma so it separates
|
|
// nicely when the screen reader announces it, otherwise just
|
|
// announce the value / placeholder
|
|
const displayLabel =
|
|
labelText !== undefined ? (selectText !== '' ? `${selectText}, ${labelText}` : labelText) : selectText;
|
|
|
|
return (
|
|
<Host
|
|
onClick={this.onClick}
|
|
role="button"
|
|
aria-haspopup="listbox"
|
|
aria-disabled={disabled ? 'true' : null}
|
|
aria-label={displayLabel}
|
|
class={{
|
|
[mode]: true,
|
|
'in-item': hostContext('ion-item', el),
|
|
'in-item-color': hostContext('ion-item.ion-color', el),
|
|
'select-disabled': disabled,
|
|
'select-expanded': isExpanded,
|
|
'legacy-select': true,
|
|
}}
|
|
>
|
|
{this.renderSelectText()}
|
|
{this.renderSelectIcon()}
|
|
<label id={labelId}>{displayLabel}</label>
|
|
{this.renderListbox()}
|
|
</Host>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Renders either the placeholder
|
|
* or the selected values based on
|
|
* the state of the select.
|
|
*/
|
|
private renderSelectText() {
|
|
const { placeholder } = this;
|
|
|
|
const displayValue = this.getText();
|
|
|
|
let addPlaceholderClass = false;
|
|
let selectText = displayValue;
|
|
if (selectText === '' && placeholder !== undefined) {
|
|
selectText = placeholder;
|
|
addPlaceholderClass = true;
|
|
}
|
|
|
|
const selectTextClasses: CssClassMap = {
|
|
'select-text': true,
|
|
'select-placeholder': addPlaceholderClass,
|
|
};
|
|
|
|
const textPart = addPlaceholderClass ? 'placeholder' : 'text';
|
|
|
|
return (
|
|
<div aria-hidden="true" class={selectTextClasses} part={textPart}>
|
|
{selectText}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Renders the chevron icon
|
|
* next to the select text.
|
|
*/
|
|
private renderSelectIcon() {
|
|
return <ion-icon class="select-icon" part="icon" aria-hidden="true" icon={caretDownSharp}></ion-icon>;
|
|
}
|
|
|
|
private get ariaLabel() {
|
|
const { placeholder, label, el, inputId, inheritedAttributes } = this;
|
|
const displayValue = this.getText();
|
|
const { labelText } = getAriaLabel(el, inputId);
|
|
const definedLabel = label ?? inheritedAttributes['aria-label'] ?? labelText;
|
|
|
|
/**
|
|
* If developer has specified a placeholder
|
|
* and there is nothing selected, the selectText
|
|
* should have the placeholder value.
|
|
*/
|
|
let renderedLabel = displayValue;
|
|
if (renderedLabel === '' && placeholder !== undefined) {
|
|
renderedLabel = placeholder;
|
|
}
|
|
|
|
/**
|
|
* If there is a developer-defined label,
|
|
* then we need to concatenate the developer label
|
|
* string with the current current value.
|
|
* The label for the control should be read
|
|
* before the values of the control.
|
|
*/
|
|
if (definedLabel !== undefined) {
|
|
renderedLabel = renderedLabel === '' ? definedLabel : `${definedLabel}, ${renderedLabel}`;
|
|
}
|
|
|
|
return renderedLabel;
|
|
}
|
|
|
|
private renderListbox() {
|
|
const { disabled, inputId, isExpanded } = this;
|
|
|
|
return (
|
|
<button
|
|
disabled={disabled}
|
|
id={inputId}
|
|
aria-label={this.ariaLabel}
|
|
aria-haspopup="listbox"
|
|
aria-expanded={`${isExpanded}`}
|
|
onFocus={this.onFocus}
|
|
onBlur={this.onBlur}
|
|
ref={(focusEl) => (this.focusEl = focusEl)}
|
|
></button>
|
|
);
|
|
}
|
|
|
|
render() {
|
|
const { legacyFormController } = this;
|
|
|
|
return legacyFormController.hasLegacyControl() ? this.renderLegacySelect() : this.renderSelect();
|
|
}
|
|
}
|
|
|
|
const isOptionSelected = (
|
|
currentValue: any[] | any,
|
|
compareValue: any,
|
|
compareWith?: string | SelectCompareFn | null
|
|
) => {
|
|
if (currentValue === undefined) {
|
|
return false;
|
|
}
|
|
if (Array.isArray(currentValue)) {
|
|
return currentValue.some((val) => compareOptions(val, compareValue, compareWith));
|
|
} else {
|
|
return compareOptions(currentValue, compareValue, compareWith);
|
|
}
|
|
};
|
|
|
|
const getOptionValue = (el: HTMLIonSelectOptionElement) => {
|
|
const value = el.value;
|
|
return value === undefined ? el.textContent || '' : value;
|
|
};
|
|
|
|
const parseValue = (value: any) => {
|
|
if (value == null) {
|
|
return undefined;
|
|
}
|
|
if (Array.isArray(value)) {
|
|
return value.join(',');
|
|
}
|
|
return value.toString();
|
|
};
|
|
|
|
const compareOptions = (
|
|
currentValue: any,
|
|
compareValue: any,
|
|
compareWith?: string | SelectCompareFn | null
|
|
): boolean => {
|
|
if (typeof compareWith === 'function') {
|
|
return compareWith(currentValue, compareValue);
|
|
} else if (typeof compareWith === 'string') {
|
|
return currentValue[compareWith] === compareValue[compareWith];
|
|
} else {
|
|
return Array.isArray(compareValue) ? compareValue.includes(currentValue) : currentValue === compareValue;
|
|
}
|
|
};
|
|
|
|
const generateText = (
|
|
opts: HTMLIonSelectOptionElement[],
|
|
value: any | any[],
|
|
compareWith?: string | SelectCompareFn | null
|
|
) => {
|
|
if (value === undefined) {
|
|
return '';
|
|
}
|
|
if (Array.isArray(value)) {
|
|
return value
|
|
.map((v) => textForValue(opts, v, compareWith))
|
|
.filter((opt) => opt !== null)
|
|
.join(', ');
|
|
} else {
|
|
return textForValue(opts, value, compareWith) || '';
|
|
}
|
|
};
|
|
|
|
const textForValue = (
|
|
opts: HTMLIonSelectOptionElement[],
|
|
value: any,
|
|
compareWith?: string | SelectCompareFn | null
|
|
): string | null => {
|
|
const selectOpt = opts.find((opt) => {
|
|
return compareOptions(value, getOptionValue(opt), compareWith);
|
|
});
|
|
return selectOpt ? selectOpt.textContent : null;
|
|
};
|
|
|
|
let selectIds = 0;
|
|
|
|
const OPTION_CLASS = 'select-interface-option';
|