From 67578f6246494bb79fe816faffdf25261ff024e6 Mon Sep 17 00:00:00 2001 From: Sean Perkins Date: Tue, 28 Feb 2023 21:16:15 -0500 Subject: [PATCH] chore: format string values in comments with double quotes (#26857) --- core/src/components.d.ts | 104 +++++++++--------- core/src/components/accordion/accordion.tsx | 2 +- core/src/components/checkbox/checkbox.tsx | 12 +- core/src/components/datetime/datetime.tsx | 14 +-- core/src/components/input/input.tsx | 14 +-- core/src/components/item/item.tsx | 4 +- core/src/components/popover/popover.tsx | 20 ++-- core/src/components/radio/radio.tsx | 12 +- core/src/components/range/range.tsx | 6 +- core/src/components/select/select.tsx | 26 ++--- core/src/components/tab-button/tab-button.tsx | 2 +- core/src/components/textarea/textarea.tsx | 14 +-- core/src/components/toggle/toggle.tsx | 12 +- 13 files changed, 121 insertions(+), 121 deletions(-) diff --git a/core/src/components.d.ts b/core/src/components.d.ts index 28f156e818..f6a5f06361 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -96,7 +96,7 @@ export namespace Components { */ "toggleIcon": string; /** - * The slot inside of `ion-item` to place the toggle icon. Defaults to `'end'`. + * The slot inside of `ion-item` to place the toggle icon. Defaults to `"end"`. */ "toggleIconSlot": 'start' | 'end'; /** @@ -619,11 +619,11 @@ export namespace Components { */ "indeterminate": boolean; /** - * How to pack the label and checkbox within a line. `'start'`: The label and checkbox will appear on the left in LTR and on the right in RTL. `'end'`: The label and checkbox will appear on the right in LTR and on the left in RTL. `'space-between'`: The label and checkbox will appear on opposite ends of the line with space between the two elements. + * How to pack the label and checkbox within a line. `"start"`: The label and checkbox will appear on the left in LTR and on the right in RTL. `"end"`: The label and checkbox will appear on the right in LTR and on the left in RTL. `"space-between"`: The label and checkbox will appear on opposite ends of the line with space between the two elements. */ "justify": 'start' | 'end' | 'space-between'; /** - * Where to place the label relative to the checkbox. `'start'`: The label will appear to the left of the checkbox in LTR and to the right in RTL. `'end'`: The label will appear to the right of the checkbox in LTR and to the left in RTL. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the checkbox. `"start"`: The label will appear to the left of the checkbox in LTR and to the right in RTL. `"end"`: The label will appear to the right of the checkbox in LTR and to the left in RTL. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement": 'start' | 'end' | 'fixed'; /** @@ -867,7 +867,7 @@ export namespace Components { */ "isDateEnabled"?: (dateIsoString: string) => boolean; /** - * The locale to use for `ion-datetime`. This impacts month and day name formatting. The `'default'` value refers to the default locale set by your device. + * The locale to use for `ion-datetime`. This impacts month and day name formatting. The `"default"` value refers to the default locale set by your device. */ "locale": string; /** @@ -899,11 +899,11 @@ export namespace Components { */ "name": string; /** - * If `true`, a wheel picker will be rendered instead of a calendar grid where possible. If `false`, a calendar grid will be rendered instead of a wheel picker where possible. A wheel picker can be rendered instead of a grid when `presentation` is one of the following values: `'date'`, `'date-time'`, or `'time-date'`. A wheel picker will always be rendered regardless of the `preferWheel` value when `presentation` is one of the following values: `'time'`, `'month'`, `'month-year'`, or `'year'`. + * If `true`, a wheel picker will be rendered instead of a calendar grid where possible. If `false`, a calendar grid will be rendered instead of a wheel picker where possible. A wheel picker can be rendered instead of a grid when `presentation` is one of the following values: `"date"`, `"date-time"`, or `"time-date"`. A wheel picker will always be rendered regardless of the `preferWheel` value when `presentation` is one of the following values: `"time"`, `"month"`, `"month-year"`, or `"year"`. */ "preferWheel": boolean; /** - * Which values you want to select. `'date'` will show a calendar picker to select the month, day, and year. `'time'` will show a time picker to select the hour, minute, and (optionally) AM/PM. `'date-time'` will show the date picker first and time picker second. `'time-date'` will show the time picker first and date picker second. + * Which values you want to select. `"date"` will show a calendar picker to select the month, day, and year. `"time"` will show a time picker to select the hour, minute, and (optionally) AM/PM. `"date-time"` will show the date picker first and time picker second. `"time-date"` will show the time picker first and date picker second. */ "presentation": DatetimePresentation; /** @@ -1194,7 +1194,7 @@ export namespace Components { */ "errorText"?: string; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -1214,7 +1214,7 @@ export namespace Components { */ "label"?: string; /** - * Where to place the label relative to the input. `'start'`: The label will appear to the left of the input in LTR and to the right in RTL. `'end'`: The label will appear to the right of the input in LTR and to the left in RTL. `'floating'`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. `'stacked'`: The label will appear smaller and above the input regardless even when the input 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 ("..."). + * Where to place the label relative to the input. `"start"`: The label will appear to the left of the input in LTR and to the right in RTL. `"end"`: The label will appear to the right of the input in LTR and to the left in RTL. `"floating"`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. `"stacked"`: The label will appear smaller and above the input regardless even when the input 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 ("..."). */ "labelPlacement": 'start' | 'end' | 'floating' | 'stacked' | 'fixed'; /** @@ -1330,7 +1330,7 @@ export namespace Components { */ "download": string | undefined; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -2068,7 +2068,7 @@ export namespace Components { } interface IonPopover { /** - * Describes how to align the popover content with the `reference` point. Defaults to `'center'` for `ios` mode, and `'start'` for `md` mode. + * Describes how to align the popover content with the `reference` point. Defaults to `"center"` for `ios` mode, and `"start"` for `md` mode. */ "alignment"?: PositionAlign; /** @@ -2160,7 +2160,7 @@ export namespace Components { */ "presentFromTrigger": (event?: any, focusDescendant?: boolean) => Promise; /** - * Describes what to position the popover relative to. If `'trigger'`, the popover will be positioned relative to the trigger button. If passing in an event, this is determined via event.target. If `'event'`, the popover will be positioned relative to the x/y coordinates of the trigger action. If passing in an event, this is determined via event.clientX and event.clientY. + * Describes what to position the popover relative to. If `"trigger"`, the popover will be positioned relative to the trigger button. If passing in an event, this is determined via event.target. If `"event"`, the popover will be positioned relative to the x/y coordinates of the trigger action. If passing in an event, this is determined via event.clientX and event.clientY. */ "reference": PositionReference; /** @@ -2168,11 +2168,11 @@ export namespace Components { */ "showBackdrop": boolean; /** - * Describes which side of the `reference` point to position the popover on. The `'start'` and `'end'` values are RTL-aware, and the `'left'` and `'right'` values are not. + * Describes which side of the `reference` point to position the popover on. The `"start"` and `"end"` values are RTL-aware, and the `"left"` and `"right"` values are not. */ "side": PositionSide; /** - * Describes how to calculate the popover width. If `'cover'`, the popover width will match the width of the trigger. If `'auto'`, the popover width will be determined by the content in the popover. + * Describes how to calculate the popover width. If `"cover"`, the popover width will match the width of the trigger. If `"auto"`, the popover width will be determined by the content in the popover. */ "size": PopoverSize; /** @@ -2184,7 +2184,7 @@ export namespace Components { */ "trigger": string | undefined; /** - * Describes what kind of interaction with the trigger that should cause the popover to open. Does not apply when the `trigger` property is `undefined`. If `'click'`, the popover will be presented when the trigger is left clicked. If `'hover'`, the popover will be presented when a pointer hovers over the trigger. If `'context-menu'`, the popover will be presented when the trigger is right clicked on desktop and long pressed on mobile. This will also prevent your device's normal context menu from appearing. + * Describes what kind of interaction with the trigger that should cause the popover to open. Does not apply when the `trigger` property is `undefined`. If `"click"`, the popover will be presented when the trigger is left clicked. If `"hover"`, the popover will be presented when a pointer hovers over the trigger. If `"context-menu"`, the popover will be presented when the trigger is right clicked on desktop and long pressed on mobile. This will also prevent your device's normal context menu from appearing. */ "triggerAction": TriggerAction; } @@ -2224,11 +2224,11 @@ export namespace Components { */ "disabled": boolean; /** - * How to pack the label and radio 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. + * How to pack the label and radio 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. */ "justify": 'start' | 'end' | 'space-between'; /** - * Where to place the label relative to the radio. `'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. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the radio. `"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. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement": 'start' | 'end' | 'fixed'; /** @@ -2286,7 +2286,7 @@ export namespace Components { */ "dualKnobs": boolean; /** - * Where to place the label relative to the range. `'start'`: The label will appear to the left of the range in LTR and to the right in RTL. `'end'`: The label will appear to the right of the range in LTR and to the left in RTL. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the range. `"start"`: The label will appear to the left of the range in LTR and to the right in RTL. `"end"`: The label will appear to the right of the range in LTR and to the left in RTL. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement": 'start' | 'end' | 'fixed'; /** @@ -2674,7 +2674,7 @@ export namespace Components { */ "disabled": boolean; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -2686,7 +2686,7 @@ export namespace Components { */ "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. + * 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. */ "justify": 'start' | 'end' | 'space-between'; /** @@ -2694,7 +2694,7 @@ export namespace Components { */ "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`. + * 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`. */ "labelPlacement"?: 'start' | 'end' | 'floating' | 'stacked' | 'fixed'; /** @@ -2735,7 +2735,7 @@ export namespace Components { */ "shape"?: 'round'; /** - * the value of the select. + * The value of the select. */ "value"?: any | null; } @@ -2857,7 +2857,7 @@ export namespace Components { */ "href": string | undefined; /** - * Set the layout of the text and icon in the tab bar. It defaults to `'icon-top'`. + * Set the layout of the text and icon in the tab bar. It defaults to `"icon-top"`. */ "layout"?: TabButtonLayout; /** @@ -2960,7 +2960,7 @@ export namespace Components { */ "errorText"?: string; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -2980,7 +2980,7 @@ export namespace Components { */ "label"?: string; /** - * Where to place the label relative to the textarea. `'start'`: The label will appear to the left of the textarea in LTR and to the right in RTL. `'end'`: The label will appear to the right of the textarea in LTR and to the left in RTL. `'floating'`: The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. `'stacked'`: The label will appear smaller and above the textarea regardless even when the textarea 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 ("..."). + * Where to place the label relative to the textarea. `"start"`: The label will appear to the left of the textarea in LTR and to the right in RTL. `"end"`: The label will appear to the right of the textarea in LTR and to the left in RTL. `"floating"`: The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. `"stacked"`: The label will appear smaller and above the textarea regardless even when the textarea 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 ("..."). */ "labelPlacement": 'start' | 'end' | 'floating' | 'stacked' | 'fixed'; /** @@ -3161,11 +3161,11 @@ export namespace Components { */ "enableOnOffLabels": boolean | undefined; /** - * How to pack the label and toggle within a line. `'start'`: The label and toggle will appear on the left in LTR and on the right in RTL. `'end'`: The label and toggle will appear on the right in LTR and on the left in RTL. `'space-between'`: The label and toggle will appear on opposite ends of the line with space between the two elements. + * How to pack the label and toggle within a line. `"start"`: The label and toggle will appear on the left in LTR and on the right in RTL. `"end"`: The label and toggle will appear on the right in LTR and on the left in RTL. `"space-between"`: The label and toggle will appear on opposite ends of the line with space between the two elements. */ "justify": 'start' | 'end' | 'space-between'; /** - * Where to place the label relative to the input. `'start'`: The label will appear to the left of the toggle in LTR and to the right in RTL. `'end'`: The label will appear to the right of the toggle in LTR and to the left in RTL. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the input. `"start"`: The label will appear to the left of the toggle in LTR and to the right in RTL. `"end"`: The label will appear to the right of the toggle in LTR and to the left in RTL. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement": 'start' | 'end' | 'fixed'; /** @@ -4040,7 +4040,7 @@ declare namespace LocalJSX { */ "toggleIcon"?: string; /** - * The slot inside of `ion-item` to place the toggle icon. Defaults to `'end'`. + * The slot inside of `ion-item` to place the toggle icon. Defaults to `"end"`. */ "toggleIconSlot"?: 'start' | 'end'; /** @@ -4621,11 +4621,11 @@ declare namespace LocalJSX { */ "indeterminate"?: boolean; /** - * How to pack the label and checkbox within a line. `'start'`: The label and checkbox will appear on the left in LTR and on the right in RTL. `'end'`: The label and checkbox will appear on the right in LTR and on the left in RTL. `'space-between'`: The label and checkbox will appear on opposite ends of the line with space between the two elements. + * How to pack the label and checkbox within a line. `"start"`: The label and checkbox will appear on the left in LTR and on the right in RTL. `"end"`: The label and checkbox will appear on the right in LTR and on the left in RTL. `"space-between"`: The label and checkbox will appear on opposite ends of the line with space between the two elements. */ "justify"?: 'start' | 'end' | 'space-between'; /** - * Where to place the label relative to the checkbox. `'start'`: The label will appear to the left of the checkbox in LTR and to the right in RTL. `'end'`: The label will appear to the right of the checkbox in LTR and to the left in RTL. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the checkbox. `"start"`: The label will appear to the left of the checkbox in LTR and to the right in RTL. `"end"`: The label will appear to the right of the checkbox in LTR and to the left in RTL. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement"?: 'start' | 'end' | 'fixed'; /** @@ -4857,7 +4857,7 @@ declare namespace LocalJSX { */ "isDateEnabled"?: (dateIsoString: string) => boolean; /** - * The locale to use for `ion-datetime`. This impacts month and day name formatting. The `'default'` value refers to the default locale set by your device. + * The locale to use for `ion-datetime`. This impacts month and day name formatting. The `"default"` value refers to the default locale set by your device. */ "locale"?: string; /** @@ -4917,11 +4917,11 @@ declare namespace LocalJSX { */ "onIonValueChange"?: (event: IonDatetimeCustomEvent) => void; /** - * If `true`, a wheel picker will be rendered instead of a calendar grid where possible. If `false`, a calendar grid will be rendered instead of a wheel picker where possible. A wheel picker can be rendered instead of a grid when `presentation` is one of the following values: `'date'`, `'date-time'`, or `'time-date'`. A wheel picker will always be rendered regardless of the `preferWheel` value when `presentation` is one of the following values: `'time'`, `'month'`, `'month-year'`, or `'year'`. + * If `true`, a wheel picker will be rendered instead of a calendar grid where possible. If `false`, a calendar grid will be rendered instead of a wheel picker where possible. A wheel picker can be rendered instead of a grid when `presentation` is one of the following values: `"date"`, `"date-time"`, or `"time-date"`. A wheel picker will always be rendered regardless of the `preferWheel` value when `presentation` is one of the following values: `"time"`, `"month"`, `"month-year"`, or `"year"`. */ "preferWheel"?: boolean; /** - * Which values you want to select. `'date'` will show a calendar picker to select the month, day, and year. `'time'` will show a time picker to select the hour, minute, and (optionally) AM/PM. `'date-time'` will show the date picker first and time picker second. `'time-date'` will show the time picker first and date picker second. + * Which values you want to select. `"date"` will show a calendar picker to select the month, day, and year. `"time"` will show a time picker to select the hour, minute, and (optionally) AM/PM. `"date-time"` will show the date picker first and time picker second. `"time-date"` will show the time picker first and date picker second. */ "presentation"?: DatetimePresentation; /** @@ -5220,7 +5220,7 @@ declare namespace LocalJSX { */ "errorText"?: string; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -5236,7 +5236,7 @@ declare namespace LocalJSX { */ "label"?: string; /** - * Where to place the label relative to the input. `'start'`: The label will appear to the left of the input in LTR and to the right in RTL. `'end'`: The label will appear to the right of the input in LTR and to the left in RTL. `'floating'`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. `'stacked'`: The label will appear smaller and above the input regardless even when the input 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 ("..."). + * Where to place the label relative to the input. `"start"`: The label will appear to the left of the input in LTR and to the right in RTL. `"end"`: The label will appear to the right of the input in LTR and to the left in RTL. `"floating"`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. `"stacked"`: The label will appear smaller and above the input regardless even when the input 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 ("..."). */ "labelPlacement"?: 'start' | 'end' | 'floating' | 'stacked' | 'fixed'; /** @@ -5368,7 +5368,7 @@ declare namespace LocalJSX { */ "download"?: string | undefined; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -6041,7 +6041,7 @@ declare namespace LocalJSX { } interface IonPopover { /** - * Describes how to align the popover content with the `reference` point. Defaults to `'center'` for `ios` mode, and `'start'` for `md` mode. + * Describes how to align the popover content with the `reference` point. Defaults to `"center"` for `ios` mode, and `"start"` for `md` mode. */ "alignment"?: PositionAlign; /** @@ -6145,7 +6145,7 @@ declare namespace LocalJSX { "onWillPresent"?: (event: IonPopoverCustomEvent) => void; "overlayIndex": number; /** - * Describes what to position the popover relative to. If `'trigger'`, the popover will be positioned relative to the trigger button. If passing in an event, this is determined via event.target. If `'event'`, the popover will be positioned relative to the x/y coordinates of the trigger action. If passing in an event, this is determined via event.clientX and event.clientY. + * Describes what to position the popover relative to. If `"trigger"`, the popover will be positioned relative to the trigger button. If passing in an event, this is determined via event.target. If `"event"`, the popover will be positioned relative to the x/y coordinates of the trigger action. If passing in an event, this is determined via event.clientX and event.clientY. */ "reference"?: PositionReference; /** @@ -6153,11 +6153,11 @@ declare namespace LocalJSX { */ "showBackdrop"?: boolean; /** - * Describes which side of the `reference` point to position the popover on. The `'start'` and `'end'` values are RTL-aware, and the `'left'` and `'right'` values are not. + * Describes which side of the `reference` point to position the popover on. The `"start"` and `"end"` values are RTL-aware, and the `"left"` and `"right"` values are not. */ "side"?: PositionSide; /** - * Describes how to calculate the popover width. If `'cover'`, the popover width will match the width of the trigger. If `'auto'`, the popover width will be determined by the content in the popover. + * Describes how to calculate the popover width. If `"cover"`, the popover width will match the width of the trigger. If `"auto"`, the popover width will be determined by the content in the popover. */ "size"?: PopoverSize; /** @@ -6169,7 +6169,7 @@ declare namespace LocalJSX { */ "trigger"?: string | undefined; /** - * Describes what kind of interaction with the trigger that should cause the popover to open. Does not apply when the `trigger` property is `undefined`. If `'click'`, the popover will be presented when the trigger is left clicked. If `'hover'`, the popover will be presented when a pointer hovers over the trigger. If `'context-menu'`, the popover will be presented when the trigger is right clicked on desktop and long pressed on mobile. This will also prevent your device's normal context menu from appearing. + * Describes what kind of interaction with the trigger that should cause the popover to open. Does not apply when the `trigger` property is `undefined`. If `"click"`, the popover will be presented when the trigger is left clicked. If `"hover"`, the popover will be presented when a pointer hovers over the trigger. If `"context-menu"`, the popover will be presented when the trigger is right clicked on desktop and long pressed on mobile. This will also prevent your device's normal context menu from appearing. */ "triggerAction"?: TriggerAction; } @@ -6209,11 +6209,11 @@ declare namespace LocalJSX { */ "disabled"?: boolean; /** - * How to pack the label and radio 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. + * How to pack the label and radio 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. */ "justify"?: 'start' | 'end' | 'space-between'; /** - * Where to place the label relative to the radio. `'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. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the radio. `"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. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement"?: 'start' | 'end' | 'fixed'; /** @@ -6289,7 +6289,7 @@ declare namespace LocalJSX { */ "dualKnobs"?: boolean; /** - * Where to place the label relative to the range. `'start'`: The label will appear to the left of the range in LTR and to the right in RTL. `'end'`: The label will appear to the right of the range in LTR and to the left in RTL. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the range. `"start"`: The label will appear to the left of the range in LTR and to the right in RTL. `"end"`: The label will appear to the right of the range in LTR and to the left in RTL. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement"?: 'start' | 'end' | 'fixed'; /** @@ -6732,7 +6732,7 @@ declare namespace LocalJSX { */ "disabled"?: boolean; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -6744,7 +6744,7 @@ declare namespace LocalJSX { */ "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. + * 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. */ "justify"?: 'start' | 'end' | 'space-between'; /** @@ -6752,7 +6752,7 @@ declare namespace LocalJSX { */ "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`. + * 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`. */ "labelPlacement"?: 'start' | 'end' | 'floating' | 'stacked' | 'fixed'; /** @@ -6812,7 +6812,7 @@ declare namespace LocalJSX { */ "shape"?: 'round'; /** - * the value of the select. + * The value of the select. */ "value"?: any | null; } @@ -6935,7 +6935,7 @@ declare namespace LocalJSX { */ "href"?: string | undefined; /** - * Set the layout of the text and icon in the tab bar. It defaults to `'icon-top'`. + * Set the layout of the text and icon in the tab bar. It defaults to `"icon-top"`. */ "layout"?: TabButtonLayout; /** @@ -7038,7 +7038,7 @@ declare namespace LocalJSX { */ "errorText"?: string; /** - * 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. + * 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. */ "fill"?: 'outline' | 'solid'; /** @@ -7054,7 +7054,7 @@ declare namespace LocalJSX { */ "label"?: string; /** - * Where to place the label relative to the textarea. `'start'`: The label will appear to the left of the textarea in LTR and to the right in RTL. `'end'`: The label will appear to the right of the textarea in LTR and to the left in RTL. `'floating'`: The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. `'stacked'`: The label will appear smaller and above the textarea regardless even when the textarea 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 ("..."). + * Where to place the label relative to the textarea. `"start"`: The label will appear to the left of the textarea in LTR and to the right in RTL. `"end"`: The label will appear to the right of the textarea in LTR and to the left in RTL. `"floating"`: The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. `"stacked"`: The label will appear smaller and above the textarea regardless even when the textarea 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 ("..."). */ "labelPlacement"?: 'start' | 'end' | 'floating' | 'stacked' | 'fixed'; /** @@ -7269,11 +7269,11 @@ declare namespace LocalJSX { */ "enableOnOffLabels"?: boolean | undefined; /** - * How to pack the label and toggle within a line. `'start'`: The label and toggle will appear on the left in LTR and on the right in RTL. `'end'`: The label and toggle will appear on the right in LTR and on the left in RTL. `'space-between'`: The label and toggle will appear on opposite ends of the line with space between the two elements. + * How to pack the label and toggle within a line. `"start"`: The label and toggle will appear on the left in LTR and on the right in RTL. `"end"`: The label and toggle will appear on the right in LTR and on the left in RTL. `"space-between"`: The label and toggle will appear on opposite ends of the line with space between the two elements. */ "justify"?: 'start' | 'end' | 'space-between'; /** - * Where to place the label relative to the input. `'start'`: The label will appear to the left of the toggle in LTR and to the right in RTL. `'end'`: The label will appear to the right of the toggle in LTR and to the left in RTL. `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * Where to place the label relative to the input. `"start"`: The label will appear to the left of the toggle in LTR and to the right in RTL. `"end"`: The label will appear to the right of the toggle in LTR and to the left in RTL. `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ "labelPlacement"?: 'start' | 'end' | 'fixed'; /** diff --git a/core/src/components/accordion/accordion.tsx b/core/src/components/accordion/accordion.tsx index 2d792c01f8..8da0a312ff 100644 --- a/core/src/components/accordion/accordion.tsx +++ b/core/src/components/accordion/accordion.tsx @@ -77,7 +77,7 @@ export class Accordion implements ComponentInterface { /** * The slot inside of `ion-item` to - * place the toggle icon. Defaults to `'end'`. + * place the toggle icon. Defaults to `"end"`. */ @Prop() toggleIconSlot: 'start' | 'end' = 'end'; diff --git a/core/src/components/checkbox/checkbox.tsx b/core/src/components/checkbox/checkbox.tsx index 346a7adac8..74c703e328 100644 --- a/core/src/components/checkbox/checkbox.tsx +++ b/core/src/components/checkbox/checkbox.tsx @@ -79,19 +79,19 @@ export class Checkbox implements ComponentInterface { /** * Where to place the label relative to the checkbox. - * `'start'`: The label will appear to the left of the checkbox in LTR and to the right in RTL. - * `'end'`: The label will appear to the right of the checkbox in LTR and to the left in RTL. - * `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * `"start"`: The label will appear to the left of the checkbox in LTR and to the right in RTL. + * `"end"`: The label will appear to the right of the checkbox in LTR and to the left in RTL. + * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ @Prop() labelPlacement: 'start' | 'end' | 'fixed' = 'start'; /** * How to pack the label and checkbox within a line. - * `'start'`: The label and checkbox will appear on the left in LTR and + * `"start"`: The label and checkbox will appear on the left in LTR and * on the right in RTL. - * `'end'`: The label and checkbox will appear on the right in LTR and + * `"end"`: The label and checkbox will appear on the right in LTR and * on the left in RTL. - * `'space-between'`: The label and checkbox will appear on opposite + * `"space-between"`: The label and checkbox will appear on opposite * ends of the line with space between the two elements. */ @Prop() justify: 'start' | 'end' | 'space-between' = 'space-between'; diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index 12a8556a63..17a24fbdea 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -199,11 +199,11 @@ export class Datetime implements ComponentInterface { } /** - * Which values you want to select. `'date'` will show - * a calendar picker to select the month, day, and year. `'time'` + * Which values you want to select. `"date"` will show + * a calendar picker to select the month, day, and year. `"time"` * will show a time picker to select the hour, minute, and (optionally) - * AM/PM. `'date-time'` will show the date picker first and time picker second. - * `'time-date'` will show the time picker first and date picker second. + * AM/PM. `"date-time"` will show the date picker first and time picker second. + * `"time-date"` will show the time picker first and date picker second. */ @Prop() presentation: DatetimePresentation = 'date-time'; @@ -296,7 +296,7 @@ export class Datetime implements ComponentInterface { /** * The locale to use for `ion-datetime`. This * impacts month and day name formatting. - * The `'default'` value refers to the default + * The `"default"` value refers to the default * locale set by your device. */ @Prop() locale = 'default'; @@ -440,11 +440,11 @@ export class Datetime implements ComponentInterface { * a wheel picker where possible. * * A wheel picker can be rendered instead of a grid when `presentation` is - * one of the following values: `'date'`, `'date-time'`, or `'time-date'`. + * one of the following values: `"date"`, `"date-time"`, or `"time-date"`. * * A wheel picker will always be rendered regardless of * the `preferWheel` value when `presentation` is one of the following values: - * `'time'`, `'month'`, `'month-year'`, or `'year'`. + * `"time"`, `"month"`, `"month-year"`, or `"year"`. */ @Prop() preferWheel = false; diff --git a/core/src/components/input/input.tsx b/core/src/components/input/input.tsx index 6d9e8b4177..d360a7d871 100644 --- a/core/src/components/input/input.tsx +++ b/core/src/components/input/input.tsx @@ -146,8 +146,8 @@ export class Input implements ComponentInterface { @Prop() errorText?: string; /** - * 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. + * 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'; @@ -170,11 +170,11 @@ export class Input implements ComponentInterface { /** * Where to place the label relative to the input. - * `'start'`: The label will appear to the left of the input in LTR and to the right in RTL. - * `'end'`: The label will appear to the right of the input in LTR and to the left in RTL. - * `'floating'`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. - * `'stacked'`: The label will appear smaller and above the input regardless even when the input 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 ("..."). + * `"start"`: The label will appear to the left of the input in LTR and to the right in RTL. + * `"end"`: The label will appear to the right of the input in LTR and to the left in RTL. + * `"floating"`: The label will appear smaller and above the input when the input is focused or it has a value. Otherwise it will appear on top of the input. + * `"stacked"`: The label will appear smaller and above the input regardless even when the input 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 ("..."). */ @Prop() labelPlacement: 'start' | 'end' | 'floating' | 'stacked' | 'fixed' = 'start'; diff --git a/core/src/components/item/item.tsx b/core/src/components/item/item.tsx index 62c64ed0db..3db4589d9d 100644 --- a/core/src/components/item/item.tsx +++ b/core/src/components/item/item.tsx @@ -83,8 +83,8 @@ export class Item implements ComponentInterface, AnchorInterface, ButtonInterfac @Prop() download: string | undefined; /** - * 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. + * 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'; diff --git a/core/src/components/popover/popover.tsx b/core/src/components/popover/popover.tsx index 7aa701c452..f93c6507b5 100644 --- a/core/src/components/popover/popover.tsx +++ b/core/src/components/popover/popover.tsx @@ -155,9 +155,9 @@ export class Popover implements ComponentInterface, PopoverInterface { * Describes what kind of interaction with the trigger that * should cause the popover to open. Does not apply when the `trigger` * property is `undefined`. - * If `'click'`, the popover will be presented when the trigger is left clicked. - * If `'hover'`, the popover will be presented when a pointer hovers over the trigger. - * If `'context-menu'`, the popover will be presented when the trigger is right + * If `"click"`, the popover will be presented when the trigger is left clicked. + * If `"hover"`, the popover will be presented when a pointer hovers over the trigger. + * If `"context-menu"`, the popover will be presented when the trigger is right * clicked on desktop and long pressed on mobile. This will also prevent your * device's normal context menu from appearing. */ @@ -173,8 +173,8 @@ export class Popover implements ComponentInterface, PopoverInterface { /** * Describes how to calculate the popover width. - * If `'cover'`, the popover width will match the width of the trigger. - * If `'auto'`, the popover width will be determined by the content in + * If `"cover"`, the popover width will match the width of the trigger. + * If `"auto"`, the popover width will be determined by the content in * the popover. */ @Prop() size: PopoverSize = 'auto'; @@ -187,10 +187,10 @@ export class Popover implements ComponentInterface, PopoverInterface { /** * Describes what to position the popover relative to. - * If `'trigger'`, the popover will be positioned relative + * If `"trigger"`, the popover will be positioned relative * to the trigger button. If passing in an event, this is * determined via event.target. - * If `'event'`, the popover will be positioned relative + * If `"event"`, the popover will be positioned relative * to the x/y coordinates of the trigger action. If passing * in an event, this is determined via event.clientX and event.clientY. */ @@ -198,14 +198,14 @@ export class Popover implements ComponentInterface, PopoverInterface { /** * Describes which side of the `reference` point to position - * the popover on. The `'start'` and `'end'` values are RTL-aware, - * and the `'left'` and `'right'` values are not. + * the popover on. The `"start"` and `"end"` values are RTL-aware, + * and the `"left"` and `"right"` values are not. */ @Prop() side: PositionSide = 'bottom'; /** * Describes how to align the popover content with the `reference` point. - * Defaults to `'center'` for `ios` mode, and `'start'` for `md` mode. + * Defaults to `"center"` for `ios` mode, and `"start"` for `md` mode. */ @Prop({ mutable: true }) alignment?: PositionAlign; diff --git a/core/src/components/radio/radio.tsx b/core/src/components/radio/radio.tsx index 3de5f61891..ace33db225 100644 --- a/core/src/components/radio/radio.tsx +++ b/core/src/components/radio/radio.tsx @@ -73,9 +73,9 @@ export class Radio implements ComponentInterface { /** * Where to place the label relative to the radio. - * `'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. - * `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * `"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. + * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ @Prop() labelPlacement: 'start' | 'end' | 'fixed' = 'start'; @@ -93,11 +93,11 @@ export class Radio implements ComponentInterface { /** * How to pack the label and radio within a line. - * `'start'`: The label and radio will appear on the left in LTR and + * `"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 + * `"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 + * `"space-between"`: The label and radio will appear on opposite * ends of the line with space between the two elements. */ @Prop() justify: 'start' | 'end' | 'space-between' = 'space-between'; diff --git a/core/src/components/range/range.tsx b/core/src/components/range/range.tsx index b141ddfbd8..6e7e04283c 100644 --- a/core/src/components/range/range.tsx +++ b/core/src/components/range/range.tsx @@ -217,9 +217,9 @@ export class Range implements ComponentInterface { /** * Where to place the label relative to the range. - * `'start'`: The label will appear to the left of the range in LTR and to the right in RTL. - * `'end'`: The label will appear to the right of the range in LTR and to the left in RTL. - * `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * `"start"`: The label will appear to the left of the range in LTR and to the right in RTL. + * `"end"`: The label will appear to the right of the range in LTR and to the left in RTL. + * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ @Prop() labelPlacement: 'start' | 'end' | 'fixed' = 'start'; diff --git a/core/src/components/select/select.tsx b/core/src/components/select/select.tsx index ce1af021f9..e361e74a3f 100644 --- a/core/src/components/select/select.tsx +++ b/core/src/components/select/select.tsx @@ -85,8 +85,8 @@ export class Select implements ComponentInterface { @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. + * 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'; @@ -110,12 +110,12 @@ export class Select implements ComponentInterface { * 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 + * `"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 + * `"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 + * `"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'; @@ -127,12 +127,12 @@ export class Select implements ComponentInterface { /** * 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`. + * `"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'; @@ -178,7 +178,7 @@ export class Select implements ComponentInterface { @Prop() shape?: 'round'; /** - * the value of the select. + * The value of the select. */ @Prop({ mutable: true }) value?: any | null; diff --git a/core/src/components/tab-button/tab-button.tsx b/core/src/components/tab-button/tab-button.tsx index fdfb442362..08d299f647 100644 --- a/core/src/components/tab-button/tab-button.tsx +++ b/core/src/components/tab-button/tab-button.tsx @@ -57,7 +57,7 @@ export class TabButton implements ComponentInterface, AnchorInterface { /** * Set the layout of the text and icon in the tab bar. - * It defaults to `'icon-top'`. + * It defaults to `"icon-top"`. */ @Prop({ mutable: true }) layout?: TabButtonLayout; diff --git a/core/src/components/textarea/textarea.tsx b/core/src/components/textarea/textarea.tsx index 725968cf29..2f1d83cef1 100644 --- a/core/src/components/textarea/textarea.tsx +++ b/core/src/components/textarea/textarea.tsx @@ -101,8 +101,8 @@ export class Textarea implements ComponentInterface { } /** - * 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. + * 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'; @@ -210,11 +210,11 @@ export class Textarea implements ComponentInterface { /** * Where to place the label relative to the textarea. - * `'start'`: The label will appear to the left of the textarea in LTR and to the right in RTL. - * `'end'`: The label will appear to the right of the textarea in LTR and to the left in RTL. - * `'floating'`: The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. - * `'stacked'`: The label will appear smaller and above the textarea regardless even when the textarea 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 ("..."). + * `"start"`: The label will appear to the left of the textarea in LTR and to the right in RTL. + * `"end"`: The label will appear to the right of the textarea in LTR and to the left in RTL. + * `"floating"`: The label will appear smaller and above the textarea when the textarea is focused or it has a value. Otherwise it will appear on top of the textarea. + * `"stacked"`: The label will appear smaller and above the textarea regardless even when the textarea 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 ("..."). */ @Prop() labelPlacement: 'start' | 'end' | 'floating' | 'stacked' | 'fixed' = 'start'; diff --git a/core/src/components/toggle/toggle.tsx b/core/src/components/toggle/toggle.tsx index d1bdfa25e8..558e44bd4b 100644 --- a/core/src/components/toggle/toggle.tsx +++ b/core/src/components/toggle/toggle.tsx @@ -86,9 +86,9 @@ export class Toggle implements ComponentInterface { /** * Where to place the label relative to the input. - * `'start'`: The label will appear to the left of the toggle in LTR and to the right in RTL. - * `'end'`: The label will appear to the right of the toggle in LTR and to the left in RTL. - * `'fixed'`: The label has the same behavior as `'start'` except it also has a fixed width. Long text will be truncated with ellipses ("..."). + * `"start"`: The label will appear to the left of the toggle in LTR and to the right in RTL. + * `"end"`: The label will appear to the right of the toggle in LTR and to the left in RTL. + * `"fixed"`: The label has the same behavior as `"start"` except it also has a fixed width. Long text will be truncated with ellipses ("..."). */ @Prop() labelPlacement: 'start' | 'end' | 'fixed' = 'start'; @@ -105,11 +105,11 @@ export class Toggle implements ComponentInterface { /** * How to pack the label and toggle within a line. - * `'start'`: The label and toggle will appear on the left in LTR and + * `"start"`: The label and toggle will appear on the left in LTR and * on the right in RTL. - * `'end'`: The label and toggle will appear on the right in LTR and + * `"end"`: The label and toggle will appear on the right in LTR and * on the left in RTL. - * `'space-between'`: The label and toggle will appear on opposite + * `"space-between"`: The label and toggle will appear on opposite * ends of the line with space between the two elements. */ @Prop() justify: 'start' | 'end' | 'space-between' = 'space-between';