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

docs(all): improve type docs for event

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-12-28 20:12:54 +01:00
committed by Manu MA
parent b3316d480f
commit 3d656ac312
74 changed files with 380 additions and 371 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/src/components/segment/readme.md
View File

@ -219,10 +219,10 @@ for (let i = 0; i < segments.length; i++) {
## Events
| Event | Description | Detail |
| ----------- | -------------------------------------------- | -------------------- |
| `ionChange` | Emitted when the value property has changed. | TextInputChangeEvent |
| `ionStyle` | Emitted when the styles change. | StyleEvent |
| Event | Description | Type |
| ----------- | -------------------------------------------- | --------------------------------------- |
| `ionChange` | Emitted when the value property has changed. | `CustomEvent<SegmentChangeEventDetail>` |
| `ionStyle` | Emitted when the styles change. | `CustomEvent<StyleEventDetail>` |
----------------------------------------------

6
core/src/components/segment/segment-interface.ts Normal file
View File

@ -0,0 +1,6 @@
export type SegmentButtonLayout = 'icon-top' | 'icon-start' | 'icon-end' | 'icon-bottom' | 'icon-hide' | 'label-hide';
export interface SegmentChangeEventDetail {
value: string | undefined;
}

6
core/src/components/segment/segment.tsx
View File

@ -1,6 +1,6 @@
import { Component, ComponentInterface, Element, Event, EventEmitter, Listen, Prop, Watch } from '@stencil/core';
import { Color, Mode, StyleEvent, TextInputChangeEvent } from '../../interface';
import { Color, Mode, SegmentChangeEventDetail, StyleEventDetail } from '../../interface';
import { createColorClasses } from '../../utils/theme';
@Component({
@ -51,12 +51,12 @@ export class Segment implements ComponentInterface {
/**
* Emitted when the value property has changed.
*/
@Event() ionChange!: EventEmitter<TextInputChangeEvent>;
@Event() ionChange!: EventEmitter<SegmentChangeEventDetail>;
/**
* Emitted when the styles change.
*/
@Event() ionStyle!: EventEmitter<StyleEvent>;
@Event() ionStyle!: EventEmitter<StyleEventDetail>;
@Listen('ionSelect')
segmentClick(ev: CustomEvent) {