diff --git a/packages/core/src/components/datetime/datetime.tsx b/packages/core/src/components/datetime/datetime.tsx index fa01cb8d0a..52f69d3934 100644 --- a/packages/core/src/components/datetime/datetime.tsx +++ b/packages/core/src/components/datetime/datetime.tsx @@ -200,7 +200,7 @@ export class Datetime { } /** - * @output {Event} Emitted when the datetime selection was cancelled. + * Emitted when the datetime selection was cancelled. */ @Event() ionCancel: EventEmitter; diff --git a/packages/core/src/components/gesture/gesture.tsx b/packages/core/src/components/gesture/gesture.tsx index 4ae2f723a0..0734542c94 100644 --- a/packages/core/src/components/gesture/gesture.tsx +++ b/packages/core/src/components/gesture/gesture.tsx @@ -52,27 +52,27 @@ export class Gesture { @Prop() notCaptured: GestureCallback; /** - * @output {Event} Emitted when the gesture moves. + * Emitted when the gesture moves. */ @Event() ionGestureMove: EventEmitter; /** - * @output {Event} Emitted when the gesture starts. + * Emitted when the gesture starts. */ @Event() ionGestureStart: EventEmitter; /** - * @output {Event} Emitted when the gesture ends. + * Emitted when the gesture ends. */ @Event() ionGestureEnd: EventEmitter; /** - * @output {Event} Emitted when the gesture is not captured. + * Emitted when the gesture is not captured. */ @Event() ionGestureNotCaptured: EventEmitter; /** - * @output {Event} Emitted when press is detected. + * Emitted when press is detected. */ @Event() ionPress: EventEmitter; diff --git a/packages/core/src/components/infinite-scroll/infinite-scroll.tsx b/packages/core/src/components/infinite-scroll/infinite-scroll.tsx index 091bc7a4ee..f989730d71 100644 --- a/packages/core/src/components/infinite-scroll/infinite-scroll.tsx +++ b/packages/core/src/components/infinite-scroll/infinite-scroll.tsx @@ -76,7 +76,7 @@ export class InfiniteScroll { @Prop() position: string = Position.Bottom; /** - * @output {Event} Emitted when the scroll reaches + * Emitted when the scroll reaches * the threshold distance. From within your infinite handler, * you must call the infinite scroll's `complete()` method when * your async operation has completed. diff --git a/packages/core/src/components/input/input.tsx b/packages/core/src/components/input/input.tsx index bd75ffe19b..e549c37fd8 100644 --- a/packages/core/src/components/input/input.tsx +++ b/packages/core/src/components/input/input.tsx @@ -25,22 +25,22 @@ export class Input implements InputComponent { @Element() private el: HTMLElement; /** - * @output {Event} Emitted when the input value has changed. + * Emitted when the input value has changed. */ @Event() ionInput: EventEmitter; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; /** - * @output {Event} Emitted when the input loses focus. + * Emitted when the input loses focus. */ @Event() ionBlur: EventEmitter; /** - * @output {Event} Emitted when the input has focus. + * Emitted when the input has focus. */ @Event() ionFocus: EventEmitter; diff --git a/packages/core/src/components/item-options/item-options.tsx b/packages/core/src/components/item-options/item-options.tsx index 4a01062e9e..c97fbce08b 100644 --- a/packages/core/src/components/item-options/item-options.tsx +++ b/packages/core/src/components/item-options/item-options.tsx @@ -15,7 +15,7 @@ export class ItemOptions { @Prop() side: Side = 'right'; /** - * @output {Event} Emitted when the item has been fully swiped. + * Emitted when the item has been fully swiped. */ @Event() ionSwipe: EventEmitter; diff --git a/packages/core/src/components/item-sliding/item-sliding.tsx b/packages/core/src/components/item-sliding/item-sliding.tsx index b50d07e028..7ea31c22ca 100644 --- a/packages/core/src/components/item-sliding/item-sliding.tsx +++ b/packages/core/src/components/item-sliding/item-sliding.tsx @@ -53,7 +53,7 @@ export class ItemSliding { /** - * @output {Event} Emitted when the sliding position changes. + * Emitted when the sliding position changes. * It reports the relative position. * * ```ts diff --git a/packages/core/src/components/keyboard-controller/keyboard-controller.tsx b/packages/core/src/components/keyboard-controller/keyboard-controller.tsx index 2691f6e463..c72ed8323c 100644 --- a/packages/core/src/components/keyboard-controller/keyboard-controller.tsx +++ b/packages/core/src/components/keyboard-controller/keyboard-controller.tsx @@ -19,22 +19,22 @@ export class KeyboardController { @Prop({context: 'config'}) config: Config; /** - * @output {Event} Emitted before the keyboard has shown. + * Emitted before the keyboard has shown. */ @Event() keyboardWillShow: EventEmitter; /** - * @output {Event} Emitted after the keyboard has shown. + * Emitted after the keyboard has shown. */ @Event() keyboardDidShow: EventEmitter; /** - * @output {Event} Emitted before the keyboard has hidden. + * Emitted before the keyboard has hidden. */ @Event() keyboardWillHide: EventEmitter; /** - * @output {Event} Emitted after the keyboard has hidden. + * Emitted after the keyboard has hidden. */ @Event() keyboardDidHide: EventEmitter; diff --git a/packages/core/src/components/label/label.tsx b/packages/core/src/components/label/label.tsx index 6b7d3f1175..e4a894504d 100644 --- a/packages/core/src/components/label/label.tsx +++ b/packages/core/src/components/label/label.tsx @@ -17,7 +17,7 @@ export class Label { @Element() private el: HTMLElement; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; @@ -36,17 +36,17 @@ export class Label { @Prop() mode: 'ios' | 'md'; /** - * @output {Event} If true, the label will sit alongside an input. Defaults to `false`. + * If true, the label will sit alongside an input. Defaults to `false`. */ @Prop() fixed = false; /** - * @output {Event} If true, the label will float above an input when the value is empty or the input is focused. Defaults to `false`. + * If true, the label will float above an input when the value is empty or the input is focused. Defaults to `false`. */ @Prop() floating = false; /** - * @output {Event} If true, the label will be stacked above an input. Defaults to `false`. + * If true, the label will be stacked above an input. Defaults to `false`. */ @Prop() stacked = false; diff --git a/packages/core/src/components/loading/loading.tsx b/packages/core/src/components/loading/loading.tsx index 7b598e4a9a..31bf4b7f36 100644 --- a/packages/core/src/components/loading/loading.tsx +++ b/packages/core/src/components/loading/loading.tsx @@ -38,32 +38,32 @@ export class Loading { @Element() private el: HTMLElement; /** - * @output {LoadingEvent} Emitted after the loading has loaded. + * Emitted after the loading has loaded. */ @Event() ionLoadingDidLoad: EventEmitter; /** - * @output {LoadingEvent} Emitted after the loading has presented. + * Emitted after the loading has presented. */ @Event() ionLoadingDidPresent: EventEmitter; /** - * @output {LoadingEvent} Emitted before the loading has presented. + * Emitted before the loading has presented. */ @Event() ionLoadingWillPresent: EventEmitter; /** - * @output {LoadingEvent} Emitted before the loading has dismissed. + * Emitted before the loading has dismissed. */ @Event() ionLoadingWillDismiss: EventEmitter; /** - * @output {LoadingEvent} Emitted after the loading has dismissed. + * Emitted after the loading has dismissed. */ @Event() ionLoadingDidDismiss: EventEmitter; /** - * @output {LoadingEvent} Emitted after the loading has unloaded. + * Emitted after the loading has unloaded. */ @Event() ionLoadingDidUnload: EventEmitter; diff --git a/packages/core/src/components/menu/menu.tsx b/packages/core/src/components/menu/menu.tsx index 52ee3b033f..3efdc4a902 100644 --- a/packages/core/src/components/menu/menu.tsx +++ b/packages/core/src/components/menu/menu.tsx @@ -106,18 +106,18 @@ export class Menu { @Prop() maxEdgeStart = 50; /** - * @output {Event} Emitted when the sliding position changes. + * Emitted when the sliding position changes. * It reports the relative position. */ @Event() ionDrag: EventEmitter; /** - * @output {Event} Emitted when the menu is open. + * Emitted when the menu is open. */ @Event() ionOpen: EventEmitter; /** - * @output {Event} Emitted when the menu is closed. + * Emitted when the menu is closed. */ @Event() ionClose: EventEmitter; diff --git a/packages/core/src/components/modal/modal.tsx b/packages/core/src/components/modal/modal.tsx index e31ede7b08..2a5587da38 100644 --- a/packages/core/src/components/modal/modal.tsx +++ b/packages/core/src/components/modal/modal.tsx @@ -33,32 +33,32 @@ export class Modal { @Element() private el: HTMLElement; /** - * @output {ModalEvent} Emitted after the modal has loaded. + * Emitted after the modal has loaded. */ @Event() ionModalDidLoad: EventEmitter; /** - * @output {ModalEvent} Emitted after the modal has presented. + * Emitted after the modal has presented. */ @Event() ionModalDidPresent: EventEmitter; /** - * @output {ModalEvent} Emitted before the modal has presented. + * Emitted before the modal has presented. */ @Event() ionModalWillPresent: EventEmitter; /** - * @output {ModalEvent} Emitted before the modal has dismissed. + * Emitted before the modal has dismissed. */ @Event() ionModalWillDismiss: EventEmitter; /** - * @output {ModalEvent} Emitted after the modal has dismissed. + * Emitted after the modal has dismissed. */ @Event() ionModalDidDismiss: EventEmitter; /** - * @output {ModalEvent} Emitted after the modal has unloaded. + * Emitted after the modal has unloaded. */ @Event() ionModalDidUnload: EventEmitter; diff --git a/packages/core/src/components/picker/picker.tsx b/packages/core/src/components/picker/picker.tsx index 6f6784deb0..f8f25081f2 100644 --- a/packages/core/src/components/picker/picker.tsx +++ b/packages/core/src/components/picker/picker.tsx @@ -33,32 +33,32 @@ export class Picker { @Element() private el: HTMLElement; /** - * @output {PickerEvent} Emitted after the picker has loaded. + * Emitted after the picker has loaded. */ @Event() ionPickerDidLoad: EventEmitter; /** - * @output {PickerEvent} Emitted after the picker has presented. + * Emitted after the picker has presented. */ @Event() ionPickerDidPresent: EventEmitter; /** - * @output {PickerEvent} Emitted before the picker has presented. + * Emitted before the picker has presented. */ @Event() ionPickerWillPresent: EventEmitter; /** - * @output {PickerEvent} Emitted before the picker has dismissed. + * Emitted before the picker has dismissed. */ @Event() ionPickerWillDismiss: EventEmitter; /** - * @output {PickerEvent} Emitted after the picker has dismissed. + * Emitted after the picker has dismissed. */ @Event() ionPickerDidDismiss: EventEmitter; /** - * @output {PickerEvent} Emitted after the picker has unloaded. + * Emitted after the picker has unloaded. */ @Event() ionPickerDidUnload: EventEmitter; diff --git a/packages/core/src/components/popover/popover.tsx b/packages/core/src/components/popover/popover.tsx index 163f2c0609..f3bda6d96b 100644 --- a/packages/core/src/components/popover/popover.tsx +++ b/packages/core/src/components/popover/popover.tsx @@ -34,32 +34,32 @@ export class Popover { @Element() private el: HTMLElement; /** - * @output {PopoverEvent} Emitted after the popover has loaded. + * Emitted after the popover has loaded. */ @Event() ionPopoverDidLoad: EventEmitter; /** - * @output {PopoverEvent} Emitted after the popover has presented. + * Emitted after the popover has presented. */ @Event() ionPopoverDidPresent: EventEmitter; /** - * @output {PopoverEvent} Emitted before the popover has presented. + * Emitted before the popover has presented. */ @Event() ionPopoverWillPresent: EventEmitter; /** - * @output {PopoverEvent} Emitted before the popover has dismissed. + * Emitted before the popover has dismissed. */ @Event() ionPopoverWillDismiss: EventEmitter; /** - * @output {PopoverEvent} Emitted after the popover has dismissed. + * Emitted after the popover has dismissed. */ @Event() ionPopoverDidDismiss: EventEmitter; /** - * @output {PopoverEvent} Emitted after the popover has unloaded. + * Emitted after the popover has unloaded. */ @Event() ionPopoverDidUnload: EventEmitter; diff --git a/packages/core/src/components/radio-group/radio-group.tsx b/packages/core/src/components/radio-group/radio-group.tsx index 1f145a3437..6bf02a7854 100644 --- a/packages/core/src/components/radio-group/radio-group.tsx +++ b/packages/core/src/components/radio-group/radio-group.tsx @@ -81,7 +81,7 @@ export class RadioGroup implements ComponentDidLoad, RadioGroupInput { } /** - * @output {Event} Emitted when the value has changed. + * Emitted when the value has changed. */ @Event() ionChange: EventEmitter; diff --git a/packages/core/src/components/radio/radio.tsx b/packages/core/src/components/radio/radio.tsx index 3d2bdd4e7f..ad94a93f55 100644 --- a/packages/core/src/components/radio/radio.tsx +++ b/packages/core/src/components/radio/radio.tsx @@ -58,32 +58,32 @@ export class Radio implements RadioButtonInput, ComponentDidLoad, ComponentDidUn @Prop({ mutable: true }) value: string; /** - * @output {RadioEvent} Emitted when the radio loads. + * Emitted when the radio loads. */ @Event() ionRadioDidLoad: EventEmitter; /** - * @output {RadioEvent} Emitted when the radio unloads. + * Emitted when the radio unloads. */ @Event() ionRadioDidUnload: EventEmitter; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; /** - * @output {Event} Emitted when the radio button is selected. + * Emitted when the radio button is selected. */ @Event() ionSelect: EventEmitter; /** - * @output {Event} Emitted when the radio button has focus. + * Emitted when the radio button has focus. */ @Event() ionFocus: EventEmitter; /** - * @output {Event} Emitted when the radio button loses focus. + * Emitted when the radio button loses focus. */ @Event() ionBlur: EventEmitter; diff --git a/packages/core/src/components/range/range.tsx b/packages/core/src/components/range/range.tsx index 743857661e..ae1ec00fa5 100644 --- a/packages/core/src/components/range/range.tsx +++ b/packages/core/src/components/range/range.tsx @@ -37,22 +37,22 @@ export class Range implements BaseInputComponent { @State() pressedB: boolean; /** - * @output {Event} Emitted when the value property has changed. + * Emitted when the value property has changed. */ @Event() ionChange: EventEmitter; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; /** - * @output {Event} Emitted when the range has focus. + * Emitted when the range has focus. */ @Event() ionFocus: EventEmitter; /** - * @output {Event} Emitted when the range loses focus. + * Emitted when the range loses focus. */ @Event() ionBlur: EventEmitter; diff --git a/packages/core/src/components/scroll/scroll.tsx b/packages/core/src/components/scroll/scroll.tsx index 37492a2996..8345dddc77 100644 --- a/packages/core/src/components/scroll/scroll.tsx +++ b/packages/core/src/components/scroll/scroll.tsx @@ -31,17 +31,17 @@ export class Scroll { @Prop() onionScrollEnd: ScrollCallback; /** - * @output {ScrollEvent} Emitted when the scroll has started. + * Emitted when the scroll has started. */ @Event() ionScrollStart: EventEmitter; /** - * @output {ScrollEvent} Emitted while scrolling. + * Emitted while scrolling. */ @Event({bubbles: false}) ionScroll: EventEmitter; /** - * @output {ScrollEvent} Emitted when the scroll has ended. + * Emitted when the scroll has ended. */ @Event() ionScrollEnd: EventEmitter; diff --git a/packages/core/src/components/searchbar/searchbar.tsx b/packages/core/src/components/searchbar/searchbar.tsx index 9310ddc84c..eda41ad90a 100644 --- a/packages/core/src/components/searchbar/searchbar.tsx +++ b/packages/core/src/components/searchbar/searchbar.tsx @@ -25,27 +25,27 @@ export class Searchbar { /** - * @output {Event} Emitted when the Searchbar input has changed, including when it's cleared. + * Emitted when the Searchbar input has changed, including when it's cleared. */ @Event() ionInput: EventEmitter; /** - * @output {Event} Emitted when the cancel button is clicked. + * Emitted when the cancel button is clicked. */ @Event() ionCancel: EventEmitter; /** - * @output {Event} Emitted when the clear input button is clicked. + * Emitted when the clear input button is clicked. */ @Event() ionClear: EventEmitter; /** - * @output {Event} Emitted when the input loses focus. + * Emitted when the input loses focus. */ @Event() ionBlur: EventEmitter; /** - * @output {Event} Emitted when the input has focus. + * Emitted when the input has focus. */ @Event() ionFocus: EventEmitter; diff --git a/packages/core/src/components/select/select.tsx b/packages/core/src/components/select/select.tsx index 8c4b61b041..45b8457bc3 100644 --- a/packages/core/src/components/select/select.tsx +++ b/packages/core/src/components/select/select.tsx @@ -118,7 +118,7 @@ export class Select { @Event() ionBlur: EventEmitter; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; diff --git a/packages/core/src/components/split-pane/split-pane.tsx b/packages/core/src/components/split-pane/split-pane.tsx index 57d59ce242..70ebc88ae5 100644 --- a/packages/core/src/components/split-pane/split-pane.tsx +++ b/packages/core/src/components/split-pane/split-pane.tsx @@ -43,12 +43,12 @@ export class SplitPane { @Prop() when: string | boolean = QUERY['md']; /** - * @output {Event} Expression to be called when the split-pane visibility has changed + * Expression to be called when the split-pane visibility has changed */ @Event() ionSplitPaneDidChange: EventEmitter; /** - * @output {Event} Emitted when the split pane is visible. + * Emitted when the split pane is visible. */ @Event() ionChange: EventEmitter; diff --git a/packages/core/src/components/tab/tab.tsx b/packages/core/src/components/tab/tab.tsx index 3ca5b47a12..469f1b2d1c 100644 --- a/packages/core/src/components/tab/tab.tsx +++ b/packages/core/src/components/tab/tab.tsx @@ -71,7 +71,7 @@ export class Tab { } /** - * @output {Tab} Emitted when the current tab is selected. + * Emitted when the current tab is selected. */ @Event() ionSelect: EventEmitter; diff --git a/packages/core/src/components/tabs/tabs.tsx b/packages/core/src/components/tabs/tabs.tsx index 74e5f95ecb..d7cc78b938 100644 --- a/packages/core/src/components/tabs/tabs.tsx +++ b/packages/core/src/components/tabs/tabs.tsx @@ -56,7 +56,7 @@ export class Tabs { @Prop() scrollable = false; /** - * @output {any} Emitted when the tab changes. + * Emitted when the tab changes. */ @Event() ionChange: EventEmitter; diff --git a/packages/core/src/components/textarea/textarea.tsx b/packages/core/src/components/textarea/textarea.tsx index 0304681c86..ccb1d9f9c1 100644 --- a/packages/core/src/components/textarea/textarea.tsx +++ b/packages/core/src/components/textarea/textarea.tsx @@ -30,22 +30,22 @@ export class Textarea implements TextareaComponent { @Element() private el: HTMLElement; /** - * @output {Event} Emitted when the input value has changed. + * Emitted when the input value has changed. */ @Event() ionInput: EventEmitter; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; /** - * @output {Event} Emitted when the input loses focus. + * Emitted when the input loses focus. */ @Event() ionBlur: EventEmitter; /** - * @output {Event} Emitted when the input has focus. + * Emitted when the input has focus. */ @Event() ionFocus: EventEmitter; diff --git a/packages/core/src/components/toast/toast.tsx b/packages/core/src/components/toast/toast.tsx index 920360581a..a1b36bca0f 100644 --- a/packages/core/src/components/toast/toast.tsx +++ b/packages/core/src/components/toast/toast.tsx @@ -29,32 +29,32 @@ export class Toast { @Element() private el: HTMLElement; /** - * @output {ToastEvent} Emitted after the toast has loaded. + * Emitted after the toast has loaded. */ @Event() ionToastDidLoad: EventEmitter; /** - * @output {ToastEvent} Emitted after the toast has presented. + * Emitted after the toast has presented. */ @Event() ionToastDidPresent: EventEmitter; /** - * @output {ToastEvent} Emitted before the toast has presented. + * Emitted before the toast has presented. */ @Event() ionToastWillPresent: EventEmitter; /** - * @output {ToastEvent} Emitted before the toast has dismissed. + * Emitted before the toast has dismissed. */ @Event() ionToastWillDismiss: EventEmitter; /** - * @output {ToastEvent} Emitted after the toast has dismissed. + * Emitted after the toast has dismissed. */ @Event() ionToastDidDismiss: EventEmitter; /** - * @output {ToastEvent} Emitted after the toast has unloaded. + * Emitted after the toast has unloaded. */ @Event() ionToastDidUnload: EventEmitter; diff --git a/packages/core/src/components/toggle/toggle.tsx b/packages/core/src/components/toggle/toggle.tsx index 7eb8260f53..578afa11a7 100644 --- a/packages/core/src/components/toggle/toggle.tsx +++ b/packages/core/src/components/toggle/toggle.tsx @@ -62,22 +62,22 @@ export class Toggle implements CheckboxInput { @Prop() value = 'on'; /** - * @output {Event} Emitted when the value property has changed. + * Emitted when the value property has changed. */ @Event() ionChange: EventEmitter; /** - * @output {Event} Emitted when the toggle has focus. + * Emitted when the toggle has focus. */ @Event() ionFocus: EventEmitter; /** - * @output {Event} Emitted when the toggle loses focus. + * Emitted when the toggle loses focus. */ @Event() ionBlur: EventEmitter; /** - * @output {Event} Emitted when the styles change. + * Emitted when the styles change. */ @Event() ionStyle: EventEmitter; diff --git a/packages/core/src/index.d.ts b/packages/core/src/index.d.ts index 0d6fa50d83..1990412f86 100644 --- a/packages/core/src/index.d.ts +++ b/packages/core/src/index.d.ts @@ -64,7 +64,7 @@ export { } from './components/menu-controller/menu-controller'; export * from './components/modal/modal'; export { ModalController } from './components/modal-controller/modal-controller'; -export * from './components/nav/nav'; +export * from './components/nav/nav'; export * from './components/nav/nav-interfaces'; export { ViewController } from './components/nav/view-controller'; export { Note } from './components/note/note';