Skip to content

Commit 01bd4ca

Browse files
ViktorSlavovjackofdiamond5
authored andcommitted
docs(date-range): update API snippets
1 parent a7e38af commit 01bd4ca

File tree

2 files changed

+182
-44
lines changed

2 files changed

+182
-44
lines changed

projects/igniteui-angular/src/lib/date-range/igx-date-range-inputs.common.ts

+49
Original file line numberDiff line numberDiff line change
@@ -85,20 +85,69 @@ class IgxDateRangeBaseComponent extends IgxInputGroupComponent implements OnInit
8585
}
8686
}
8787

88+
/**
89+
* Defines the start input for a date range picker
90+
*
91+
* @igxModule IgxDateRangeModule
92+
*
93+
* @igxTheme igx-input-group-theme, igx-calendar-theme
94+
*
95+
* @igxKeywords date, range, date range, date picker
96+
*
97+
* @igxGroup scheduling
98+
*
99+
* @remarks
100+
* When templating, start input has to be template seperately
101+
*
102+
* @example
103+
* ```html
104+
* <igx-date-range mode="dropdown">
105+
* <igx-date-start>
106+
* <input igxInput igxDateTimeEditor type="text" required>
107+
* </igx-date-start>
108+
* ...
109+
* </igx-date-range>
110+
* ```
111+
*/
88112
@Component({
89113
selector: 'igx-date-start',
90114
templateUrl: '../input-group/input-group.component.html',
91115
providers: [{ provide: IgxInputGroupBase, useExisting: IgxDateStartComponent }]
92116
})
93117
export class IgxDateStartComponent extends IgxDateRangeBaseComponent { }
94118

119+
/**
120+
* Defines the end input for a date range picker
121+
*
122+
* @igxModule IgxDateRangeModule
123+
*
124+
* @igxTheme igx-input-group-theme, igx-calendar-theme
125+
*
126+
* @igxKeywords date, range, date range, date picker
127+
*
128+
* @igxGroup scheduling
129+
*
130+
* @remarks
131+
* When templating, end input has to be template seperately
132+
*
133+
* @example
134+
* ```html
135+
* <igx-date-range mode="dropdown">
136+
* <igx-date-end>
137+
* <input igxInput igxDateTimeEditor type="text" required>
138+
* </igx-date-end>
139+
* ...
140+
* </igx-date-range>
141+
* ```
142+
*/
95143
@Component({
96144
selector: 'igx-date-end',
97145
templateUrl: '../input-group/input-group.component.html',
98146
providers: [{ provide: IgxInputGroupBase, useExisting: IgxDateEndComponent }]
99147
})
100148
export class IgxDateEndComponent extends IgxDateRangeBaseComponent { }
101149

150+
/** @hidden @internal */
102151
@Component({
103152
selector: 'igx-date-single',
104153
templateUrl: 'igx-date-range-inputs.common.html',

0 commit comments

Comments
 (0)