diff --git a/core/src/components.d.ts b/core/src/components.d.ts index 4b85721b49..c429b03983 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -4770,7 +4770,7 @@ declare namespace LocalJSX { */ "multiple"?: boolean; /** - * Emitted when the value property has changed as a result of a user action such as a click. This event will not emit when programmatically setting the value property. + * Emitted when the value property has changed as a result of a user action such as a click. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonAccordionGroupCustomEvent) => void; /** @@ -5345,7 +5345,7 @@ declare namespace LocalJSX { */ "onIonBlur"?: (event: IonCheckboxCustomEvent) => void; /** - * Emitted when the checked property has changed as a result of a user action such as a click. This event will not emit when programmatically setting the checked property. + * Emitted when the checked property has changed as a result of a user action such as a click. This event will not emit when programmatically setting the `checked` property. */ "onIonChange"?: (event: IonCheckboxCustomEvent) => void; /** @@ -5601,7 +5601,7 @@ declare namespace LocalJSX { */ "onIonCancel"?: (event: IonDatetimeCustomEvent) => void; /** - * Emitted when the value (selected date) has changed. + * Emitted when the value (selected date) has changed. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonDatetimeCustomEvent) => void; /** @@ -5971,7 +5971,7 @@ declare namespace LocalJSX { */ "onIonBlur"?: (event: IonInputCustomEvent) => void; /** - * The `ionChange` event is fired when the user modifies the input's value. Unlike the `ionInput` event, the `ionChange` event is only fired when changes are committed, not as the user types. Depending on the way the users interacts with the element, the `ionChange` event fires at a different moment: - When the user commits the change explicitly (e.g. by selecting a date from a date picker for ``, pressing the "Enter" key, etc.). - When the element loses focus after its value has changed: for elements where the user's interaction is typing. + * The `ionChange` event is fired when the user modifies the input's value. Unlike the `ionInput` event, the `ionChange` event is only fired when changes are committed, not as the user types. Depending on the way the users interacts with the element, the `ionChange` event fires at a different moment: - When the user commits the change explicitly (e.g. by selecting a date from a date picker for ``, pressing the "Enter" key, etc.). - When the element loses focus after its value has changed: for elements where the user's interaction is typing. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonInputCustomEvent) => void; /** @@ -6620,7 +6620,7 @@ declare namespace LocalJSX { */ "numericInput"?: boolean; /** - * Emitted when the value has changed. + * Emitted when the value has changed. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonPickerColumnCustomEvent) => void; /** @@ -6961,7 +6961,7 @@ declare namespace LocalJSX { */ "name"?: string; /** - * Emitted when the value has changed. + * Emitted when the value has changed. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonRadioGroupCustomEvent) => void; /** @@ -7023,7 +7023,7 @@ declare namespace LocalJSX { */ "onIonBlur"?: (event: IonRangeCustomEvent) => void; /** - * The `ionChange` event is fired for `` elements when the user modifies the element's value: - When the user releases the knob after dragging; - When the user moves the knob with keyboard arrows `ionChange` is not fired when the value is changed programmatically. + * The `ionChange` event is fired for `` elements when the user modifies the element's value: - When the user releases the knob after dragging; - When the user moves the knob with keyboard arrows This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonRangeCustomEvent) => void; /** @@ -7324,7 +7324,7 @@ declare namespace LocalJSX { */ "onIonCancel"?: (event: IonSearchbarCustomEvent) => void; /** - * The `ionChange` event is fired for `` elements when the user modifies the element's value. Unlike the `ionInput` event, the `ionChange` event is not necessarily fired for each alteration to an element's value. The `ionChange` event is fired when the value has been committed by the user. This can happen when the element loses focus or when the "Enter" key is pressed. `ionChange` can also fire when clicking the clear or cancel buttons. + * The `ionChange` event is fired for `` elements when the user modifies the element's value. Unlike the `ionInput` event, the `ionChange` event is not necessarily fired for each alteration to an element's value. The `ionChange` event is fired when the value has been committed by the user. This can happen when the element loses focus or when the "Enter" key is pressed. `ionChange` can also fire when clicking the clear or cancel buttons. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonSearchbarCustomEvent) => void; /** @@ -7386,7 +7386,7 @@ declare namespace LocalJSX { */ "mode"?: "ios" | "md"; /** - * Emitted when the value property has changed and any dragging pointer has been released from `ion-segment`. + * Emitted when the value property has changed and any dragging pointer has been released from `ion-segment`. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonSegmentCustomEvent) => void; /** @@ -7506,7 +7506,7 @@ declare namespace LocalJSX { */ "onIonCancel"?: (event: IonSelectCustomEvent) => void; /** - * Emitted when the value has changed. + * Emitted when the value has changed. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonSelectCustomEvent) => void; /** @@ -7809,7 +7809,7 @@ declare namespace LocalJSX { */ "onIonBlur"?: (event: IonTextareaCustomEvent) => void; /** - * The `ionChange` event is fired when the user modifies the textarea's value. Unlike the `ionInput` event, the `ionChange` event is fired when the element loses focus after its value has been modified. + * The `ionChange` event is fired when the user modifies the textarea's value. Unlike the `ionInput` event, the `ionChange` event is fired when the element loses focus after its value has been modified. This event will not emit when programmatically setting the `value` property. */ "onIonChange"?: (event: IonTextareaCustomEvent) => void; /** @@ -8028,7 +8028,7 @@ declare namespace LocalJSX { */ "onIonBlur"?: (event: IonToggleCustomEvent) => void; /** - * Emitted when the user switches the toggle on or off. Does not emit when programmatically changing the value of the `checked` property. + * Emitted when the user switches the toggle on or off. This event will not emit when programmatically setting the `checked` property. */ "onIonChange"?: (event: IonToggleCustomEvent) => void; /** diff --git a/core/src/components/accordion-group/accordion-group.tsx b/core/src/components/accordion-group/accordion-group.tsx index eeb99b42fb..b84d75b67a 100644 --- a/core/src/components/accordion-group/accordion-group.tsx +++ b/core/src/components/accordion-group/accordion-group.tsx @@ -59,10 +59,9 @@ export class AccordionGroup implements ComponentInterface { @Prop() expand: 'compact' | 'inset' = 'compact'; /** - * Emitted when the value property has changed - * as a result of a user action such as a click. - * This event will not emit when programmatically setting - * the value property. + * Emitted when the value property has changed as a result of a user action such as a click. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/checkbox/checkbox.tsx b/core/src/components/checkbox/checkbox.tsx index 57b0c5b77e..a1783c9aa9 100644 --- a/core/src/components/checkbox/checkbox.tsx +++ b/core/src/components/checkbox/checkbox.tsx @@ -97,10 +97,9 @@ export class Checkbox implements ComponentInterface { @Prop() alignment: 'start' | 'center' = 'center'; /** - * Emitted when the checked property has changed - * as a result of a user action such as a click. - * This event will not emit when programmatically - * setting the checked property. + * Emitted when the checked property has changed as a result of a user action such as a click. + * + * This event will not emit when programmatically setting the `checked` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index b11e949c4f..f6a46dd61d 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -477,6 +477,8 @@ export class Datetime implements ComponentInterface { /** * Emitted when the value (selected date) has changed. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/input/input.tsx b/core/src/components/input/input.tsx index 9e86ddfb76..16b791cfdb 100644 --- a/core/src/components/input/input.tsx +++ b/core/src/components/input/input.tsx @@ -296,6 +296,8 @@ export class Input implements ComponentInterface { * from a date picker for ``, pressing the "Enter" key, etc.). * - When the element loses focus after its value has changed: for elements * where the user's interaction is typing. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/picker-column/picker-column.tsx b/core/src/components/picker-column/picker-column.tsx index 81b24bc904..623038b1c7 100644 --- a/core/src/components/picker-column/picker-column.tsx +++ b/core/src/components/picker-column/picker-column.tsx @@ -66,6 +66,8 @@ export class PickerColumn implements ComponentInterface { /** * Emitted when the value has changed. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/radio-group/radio-group.tsx b/core/src/components/radio-group/radio-group.tsx index dce1c62616..c46156a2c9 100644 --- a/core/src/components/radio-group/radio-group.tsx +++ b/core/src/components/radio-group/radio-group.tsx @@ -47,6 +47,8 @@ export class RadioGroup implements ComponentInterface { /** * Emitted when the value has changed. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/range/range.tsx b/core/src/components/range/range.tsx index b9e19b3197..0ca33f6ca1 100644 --- a/core/src/components/range/range.tsx +++ b/core/src/components/range/range.tsx @@ -235,7 +235,7 @@ export class Range implements ComponentInterface { * - When the user releases the knob after dragging; * - When the user moves the knob with keyboard arrows * - * `ionChange` is not fired when the value is changed programmatically. + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/searchbar/searchbar.tsx b/core/src/components/searchbar/searchbar.tsx index f25bd2dfa2..20137c137c 100644 --- a/core/src/components/searchbar/searchbar.tsx +++ b/core/src/components/searchbar/searchbar.tsx @@ -225,6 +225,8 @@ export class Searchbar implements ComponentInterface { * by the user. This can happen when the element loses focus or * when the "Enter" key is pressed. `ionChange` can also fire * when clicking the clear or cancel buttons. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/segment/segment.tsx b/core/src/components/segment/segment.tsx index b3113c9de7..4b7913d76b 100644 --- a/core/src/components/segment/segment.tsx +++ b/core/src/components/segment/segment.tsx @@ -94,8 +94,9 @@ export class Segment implements ComponentInterface { @Prop() selectOnFocus = false; /** - * Emitted when the value property has changed and any - * dragging pointer has been released from `ion-segment`. + * Emitted when the value property has changed and any dragging pointer has been released from `ion-segment`. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/select/select.tsx b/core/src/components/select/select.tsx index 740adad020..e20edb9c06 100644 --- a/core/src/components/select/select.tsx +++ b/core/src/components/select/select.tsx @@ -197,6 +197,8 @@ export class Select implements ComponentInterface { /** * Emitted when the value has changed. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/textarea/textarea.tsx b/core/src/components/textarea/textarea.tsx index d13ec35630..09d66928cf 100644 --- a/core/src/components/textarea/textarea.tsx +++ b/core/src/components/textarea/textarea.tsx @@ -263,6 +263,8 @@ export class Textarea implements ComponentInterface { * The `ionChange` event is fired when the user modifies the textarea's value. * Unlike the `ionInput` event, the `ionChange` event is fired when * the element loses focus after its value has been modified. + * + * This event will not emit when programmatically setting the `value` property. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/toggle/toggle.tsx b/core/src/components/toggle/toggle.tsx index 47141252d2..41e2601518 100644 --- a/core/src/components/toggle/toggle.tsx +++ b/core/src/components/toggle/toggle.tsx @@ -107,8 +107,9 @@ export class Toggle implements ComponentInterface { @Prop() alignment: 'start' | 'center' = 'center'; /** - * Emitted when the user switches the toggle on or off. Does not emit - * when programmatically changing the value of the `checked` property. + * Emitted when the user switches the toggle on or off. + * + * This event will not emit when programmatically setting the `checked` property. */ @Event() ionChange!: EventEmitter; diff --git a/packages/angular/src/directives/proxies.ts b/packages/angular/src/directives/proxies.ts index 8253b0876f..868acb5fea 100644 --- a/packages/angular/src/directives/proxies.ts +++ b/packages/angular/src/directives/proxies.ts @@ -53,10 +53,9 @@ import type { AccordionGroupChangeEventDetail as IIonAccordionGroupAccordionGrou export declare interface IonAccordionGroup extends Components.IonAccordionGroup { /** - * Emitted when the value property has changed -as a result of a user action such as a click. -This event will not emit when programmatically setting -the value property. + * Emitted when the value property has changed as a result of a user action such as a click. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; } @@ -530,10 +529,9 @@ import type { CheckboxChangeEventDetail as IIonCheckboxCheckboxChangeEventDetail export declare interface IonCheckbox extends Components.IonCheckbox { /** - * Emitted when the checked property has changed -as a result of a user action such as a click. -This event will not emit when programmatically -setting the checked property. + * Emitted when the checked property has changed as a result of a user action such as a click. + +This event will not emit when programmatically setting the `checked` property. */ ionChange: EventEmitter>; /** @@ -664,6 +662,8 @@ export declare interface IonDatetime extends Components.IonDatetime { ionCancel: EventEmitter>; /** * Emitted when the value (selected date) has changed. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; /** @@ -1001,6 +1001,8 @@ event fires at a different moment: from a date picker for ``, pressing the "Enter" key, etc.). - When the element loses focus after its value has changed: for elements where the user's interaction is typing. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; /** @@ -1487,6 +1489,8 @@ import type { PickerColumnChangeEventDetail as IIonPickerColumnPickerColumnChang export declare interface IonPickerColumn extends Components.IonPickerColumn { /** * Emitted when the value has changed. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; } @@ -1656,6 +1660,8 @@ import type { RadioGroupChangeEventDetail as IIonRadioGroupRadioGroupChangeEvent export declare interface IonRadioGroup extends Components.IonRadioGroup { /** * Emitted when the value has changed. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; } @@ -1692,7 +1698,7 @@ modifies the element's value: - When the user releases the knob after dragging; - When the user moves the knob with keyboard arrows -`ionChange` is not fired when the value is changed programmatically. +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; /** @@ -1922,6 +1928,8 @@ The `ionChange` event is fired when the value has been committed by the user. This can happen when the element loses focus or when the "Enter" key is pressed. `ionChange` can also fire when clicking the clear or cancel buttons. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; /** @@ -1967,8 +1975,9 @@ import type { SegmentChangeEventDetail as IIonSegmentSegmentChangeEventDetail } export declare interface IonSegment extends Components.IonSegment { /** - * Emitted when the value property has changed and any -dragging pointer has been released from `ion-segment`. + * Emitted when the value property has changed and any dragging pointer has been released from `ion-segment`. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; } @@ -2022,6 +2031,8 @@ import type { SelectChangeEventDetail as IIonSelectSelectChangeEventDetail } fro export declare interface IonSelect extends Components.IonSelect { /** * Emitted when the value has changed. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; /** @@ -2232,6 +2243,8 @@ export declare interface IonTextarea extends Components.IonTextarea { * The `ionChange` event is fired when the user modifies the textarea's value. Unlike the `ionInput` event, the `ionChange` event is fired when the element loses focus after its value has been modified. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; /** @@ -2384,8 +2397,9 @@ import type { ToggleChangeEventDetail as IIonToggleToggleChangeEventDetail } fro export declare interface IonToggle extends Components.IonToggle { /** - * Emitted when the user switches the toggle on or off. Does not emit -when programmatically changing the value of the `checked` property. + * Emitted when the user switches the toggle on or off. + +This event will not emit when programmatically setting the `checked` property. */ ionChange: EventEmitter>; /** diff --git a/packages/angular/standalone/src/directives/proxies.ts b/packages/angular/standalone/src/directives/proxies.ts index c319aa5527..4f428def60 100644 --- a/packages/angular/standalone/src/directives/proxies.ts +++ b/packages/angular/standalone/src/directives/proxies.ts @@ -126,10 +126,9 @@ import type { AccordionGroupChangeEventDetail as IIonAccordionGroupAccordionGrou export declare interface IonAccordionGroup extends Components.IonAccordionGroup { /** - * Emitted when the value property has changed -as a result of a user action such as a click. -This event will not emit when programmatically setting -the value property. + * Emitted when the value property has changed as a result of a user action such as a click. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; } @@ -1486,6 +1485,8 @@ import type { PickerColumnChangeEventDetail as IIonPickerColumnPickerColumnChang export declare interface IonPickerColumn extends Components.IonPickerColumn { /** * Emitted when the value has changed. + +This event will not emit when programmatically setting the `value` property. */ ionChange: EventEmitter>; }