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

docs(segment): update docs

Browse Source
This commit is contained in:
mhartington
2016-02-02 13:36:53 -05:00
parent 7f068a25ec
commit ed027fa951
1 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
ionic/components/segment/segment.ts
View File

@ -8,7 +8,6 @@ import {isDefined} from '../../util/util';
* @name SegmentButton * @name SegmentButton
* @description * @description
* The child buttons of the `ion-segment` component. Each `ion-segment-button` must have a value. * The child buttons of the `ion-segment` component. Each `ion-segment-button` must have a value.
* @property {string} [value] - the value of the segment-button. Required.
* @usage * @usage
* ```html * ```html
* <ion-segment [(ngModel)]="relationship" primary> * <ion-segment [(ngModel)]="relationship" primary>
@ -39,7 +38,9 @@ import {isDefined} from '../../util/util';
* </form> * </form>
* ``` * ```
* *
* @property {string} [value] - the value of the segment-button. Required.
* @property {Any} [click] - expression to evaluate when a segment button has been clicked * @property {Any} [click] - expression to evaluate when a segment button has been clicked
* @property {Any} (select) - expression to evaluate when a segment selection has been changed
* *
* @demo /docs/v2/demos/segment/ * @demo /docs/v2/demos/segment/
* @see {@link /docs/v2/components#segment Segment Component Docs} * @see {@link /docs/v2/components#segment Segment Component Docs}
@ -54,7 +55,15 @@ import {isDefined} from '../../util/util';
} }
}) })
export class SegmentButton { export class SegmentButton {
/**
* @private
*/
@Input() value: string; @Input() value: string;
/**
* @private
*/
@Output() select: EventEmitter<SegmentButton> = new EventEmitter(); @Output() select: EventEmitter<SegmentButton> = new EventEmitter();
constructor(private _renderer: Renderer, private _elementRef: ElementRef) {} constructor(private _renderer: Renderer, private _elementRef: ElementRef) {}
@ -137,10 +146,22 @@ export class SegmentButton {
selector: 'ion-segment' selector: 'ion-segment'
}) })
export class Segment { export class Segment {
/**
* @private
*/
value: string; value: string;
/**
* @private
*/
@Output() change: EventEmitter<SegmentButton> = new EventEmitter(); @Output() change: EventEmitter<SegmentButton> = new EventEmitter();
/**
* @private
*/
@ContentChildren(SegmentButton) _buttons: QueryList<SegmentButton>; @ContentChildren(SegmentButton) _buttons: QueryList<SegmentButton>;
constructor(@Optional() ngControl: NgControl) { constructor(@Optional() ngControl: NgControl) {