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

docs(components): remove hidden comments

Browse Source
This commit is contained in:
Brandy Carney
2017-12-22 10:46:54 -05:00
parent 334824bb7a
commit c292517523
14 changed files with 0 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
packages/core/src/components/animation-controller/animator.tsx
View File

@ -160,7 +160,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO DOM * NO DOM
*/ */
@ -359,7 +358,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -391,7 +389,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* NO RECURSION * NO RECURSION
* ROOT ANIMATION * ROOT ANIMATION
@ -426,7 +423,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -459,7 +455,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -482,7 +477,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* NO RECURSION * NO RECURSION
* ROOT ANIMATION * ROOT ANIMATION
@ -529,7 +523,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -562,7 +555,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO DOM * NO DOM
* RECURSION * RECURSION
*/ */
@ -581,7 +573,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO DOM * NO DOM
* RECURSION * RECURSION
*/ */
@ -613,7 +604,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO DOM * NO DOM
* NO RECURSION * NO RECURSION
*/ */
@ -624,7 +614,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* NO RECURSION * NO RECURSION
*/ */
@ -707,7 +696,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* NO RECURSION * NO RECURSION
*/ */
@ -745,7 +733,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM READ * DOM READ
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
@ -769,7 +756,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -822,7 +808,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM READ * DOM READ
* RECURSION * RECURSION
*/ */
@ -845,7 +830,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -868,7 +852,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
*/ */
_setAfterStyles() { _setAfterStyles() {
@ -944,7 +927,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* NO RECURSION * NO RECURSION
*/ */
@ -992,7 +974,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -1073,7 +1054,6 @@ export class Animator {
} }
/** /**
* @hidden
* DOM WRITE * DOM WRITE
* RECURSION * RECURSION
*/ */
@ -1124,7 +1104,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO DOM * NO DOM
* RECURSION * RECURSION
*/ */
@ -1140,7 +1119,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO RECURSION * NO RECURSION
*/ */
_didFinish(hasCompleted: boolean) { _didFinish(hasCompleted: boolean) {
@ -1218,7 +1196,6 @@ export class Animator {
} }
/** /**
* @hidden
* NO DOM * NO DOM
*/ */
_transEl(): HTMLElement { _transEl(): HTMLElement {

3
packages/core/src/components/chip-button/chip-button.tsx
View File

@ -43,7 +43,6 @@ export class ChipButton {
@Prop() disabled: boolean = false; @Prop() disabled: boolean = false;
/** /**
* @hidden
* Get the classes based on the button type * Get the classes based on the button type
* e.g. alert-button, action-sheet-button * e.g. alert-button, action-sheet-button
*/ */
@ -58,7 +57,6 @@ export class ChipButton {
} }
/** /**
* @hidden
* Get the classes for the color * Get the classes for the color
*/ */
private getColorClassList(color: string, buttonType: string, style: string, mode: string): string[] { private getColorClassList(color: string, buttonType: string, style: string, mode: string): string[] {
@ -71,7 +69,6 @@ export class ChipButton {
} }
/** /**
* @hidden
* Get the classes for the style * Get the classes for the style
* Chip buttons can only be clear or default (solid) * Chip buttons can only be clear or default (solid)
*/ */

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

@ -192,7 +192,6 @@ export class Datetime {
@Prop({ mutable: true }) value: string; @Prop({ mutable: true }) value: string;
/** /**
* @hidden
* Update the datetime value when the value changes * Update the datetime value when the value changes
*/ */
@PropDidChange('value') @PropDidChange('value')
@ -221,7 +220,6 @@ export class Datetime {
} }
/** /**
* @hidden
* Update the datetime text and datetime value * Update the datetime text and datetime value
*/ */
updateValue() { updateValue() {
@ -286,7 +284,6 @@ export class Datetime {
/** /**
* @hidden
*/ */
generateColumns(): PickerColumn[] { generateColumns(): PickerColumn[] {
let columns: PickerColumn[] = []; let columns: PickerColumn[] = [];
@ -421,7 +418,6 @@ export class Datetime {
/** /**
* @hidden
*/ */
calcMinMax(now?: Date) { calcMinMax(now?: Date) {
const todaysYear = (now || new Date()).getFullYear(); const todaysYear = (now || new Date()).getFullYear();
@ -477,7 +473,6 @@ export class Datetime {
/** /**
* @hidden
*/ */
validateColumn(name: string, index: number, min: number, max: number, lowerBounds: number[], upperBounds: number[]): number { validateColumn(name: string, index: number, min: number, max: number, lowerBounds: number[], upperBounds: number[]): number {
const column = this.picker.getColumn(name); const column = this.picker.getColumn(name);
@ -518,7 +513,6 @@ export class Datetime {
/** /**
* @hidden
*/ */
divyColumns(columns: PickerColumn[]): PickerColumn[] { divyColumns(columns: PickerColumn[]): PickerColumn[] {
const pickerColumns = columns; const pickerColumns = columns;
@ -555,7 +549,6 @@ export class Datetime {
} }
/** /**
* @hidden
*/ */
updateText() { updateText() {
// create the text of the formatted data // create the text of the formatted data
@ -564,7 +557,6 @@ export class Datetime {
} }
/** /**
* @hidden
*/ */
hasValue(): boolean { hasValue(): boolean {
const val = this.datetimeValue; const val = this.datetimeValue;

3
packages/core/src/components/fab-button/fab-button.tsx
View File

@ -66,7 +66,6 @@ export class FabButton {
} }
/** /**
* @hidden
* Get the classes for fab buttons in lists * Get the classes for fab buttons in lists
*/ */
getFabListClassList() { getFabListClassList() {
@ -86,7 +85,6 @@ export class FabButton {
} }
/** /**
* @hidden
* Get the close active class for fab buttons * Get the close active class for fab buttons
*/ */
getFabActiveClassList() { getFabActiveClassList() {
@ -99,7 +97,6 @@ export class FabButton {
} }
/** /**
* @hidden
* Get the show class for fab buttons * Get the show class for fab buttons
*/ */
getFabShowClassList() { getFabShowClassList() {

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

@ -223,10 +223,6 @@ export class InfiniteScroll {
action.then(enable, enable); action.then(enable, enable);
} }
/**
* @hidden
*/
private enableScrollEvents(shouldListen: boolean) { private enableScrollEvents(shouldListen: boolean) {
this.enableListener(this, 'ionScroll', shouldListen, this.scrollEl); this.enableListener(this, 'ionScroll', shouldListen, this.scrollEl);
} }

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

@ -68,15 +68,11 @@ export class Input implements InputComponent {
*/ */
@Prop() checked: boolean = false; @Prop() checked: boolean = false;
/**
* @hidden
*/
@PropDidChange('checked') @PropDidChange('checked')
protected checkedChanged() { protected checkedChanged() {
this.emitStyle(); this.emitStyle();
} }
/** /**
* @input {boolean} If true, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`. * @input {boolean} If true, a clear icon will appear in the input when there is a value. Clicking it clears the input. Defaults to `false`.
*/ */
@ -92,9 +88,6 @@ export class Input implements InputComponent {
*/ */
@Prop() disabled: boolean = false; @Prop() disabled: boolean = false;
/**
* @hidden
*/
@PropDidChange('disabled') @PropDidChange('disabled')
protected disabledChanged() { protected disabledChanged() {
this.emitStyle(); this.emitStyle();
@ -187,7 +180,6 @@ export class Input implements InputComponent {
/** /**
* @hidden
* Update the native input element when the value changes * Update the native input element when the value changes
*/ */
@PropDidChange('value') @PropDidChange('value')
@ -224,10 +216,6 @@ export class Input implements InputComponent {
}); });
} }
/**
* @hidden
*/
inputBlurred(ev: any) { inputBlurred(ev: any) {
this.ionBlur.emit(ev); this.ionBlur.emit(ev);
@ -235,19 +223,11 @@ export class Input implements InputComponent {
this.emitStyle(); this.emitStyle();
} }
/**
* @hidden
*/
inputChanged(ev: any) { inputChanged(ev: any) {
this.value = ev.target && ev.target.value; this.value = ev.target && ev.target.value;
this.emitStyle(); this.emitStyle();
} }
/**
* @hidden
*/
inputFocused(ev: any) { inputFocused(ev: any) {
this.ionFocus.emit(ev); this.ionFocus.emit(ev);
@ -255,10 +235,6 @@ export class Input implements InputComponent {
this.emitStyle(); this.emitStyle();
} }
/**
* @hidden
*/
focusChange(inputHasFocus: boolean) { focusChange(inputHasFocus: boolean) {
// If clearOnEdit is enabled and the input blurred but has a value, set a flag // If clearOnEdit is enabled and the input blurred but has a value, set a flag
if (this.clearOnEdit && !inputHasFocus && this.hasValue()) { if (this.clearOnEdit && !inputHasFocus && this.hasValue()) {
@ -266,10 +242,6 @@ export class Input implements InputComponent {
} }
} }
/**
* @hidden
*/
inputKeydown() { inputKeydown() {
this.checkClearOnEdit(); this.checkClearOnEdit();
} }
@ -277,7 +249,6 @@ export class Input implements InputComponent {
/** /**
* Check if we need to clear the text input if clearOnEdit is enabled * Check if we need to clear the text input if clearOnEdit is enabled
* @hidden
*/ */
checkClearOnEdit() { checkClearOnEdit() {
if (!this.clearOnEdit) { if (!this.clearOnEdit) {
@ -294,30 +265,19 @@ export class Input implements InputComponent {
this.didBlurAfterEdit = false; this.didBlurAfterEdit = false;
} }
/**
* @hidden
*/
clearTextInput() { clearTextInput() {
this.value = ''; this.value = '';
} }
/**
* @hidden
*/
hasFocus(): boolean { hasFocus(): boolean {
// check if an input has focus or not // check if an input has focus or not
return this.el && (this.el.querySelector(':focus') === this.el.querySelector('input')); return this.el && (this.el.querySelector(':focus') === this.el.querySelector('input'));
} }
/**
* @hidden
*/
hasValue(): boolean { hasValue(): boolean {
return (this.value !== null && this.value !== undefined && this.value !== ''); return (this.value !== null && this.value !== undefined && this.value !== '');
} }
render() { render() {
const themedClasses = createThemedClasses(this.mode, this.color, 'text-input'); const themedClasses = createThemedClasses(this.mode, this.color, 'text-input');
// TODO aria-labelledby={this.item.labelId} // TODO aria-labelledby={this.item.labelId}

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

@ -50,9 +50,6 @@ export class Label {
*/ */
@Prop() stacked: boolean = false; @Prop() stacked: boolean = false;
/**
* @hidden
*/
@Method() @Method()
getText(): string { getText(): string {
return this.el.textContent || ''; return this.el.textContent || '';

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

@ -99,12 +99,8 @@ export class Menu {
*/ */
@Prop() persistent: boolean = false; @Prop() persistent: boolean = false;
/**
* @hidden
*/
@Prop() maxEdgeStart: number = 50; @Prop() maxEdgeStart: number = 50;
/** /**
* @output {Event} Emitted when the sliding position changes. * @output {Event} Emitted when the sliding position changes.
* It reports the relative position. * It reports the relative position.

6
packages/core/src/components/reorder-group/reorder-group.tsx
View File

@ -285,16 +285,10 @@ export class ReorderGroup {
} }
} }
/**
* @hidden
*/
function indexForItem(element: any): number { function indexForItem(element: any): number {
return element['$ionIndex']; return element['$ionIndex'];
} }
/**
* @hidden
*/
function findReorderItem(node: HTMLElement, container: HTMLElement): HTMLElement { function findReorderItem(node: HTMLElement, container: HTMLElement): HTMLElement {
let nested = 0; let nested = 0;
let parent; let parent;

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

@ -118,7 +118,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Clears the input field and triggers the control change. * Clears the input field and triggers the control change.
*/ */
clearInput(ev: UIEvent) { clearInput(ev: UIEvent) {
@ -137,7 +136,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Clears the input field and tells the input to blur since * Clears the input field and tells the input to blur since
* the clearInput function doesn't want the input to blur * the clearInput function doesn't want the input to blur
* then calls the custom cancel function if the user passed one in. * then calls the custom cancel function if the user passed one in.
@ -151,7 +149,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Update the Searchbar input value when the input changes * Update the Searchbar input value when the input changes
*/ */
inputChanged(ev: any) { inputChanged(ev: any) {
@ -161,9 +158,6 @@ export class Searchbar {
}, this.debounce); }, this.debounce);
} }
/**
* @hidden
*/
inputUpdated() { inputUpdated() {
// const inputEle = this.el.querySelector('.searchbar-input') as HTMLInputElement; // const inputEle = this.el.querySelector('.searchbar-input') as HTMLInputElement;
@ -178,7 +172,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Sets the Searchbar to not focused and checks if it should align left * Sets the Searchbar to not focused and checks if it should align left
* based on whether there is a value in the searchbar or not. * based on whether there is a value in the searchbar or not.
*/ */
@ -200,7 +193,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Sets the Searchbar to focused and active on input focus. * Sets the Searchbar to focused and active on input focus.
*/ */
inputFocused() { inputFocused() {
@ -214,7 +206,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Positions the input search icon, placeholder, and the cancel button * Positions the input search icon, placeholder, and the cancel button
* based on the input value and if it is focused. (ios only) * based on the input value and if it is focused. (ios only)
*/ */
@ -237,7 +228,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Positions the input placeholder * Positions the input placeholder
*/ */
positionPlaceholder() { positionPlaceholder() {
@ -277,7 +267,6 @@ export class Searchbar {
} }
/** /**
* @hidden
* Show the iOS Cancel button on focus, hide it offscreen otherwise * Show the iOS Cancel button on focus, hide it offscreen otherwise
*/ */
positionCancelButton() { positionCancelButton() {

1
packages/core/src/components/segment-button/segment-button.tsx
View File

@ -67,7 +67,6 @@ export class SegmentButton {
} }
/** /**
* @hidden
* Get the classes for the segment button state * Get the classes for the segment button state
*/ */
getElementClassList() { getElementClassList() {

16
packages/core/src/components/slides/slides.tsx
View File

@ -179,19 +179,16 @@ export class Slides {
} }
/** /**
* @hidden
* Height of container. * Height of container.
*/ */
private height: number; private height: number;
/** /**
* @hidden
* Width of container. * Width of container.
*/ */
private width: number; private width: number;
/** /**
* @hidden
* Enabled this option and swiper will be operated as usual except it will * Enabled this option and swiper will be operated as usual except it will
* not move, real translate values on wrapper will not be set. Useful when * not move, real translate values on wrapper will not be set. Useful when
* you may need to create custom slide transition. * you may need to create custom slide transition.
@ -199,7 +196,6 @@ export class Slides {
private virtualTranslate = false; private virtualTranslate = false;
/** /**
* @hidden
* Set to true to round values of slides width and height to prevent blurry * Set to true to round values of slides width and height to prevent blurry
* texts on usual resolution screens (if you have such) * texts on usual resolution screens (if you have such)
*/ */
@ -207,9 +203,6 @@ export class Slides {
// Slides grid // Slides grid
/**
* @hidden
*/
private originalEvent: any; private originalEvent: any;
/** /**
@ -223,11 +216,8 @@ export class Slides {
* Properties that are exposed publicly but no docs. * Properties that are exposed publicly but no docs.
* ------------------------------------ * ------------------------------------
*/ */
/** @hidden */
private container: HTMLElement; private container: HTMLElement;
/** @hidden */
private slidesId: number; private slidesId: number;
/** @hidden */
private slideId: string; private slideId: string;
@ -362,9 +352,6 @@ export class Slides {
} }
} }
/**
* @hidden
*/
componentDidLoad() { componentDidLoad() {
/** /**
* TODO: This should change because currently componentDidLoad fires independent of whether the * TODO: This should change because currently componentDidLoad fires independent of whether the
@ -523,9 +510,6 @@ export class Slides {
this.swiper.disableKeyboardControl(); this.swiper.disableKeyboardControl();
} }
/**
* @hidden
*/
componentDidUnload() { componentDidUnload() {
this._init = false; this._init = false;

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

@ -130,9 +130,6 @@ export class SplitPane {
} }
} }
/**
* @hidden
*/
@Method() @Method()
isVisible(): boolean { isVisible(): boolean {
return this.visible; return this.visible;

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

@ -69,9 +69,6 @@ export class Textarea implements TextareaComponent {
*/ */
@Prop() disabled: boolean = false; @Prop() disabled: boolean = false;
/**
* @hidden
*/
@PropDidChange('disabled') @PropDidChange('disabled')
protected disabledChanged() { protected disabledChanged() {
this.emitStyle(); this.emitStyle();
@ -133,7 +130,6 @@ export class Textarea implements TextareaComponent {
@Prop({ mutable: true }) value: string; @Prop({ mutable: true }) value: string;
/** /**
* @hidden
* Update the native input element when the value changes * Update the native input element when the value changes
*/ */
@PropDidChange('value') @PropDidChange('value')
@ -148,7 +144,6 @@ export class Textarea implements TextareaComponent {
this.emitStyle(); this.emitStyle();
} }
private emitStyle() { private emitStyle() {
clearTimeout(this.styleTmr); clearTimeout(this.styleTmr);
@ -165,18 +160,10 @@ export class Textarea implements TextareaComponent {
}); });
} }
/**
* @hidden
*/
clearTextInput() { clearTextInput() {
this.value = ''; this.value = '';
} }
/**
* @hidden
*/
inputBlurred(ev: any) { inputBlurred(ev: any) {
this.ionBlur.emit(ev); this.ionBlur.emit(ev);
@ -184,19 +171,11 @@ export class Textarea implements TextareaComponent {
this.emitStyle(); this.emitStyle();
} }
/**
* @hidden
*/
inputChanged(ev: any) { inputChanged(ev: any) {
this.value = ev.target && ev.target.value; this.value = ev.target && ev.target.value;
this.emitStyle(); this.emitStyle();
} }
/**
* @hidden
*/
inputFocused(ev: any) { inputFocused(ev: any) {
this.ionFocus.emit(ev); this.ionFocus.emit(ev);
@ -204,17 +183,12 @@ export class Textarea implements TextareaComponent {
this.emitStyle(); this.emitStyle();
} }
/**
* @hidden
*/
inputKeydown() { inputKeydown() {
this.checkClearOnEdit(); this.checkClearOnEdit();
} }
/** /**
* Check if we need to clear the text input if clearOnEdit is enabled * Check if we need to clear the text input if clearOnEdit is enabled
* @hidden
*/ */
checkClearOnEdit() { checkClearOnEdit() {
if (!this.clearOnEdit) { if (!this.clearOnEdit) {
@ -231,10 +205,6 @@ export class Textarea implements TextareaComponent {
this.didBlurAfterEdit = false; this.didBlurAfterEdit = false;
} }
/**
* @hidden
*/
focusChange(inputHasFocus: boolean) { focusChange(inputHasFocus: boolean) {
// If clearOnEdit is enabled and the input blurred but has a value, set a flag // If clearOnEdit is enabled and the input blurred but has a value, set a flag
if (this.clearOnEdit && !inputHasFocus && this.hasValue()) { if (this.clearOnEdit && !inputHasFocus && this.hasValue()) {
@ -242,24 +212,15 @@ export class Textarea implements TextareaComponent {
} }
} }
/**
* @hidden
*/
hasFocus(): boolean { hasFocus(): boolean {
// check if an input has focus or not // check if an input has focus or not
return this.el && (this.el.querySelector(':focus') === this.el.querySelector('textarea')); return this.el && (this.el.querySelector(':focus') === this.el.querySelector('textarea'));
} }
/**
* @hidden
*/
hasValue(): boolean { hasValue(): boolean {
return (this.value !== null && this.value !== undefined && this.value !== ''); return (this.value !== null && this.value !== undefined && this.value !== '');
} }
render() { render() {
const themedClasses = createThemedClasses(this.mode, this.color, 'text-input'); const themedClasses = createThemedClasses(this.mode, this.color, 'text-input');
// TODO aria-labelledby={this.item.labelId} // TODO aria-labelledby={this.item.labelId}