javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-23 05:58:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): remove jsdoc output docs

Browse Source
This commit is contained in:
Brandy Carney
2018-02-01 16:00:14 -05:00
parent 34f8ef2047
commit c4cb9e92ac
26 changed files with 87 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/core/src/components/datetime/datetime.tsx
View File

@ -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;

10
packages/core/src/components/gesture/gesture.tsx
View File

@ -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;

2
packages/core/src/components/infinite-scroll/infinite-scroll.tsx
View File

@ -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.

8
packages/core/src/components/input/input.tsx
View File

@ -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;

2
packages/core/src/components/item-options/item-options.tsx
View File

@ -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;

2
packages/core/src/components/item-sliding/item-sliding.tsx
View File

@ -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

8
packages/core/src/components/keyboard-controller/keyboard-controller.tsx
View File

@ -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;

8
packages/core/src/components/label/label.tsx
View File

@ -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;

12
packages/core/src/components/loading/loading.tsx
View File

@ -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<LoadingEventDetail>;
/**
* @output {LoadingEvent} Emitted after the loading has presented.
* Emitted after the loading has presented.
*/
@Event() ionLoadingDidPresent: EventEmitter<LoadingEventDetail>;
/**
* @output {LoadingEvent} Emitted before the loading has presented.
* Emitted before the loading has presented.
*/
@Event() ionLoadingWillPresent: EventEmitter<LoadingEventDetail>;
/**
* @output {LoadingEvent} Emitted before the loading has dismissed.
* Emitted before the loading has dismissed.
*/
@Event() ionLoadingWillDismiss: EventEmitter<LoadingDismissEventDetail>;
/**
* @output {LoadingEvent} Emitted after the loading has dismissed.
* Emitted after the loading has dismissed.
*/
@Event() ionLoadingDidDismiss: EventEmitter<LoadingDismissEventDetail>;
/**
* @output {LoadingEvent} Emitted after the loading has unloaded.
* Emitted after the loading has unloaded.
*/
@Event() ionLoadingDidUnload: EventEmitter<LoadingEventDetail>;

6
packages/core/src/components/menu/menu.tsx
View File

@ -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;

12
packages/core/src/components/modal/modal.tsx
View File

@ -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<ModalEventDetail>;
/**
* @output {ModalEvent} Emitted after the modal has presented.
* Emitted after the modal has presented.
*/
@Event() ionModalDidPresent: EventEmitter<ModalEventDetail>;
/**
* @output {ModalEvent} Emitted before the modal has presented.
* Emitted before the modal has presented.
*/
@Event() ionModalWillPresent: EventEmitter<ModalEventDetail>;
/**
* @output {ModalEvent} Emitted before the modal has dismissed.
* Emitted before the modal has dismissed.
*/
@Event() ionModalWillDismiss: EventEmitter<ModalDismissEventDetail>;
/**
* @output {ModalEvent} Emitted after the modal has dismissed.
* Emitted after the modal has dismissed.
*/
@Event() ionModalDidDismiss: EventEmitter<ModalDismissEventDetail>;
/**
* @output {ModalEvent} Emitted after the modal has unloaded.
* Emitted after the modal has unloaded.
*/
@Event() ionModalDidUnload: EventEmitter<ModalEventDetail>;

12
packages/core/src/components/picker/picker.tsx
View File

@ -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<PickerEventDetail>;
/**
* @output {PickerEvent} Emitted after the picker has presented.
* Emitted after the picker has presented.
*/
@Event() ionPickerDidPresent: EventEmitter<PickerEventDetail>;
/**
* @output {PickerEvent} Emitted before the picker has presented.
* Emitted before the picker has presented.
*/
@Event() ionPickerWillPresent: EventEmitter<PickerEventDetail>;
/**
* @output {PickerEvent} Emitted before the picker has dismissed.
* Emitted before the picker has dismissed.
*/
@Event() ionPickerWillDismiss: EventEmitter<PickerDismissEventDetail>;
/**
* @output {PickerEvent} Emitted after the picker has dismissed.
* Emitted after the picker has dismissed.
*/
@Event() ionPickerDidDismiss: EventEmitter<PickerDismissEventDetail>;
/**
* @output {PickerEvent} Emitted after the picker has unloaded.
* Emitted after the picker has unloaded.
*/
@Event() ionPickerDidUnload: EventEmitter<PickerEventDetail>;

12
packages/core/src/components/popover/popover.tsx
View File

@ -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<PopoverEventDetail>;
/**
* @output {PopoverEvent} Emitted after the popover has presented.
* Emitted after the popover has presented.
*/
@Event() ionPopoverDidPresent: EventEmitter<PopoverEventDetail>;
/**
* @output {PopoverEvent} Emitted before the popover has presented.
* Emitted before the popover has presented.
*/
@Event() ionPopoverWillPresent: EventEmitter<PopoverEventDetail>;
/**
* @output {PopoverEvent} Emitted before the popover has dismissed.
* Emitted before the popover has dismissed.
*/
@Event() ionPopoverWillDismiss: EventEmitter<PopoverDismissEventDetail>;
/**
* @output {PopoverEvent} Emitted after the popover has dismissed.
* Emitted after the popover has dismissed.
*/
@Event() ionPopoverDidDismiss: EventEmitter<PopoverDismissEventDetail>;
/**
* @output {PopoverEvent} Emitted after the popover has unloaded.
* Emitted after the popover has unloaded.
*/
@Event() ionPopoverDidUnload: EventEmitter<PopoverEventDetail>;

2
packages/core/src/components/radio-group/radio-group.tsx
View File

@ -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<InputChangeEvent>;

12
packages/core/src/components/radio/radio.tsx
View File

@ -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<StyleEvent>;
/**
* @output {Event} Emitted when the radio button is selected.
* Emitted when the radio button is selected.
*/
@Event() ionSelect: EventEmitter<CheckedInputChangeEvent>;
/**
* @output {Event} Emitted when the radio button has focus.
* Emitted when the radio button has focus.
*/
@Event() ionFocus: EventEmitter<FocusEvent>;
/**
* @output {Event} Emitted when the radio button loses focus.
* Emitted when the radio button loses focus.
*/
@Event() ionBlur: EventEmitter<BlurEvent>;

8
packages/core/src/components/range/range.tsx
View File

@ -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;

6
packages/core/src/components/scroll/scroll.tsx
View File

@ -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;

10
packages/core/src/components/searchbar/searchbar.tsx
View File

@ -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;

2
packages/core/src/components/select/select.tsx
View File

@ -118,7 +118,7 @@ export class Select {
@Event() ionBlur: EventEmitter<BlurEvent>;
/**
* @output {Event} Emitted when the styles change.
* Emitted when the styles change.
*/
@Event() ionStyle: EventEmitter<StyleEvent>;

4
packages/core/src/components/split-pane/split-pane.tsx
View File

@ -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;

2
packages/core/src/components/tab/tab.tsx
View File

@ -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<TabEventDetail>;

2
packages/core/src/components/tabs/tabs.tsx
View File

@ -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;

8
packages/core/src/components/textarea/textarea.tsx
View File

@ -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;

12
packages/core/src/components/toast/toast.tsx
View File

@ -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<ToastEventDetail>;
/**
* @output {ToastEvent} Emitted after the toast has presented.
* Emitted after the toast has presented.
*/
@Event() ionToastDidPresent: EventEmitter<ToastEventDetail>;
/**
* @output {ToastEvent} Emitted before the toast has presented.
* Emitted before the toast has presented.
*/
@Event() ionToastWillPresent: EventEmitter<ToastEventDetail>;
/**
* @output {ToastEvent} Emitted before the toast has dismissed.
* Emitted before the toast has dismissed.
*/
@Event() ionToastWillDismiss: EventEmitter<ToastDismissEventDetail>;
/**
* @output {ToastEvent} Emitted after the toast has dismissed.
* Emitted after the toast has dismissed.
*/
@Event() ionToastDidDismiss: EventEmitter<ToastDismissEventDetail>;
/**
* @output {ToastEvent} Emitted after the toast has unloaded.
* Emitted after the toast has unloaded.
*/
@Event() ionToastDidUnload: EventEmitter<ToastEventDetail>;

8
packages/core/src/components/toggle/toggle.tsx
View File

@ -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<CheckedInputChangeEvent>;
/**
* @output {Event} Emitted when the toggle has focus.
* Emitted when the toggle has focus.
*/
@Event() ionFocus: EventEmitter<FocusEvent>;
/**
* @output {Event} Emitted when the toggle loses focus.
* Emitted when the toggle loses focus.
*/
@Event() ionBlur: EventEmitter<BlurEvent>;
/**
* @output {Event} Emitted when the styles change.
* Emitted when the styles change.
*/
@Event() ionStyle: EventEmitter<StyleEvent>;

2
packages/core/src/index.d.ts vendored
View File

@ -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';