|
1 | 1 | import { Directive } from '@angular/core';
|
2 | 2 |
|
3 | 3 | /**
|
4 |
| - * @hidden |
| 4 | + * Allows a custom element to be added at the beginning of the combo list. |
| 5 | + * |
| 6 | + * @igxModule IgxComboModule |
| 7 | + * @igxTheme igx-combo-theme |
| 8 | + * @igxKeywords combobox, combo selection |
| 9 | + * @igxGroup Grids & Lists |
| 10 | + * |
| 11 | + * @example |
| 12 | + * <igx-combo> |
| 13 | + * <ng-template igxComboHeader> |
| 14 | + * <div class="header-class">Custom header</div> |
| 15 | + * <img src=""/> |
| 16 | + * </ng-template> |
| 17 | + * </igx-combo> |
5 | 18 | */
|
6 | 19 | @Directive({ selector: '[igxComboHeader]' })
|
7 | 20 | export class IgxComboHeaderDirective { }
|
8 | 21 |
|
9 | 22 | /**
|
10 |
| - * @hidden |
| 23 | + * Allows a custom element to be added at the end of the combo list. |
| 24 | + * |
| 25 | + * @igxModule IgxComboModule |
| 26 | + * @igxTheme igx-combo-theme |
| 27 | + * @igxKeywords combobox, combo selection |
| 28 | + * @igxGroup Grids & Lists |
| 29 | + * |
| 30 | + * @example |
| 31 | + * <igx-combo> |
| 32 | + * <ng-template igxComboFooter> |
| 33 | + * <div class="footer-class">Custom footer</div> |
| 34 | + * <img src=""/> |
| 35 | + * </ng-template> |
| 36 | + * </igx-combo> |
11 | 37 | */
|
12 | 38 | @Directive({ selector: '[igxComboFooter]' })
|
13 | 39 | export class IgxComboFooterDirective { }
|
14 | 40 |
|
15 | 41 | /**
|
16 |
| - * @hidden |
| 42 | + * Allows the combo's items to be modified with a custom template |
| 43 | + * |
| 44 | + * @igxModule IgxComboModule |
| 45 | + * @igxTheme igx-combo-theme |
| 46 | + * @igxKeywords combobox, combo selection |
| 47 | + * @igxGroup Grids & Lists |
| 48 | + * |
| 49 | + * @example |
| 50 | + * <igx-combo> |
| 51 | + * <ng-template igxComboItem let-display let-key="valueKey"> |
| 52 | + * <div class="item"> |
| 53 | + * <span class="state">State: {{ display[key] }}</span> |
| 54 | + * <span class="region">Region: {{ display.region }}</span> |
| 55 | + * </div> |
| 56 | + * </ng-template> |
| 57 | + * </igx-combo> |
17 | 58 | */
|
18 | 59 | @Directive({ selector: '[igxComboItem]' })
|
19 | 60 | export class IgxComboItemDirective { }
|
20 | 61 |
|
21 | 62 | /**
|
22 |
| - * @hidden |
| 63 | + * Defines the custom template that will be displayed when the combo's list is empty |
| 64 | + * |
| 65 | + * @igxModule IgxComboModule |
| 66 | + * @igxTheme igx-combo-theme |
| 67 | + * @igxKeywords combobox, combo selection |
| 68 | + * @igxGroup Grids & Lists |
| 69 | + * |
| 70 | + * @example |
| 71 | + * <igx-combo> |
| 72 | + * <ng-template igxComboEmpty> |
| 73 | + * <div class="combo--empty"> |
| 74 | + * There are no items to display |
| 75 | + * </div> |
| 76 | + * </ng-template> |
| 77 | + * </igx-combo> |
23 | 78 | */
|
24 | 79 | @Directive({ selector: '[igxComboEmpty]' })
|
25 | 80 | export class IgxComboEmptyDirective { }
|
26 | 81 |
|
27 | 82 | /**
|
28 |
| - * @hidden |
| 83 | + * Defines the custom template that will be used when rendering header items for groups in the combo's list |
| 84 | + * |
| 85 | + * @igxModule IgxComboModule |
| 86 | + * @igxTheme igx-combo-theme |
| 87 | + * @igxKeywords combobox, combo selection |
| 88 | + * @igxGroup Grids & Lists |
| 89 | + * |
| 90 | + * @example |
| 91 | + * <igx-combo> |
| 92 | + * <ng-template igxComboHeaderItem let-item let-key="groupKey"> |
| 93 | + * <div class="custom-item--group">Group header for {{ item[key] }}</div> |
| 94 | + * </ng-template> |
| 95 | + * </igx-combo> |
29 | 96 | */
|
30 | 97 | @Directive({ selector: '[igxComboHeaderItem]' })
|
31 | 98 | export class IgxComboHeaderItemDirective { }
|
32 | 99 |
|
33 | 100 | /**
|
34 |
| - * @hidden |
| 101 | + * Defines the custom template that will be used to display the `ADD` button |
| 102 | + * |
| 103 | + * @remarks To show the `ADD` button, the `allowCustomValues` option must be enabled |
| 104 | + * |
| 105 | + * @igxModule IgxComboModule |
| 106 | + * @igxTheme igx-combo-theme |
| 107 | + * @igxKeywords combobox, combo selection |
| 108 | + * @igxGroup Grids & Lists |
| 109 | + * |
| 110 | + * @example |
| 111 | + * <igx-combo #combo> |
| 112 | + * <ng-template igxComboAddItem> |
| 113 | + * <button class="combo__add-button"> |
| 114 | + * Click to add item |
| 115 | + * </button> |
| 116 | + * </ng-template> |
| 117 | + * </igx-combo> |
35 | 118 | */
|
36 | 119 | @Directive({ selector: '[igxComboAddItem]' })
|
37 | 120 | export class IgxComboAddItemDirective { }
|
38 | 121 |
|
39 | 122 | /**
|
40 |
| - * @hidden |
| 123 | + * The custom template that will be used when rendering the combo's toggle button |
| 124 | + * |
| 125 | + * @igxModule IgxComboModule |
| 126 | + * @igxTheme igx-combo-theme |
| 127 | + * @igxKeywords combobox, combo selection |
| 128 | + * @igxGroup Grids & Lists |
| 129 | + * |
| 130 | + * @example |
| 131 | + * <igx-combo #combo> |
| 132 | + * <ng-template igxComboToggleIcon let-collapsed> |
| 133 | + * <igx-icon>{{ collapsed ? 'remove_circle' : 'remove_circle_outline'}}</igx-icon> |
| 134 | + * </ng-template> |
| 135 | + * </igx-combo> |
41 | 136 | */
|
42 | 137 | @Directive({ selector: '[igxComboToggleIcon]' })
|
43 | 138 | export class IgxComboToggleIconDirective { }
|
44 | 139 |
|
45 | 140 | /**
|
46 |
| - * @hidden |
| 141 | + * Defines the custom template that will be used when rendering the combo's clear icon |
| 142 | + * |
| 143 | + * @igxModule IgxComboModule |
| 144 | + * @igxTheme igx-combo-theme |
| 145 | + * @igxKeywords combobox, combo selection |
| 146 | + * @igxGroup Grids & Lists |
| 147 | + * |
| 148 | + * @example |
| 149 | + * <igx-combo #combo> |
| 150 | + * <ng-template igxComboClearIcon> |
| 151 | + * <igx-icon>clear</igx-icon> |
| 152 | + * </ng-template> |
| 153 | + * </igx-combo> |
47 | 154 | */
|
48 | 155 | @Directive({ selector: '[igxComboClearIcon]' })
|
49 | 156 | export class IgxComboClearIconDirective { }
|
50 |
| - |
|
0 commit comments