diff --git a/core/src/components.d.ts b/core/src/components.d.ts index 3ab34450f9..bcea90eeb2 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -943,7 +943,7 @@ export namespace Components { */ "size": 'cover' | 'fixed'; /** - * A callback used to format the header text that shows how many dates are selected. Only used if there are 0 or more than 1 selected (i.e. unused for exactly 1). By default, the header text is set to "numberOfDates days". + * A callback used to format the header text that shows how many dates are selected. Only used if there are 0 or more than 1 selected (i.e. unused for exactly 1). By default, the header text is set to "numberOfDates days". See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "titleSelectedDatesFormatter"?: TitleSelectedDatesFormatter; /** @@ -1182,7 +1182,7 @@ export namespace Components { */ "counter": boolean; /** - * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". + * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "counterFormatter"?: (inputLength: number, maxLength: number) => string; /** @@ -1701,7 +1701,7 @@ export namespace Components { */ "breakpoints"?: number[]; /** - * Determines whether or not a modal can dismiss when calling the `dismiss` method. If the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss. If the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss. + * Determines whether or not a modal can dismiss when calling the `dismiss` method. If the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss. If the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss. See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "canDismiss": boolean | ((data?: any, role?: string) => Promise); /** @@ -2336,7 +2336,7 @@ export namespace Components { */ "pin": boolean; /** - * A callback used to format the pin text. By default the pin text is set to `Math.round(value)`. + * A callback used to format the pin text. By default the pin text is set to `Math.round(value)`. See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "pinFormatter": PinFormatter; /** @@ -2978,7 +2978,7 @@ export namespace Components { */ "counter": boolean; /** - * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". + * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "counterFormatter"?: (inputLength: number, maxLength: number) => string; /** @@ -5650,7 +5650,7 @@ declare namespace LocalJSX { */ "size"?: 'cover' | 'fixed'; /** - * A callback used to format the header text that shows how many dates are selected. Only used if there are 0 or more than 1 selected (i.e. unused for exactly 1). By default, the header text is set to "numberOfDates days". + * A callback used to format the header text that shows how many dates are selected. Only used if there are 0 or more than 1 selected (i.e. unused for exactly 1). By default, the header text is set to "numberOfDates days". See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "titleSelectedDatesFormatter"?: TitleSelectedDatesFormatter; /** @@ -5901,7 +5901,7 @@ declare namespace LocalJSX { */ "counter"?: boolean; /** - * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". + * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "counterFormatter"?: (inputLength: number, maxLength: number) => string; /** @@ -6432,7 +6432,7 @@ declare namespace LocalJSX { */ "breakpoints"?: number[]; /** - * Determines whether or not a modal can dismiss when calling the `dismiss` method. If the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss. If the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss. + * Determines whether or not a modal can dismiss when calling the `dismiss` method. If the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss. If the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss. See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "canDismiss"?: boolean | ((data?: any, role?: string) => Promise); /** @@ -7064,7 +7064,7 @@ declare namespace LocalJSX { */ "pin"?: boolean; /** - * A callback used to format the pin text. By default the pin text is set to `Math.round(value)`. + * A callback used to format the pin text. By default the pin text is set to `Math.round(value)`. See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "pinFormatter"?: PinFormatter; /** @@ -7758,7 +7758,7 @@ declare namespace LocalJSX { */ "counter"?: boolean; /** - * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". + * A callback used to format the counter text. By default the counter text is set to "itemLength / maxLength". See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this if you need to access `this` from within the callback. */ "counterFormatter"?: (inputLength: number, maxLength: number) => string; /** diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index bffcc8942c..77a8727f64 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -341,6 +341,9 @@ export class Datetime implements ComponentInterface { * dates are selected. Only used if there are 0 or more than 1 * selected (i.e. unused for exactly 1). By default, the header * text is set to "numberOfDates days". + * + * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this + * if you need to access `this` from within the callback. */ @Prop() titleSelectedDatesFormatter?: TitleSelectedDatesFormatter; diff --git a/core/src/components/input/input.tsx b/core/src/components/input/input.tsx index d28cfd385c..3607b10322 100644 --- a/core/src/components/input/input.tsx +++ b/core/src/components/input/input.tsx @@ -121,6 +121,9 @@ export class Input implements ComponentInterface { /** * A callback used to format the counter text. * By default the counter text is set to "itemLength / maxLength". + * + * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this + * if you need to access `this` from within the callback. */ @Prop() counterFormatter?: (inputLength: number, maxLength: number) => string; diff --git a/core/src/components/modal/modal.tsx b/core/src/components/modal/modal.tsx index ef6114b18b..bae8648d76 100644 --- a/core/src/components/modal/modal.tsx +++ b/core/src/components/modal/modal.tsx @@ -264,6 +264,9 @@ export class Modal implements ComponentInterface, OverlayInterface { * * If the value is `true` or the value's function returns `true`, the modal will close when trying to dismiss. * If the value is `false` or the value's function returns `false`, the modal will not close when trying to dismiss. + * + * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this + * if you need to access `this` from within the callback. */ @Prop() canDismiss: boolean | ((data?: any, role?: string) => Promise) = true; diff --git a/core/src/components/range/range.tsx b/core/src/components/range/range.tsx index 5b017cf464..1df4ed9c3f 100644 --- a/core/src/components/range/range.tsx +++ b/core/src/components/range/range.tsx @@ -141,6 +141,9 @@ export class Range implements ComponentInterface { /** * A callback used to format the pin text. * By default the pin text is set to `Math.round(value)`. + * + * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this + * if you need to access `this` from within the callback. */ @Prop() pinFormatter: PinFormatter = (value: number): number => Math.round(value); diff --git a/core/src/components/textarea/textarea.tsx b/core/src/components/textarea/textarea.tsx index 83557d3254..6684d09906 100644 --- a/core/src/components/textarea/textarea.tsx +++ b/core/src/components/textarea/textarea.tsx @@ -222,6 +222,9 @@ export class Textarea implements ComponentInterface { /** * A callback used to format the counter text. * By default the counter text is set to "itemLength / maxLength". + * + * See https://ionicframework.com/docs/troubleshooting/runtime#accessing-this + * if you need to access `this` from within the callback. */ @Prop() counterFormatter?: (inputLength: number, maxLength: number) => string;