Skip to content

Commit 2e82839

Browse files
Copilotdkamburov
andauthored
Revert "feat(docs): remove Angular-specific items from public API docs"
This reverts commit 35bf50e. Co-authored-by: dkamburov <1182001+dkamburov@users.noreply.github.com>
1 parent 35bf50e commit 2e82839

172 files changed

Lines changed: 10147 additions & 8 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

package-lock.json

Lines changed: 64 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

projects/igniteui-angular/accordion/src/accordion/accordion.component.ts

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,25 @@ let NEXT_ID = 0;
3030
/**
3131
* IgxAccordion is a container-based component that contains that can house multiple expansion panels.
3232
*
33+
* @igxModule IgxAccordionModule
34+
*
35+
* @igxKeywords accordion
36+
*
37+
* @igxGroup Layouts
38+
*
3339
* @remarks
3440
* The Ignite UI for Angular Accordion component enables the user to navigate among multiple collapsing panels
3541
* displayed in a single container.
3642
* The accordion offers keyboard navigation and API to control the underlying panels' expansion state.
43+
*
44+
* @example
45+
* ```html
46+
* <igx-accordion>
47+
* <igx-expansion-panel *ngFor="let panel of panels">
48+
* ...
49+
* </igx-expansion-panel>
50+
* </igx-accordion>
51+
* ```
3752
*/
3853
@Component({
3954
selector: 'igx-accordion',
@@ -46,6 +61,12 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
4661
/**
4762
* Get/Set the `id` of the accordion component.
4863
* Default value is `"igx-accordion-0"`;
64+
* ```html
65+
* <igx-accordion id="my-first-accordion"></igx-accordion>
66+
* ```
67+
* ```typescript
68+
* const accordionId = this.accordion.id;
69+
* ```
4970
*/
5071
@HostBinding('attr.id')
5172
@Input()
@@ -61,6 +82,19 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
6182

6283
/**
6384
* Get/Set the animation settings that panels should use when expanding/collpasing.
85+
*
86+
* ```html
87+
* <igx-accordion [animationSettings]="customAnimationSettings"></igx-accordion>
88+
* ```
89+
*
90+
* ```typescript
91+
* const customAnimationSettings: ToggleAnimationSettings = {
92+
* openAnimation: growVerIn,
93+
* closeAnimation: growVerOut
94+
* };
95+
*
96+
* this.accordion.animationSettings = customAnimationSettings;
97+
* ```
6498
*/
6599
@Input()
66100
public get animationSettings(): ToggleAnimationSettings {
@@ -75,6 +109,16 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
75109
/**
76110
* Get/Set how the accordion handles the expansion of the projected expansion panels.
77111
* If set to `true`, only a single panel can be expanded at a time, collapsing all others
112+
*
113+
* ```html
114+
* <igx-accordion [singleBranchExpand]="true">
115+
* ...
116+
* </igx-accordion>
117+
* ```
118+
*
119+
* ```typescript
120+
* this.accordion.singleBranchExpand = false;
121+
* ```
78122
*/
79123
@Input({ transform: booleanAttribute })
80124
public get singleBranchExpand(): boolean {
@@ -93,12 +137,38 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
93137
*
94138
* @remarks
95139
* This event is cancelable.
140+
*
141+
* ```html
142+
* <igx-accordion (panelExpanding)="handlePanelExpanding($event)">
143+
* </igx-accordion>
144+
* ```
145+
*
146+
*```typescript
147+
* public handlePanelExpanding(event: IExpansionPanelCancelableEventArgs){
148+
* const expandedPanel: IgxExpansionPanelComponent = event.panel;
149+
* if (expandedPanel.disabled) {
150+
* event.cancel = true;
151+
* }
152+
* }
153+
*```
96154
*/
97155
@Output()
98156
public panelExpanding = new EventEmitter<IAccordionCancelableEventArgs>();
99157

100158
/**
101159
* Emitted after a panel has been expanded.
160+
*
161+
* ```html
162+
* <igx-accordion (panelExpanded)="handlePanelExpanded($event)">
163+
* </igx-accordion>
164+
* ```
165+
*
166+
*```typescript
167+
* public handlePanelExpanded(event: IExpansionPanelCancelableEventArgs) {
168+
* const expandedPanel: IgxExpansionPanelComponent = event.panel;
169+
* console.log("Panel is expanded: ", expandedPanel.id);
170+
* }
171+
*```
102172
*/
103173
@Output()
104174
public panelExpanded = new EventEmitter<IAccordionEventArgs>();
@@ -108,18 +178,32 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
108178
*
109179
* @remarks
110180
* This event is cancelable.
181+
*
182+
* ```html
183+
* <igx-accordion (panelCollapsing)="handlePanelCollapsing($event)">
184+
* </igx-accordion>
185+
* ```
111186
*/
112187
@Output()
113188
public panelCollapsing = new EventEmitter<IAccordionCancelableEventArgs>();
114189

115190
/**
116191
* Emitted after a panel has been collapsed.
192+
*
193+
* ```html
194+
* <igx-accordion (panelCollapsed)="handlePanelCollapsed($event)">
195+
* </igx-accordion>
196+
* ```
117197
*/
118198
@Output()
119199
public panelCollapsed = new EventEmitter<IAccordionEventArgs>();
120200

121201
/**
122202
* Get all panels.
203+
*
204+
* ```typescript
205+
* const panels: IgxExpansionPanelComponent[] = this.accordion.panels;
206+
* ```
123207
*/
124208
public get panels(): IgxExpansionPanelComponent[] {
125209
return this._panels?.toArray();
@@ -163,6 +247,10 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
163247

164248
/**
165249
* Expands all collapsed expansion panels.
250+
*
251+
* ```typescript
252+
* accordion.expandAll();
253+
* ```
166254
*/
167255
public expandAll(): void {
168256
if (this.singleBranchExpand) {
@@ -178,6 +266,10 @@ export class IgxAccordionComponent implements AfterContentInit, AfterViewInit, O
178266

179267
/**
180268
* Collapses all expanded expansion panels.
269+
*
270+
* ```typescript
271+
* accordion.collapseAll();
272+
* ```
181273
*/
182274
public collapseAll(): void {
183275
this.panels.forEach(panel => panel.collapse());

projects/igniteui-angular/action-strip/src/action-strip/action-strip.component.ts

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,25 @@ export class IgxActionStripMenuItemDirective {
5757
/**
5858
* Action Strip provides templatable area for one or more actions.
5959
*
60+
* @igxModule IgxActionStripModule
61+
*
62+
* @igxTheme igx-action-strip-theme
63+
*
64+
* @igxKeywords action, strip, actionStrip, pinning, editing
65+
*
66+
* @igxGroup Data Entry & Display
67+
*
68+
* @igxParent IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxRowIslandComponent, *
69+
*
6070
* @remarks
6171
* The Ignite UI Action Strip is a container, overlaying its parent container,
6272
* and displaying action buttons with action applicable to the parent component the strip is instantiated or shown for.
73+
*
74+
* @example
75+
* ```html
76+
* <igx-action-strip #actionStrip>
77+
* <igx-icon (click)="doSomeAction()"></igx-icon>
78+
* </igx-action-strip>
6379
*/
6480
@Component({
6581
selector: 'igx-action-strip',
@@ -89,6 +105,11 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
89105
* Sets the context of an action strip.
90106
* The context should be an instance of a @Component, that has element property.
91107
* This element will be the placeholder of the action strip.
108+
*
109+
* @example
110+
* ```html
111+
* <igx-action-strip [context]="cell"></igx-action-strip>
112+
* ```
92113
*/
93114
@Input()
94115
public context: any;
@@ -119,6 +140,11 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
119140
/**
120141
* Gets/Sets the visibility of the Action Strip.
121142
* Could be used to set if the Action Strip will be initially hidden.
143+
*
144+
* @example
145+
* ```html
146+
* <igx-action-strip [hidden]="false">
147+
* ```
122148
*/
123149
@Input({ transform: booleanAttribute })
124150
public hidden = true;
@@ -259,6 +285,10 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
259285
* Showing the Action Strip and appending it the specified context element.
260286
*
261287
* @param context
288+
* @example
289+
* ```typescript
290+
* this.actionStrip.show(row);
291+
* ```
262292
*/
263293
public show(context?: any): void {
264294
this.hidden = false;
@@ -278,6 +308,11 @@ export class IgxActionStripComponent implements IgxActionStripToken, AfterViewIn
278308

279309
/**
280310
* Hiding the Action Strip and removing it from its current context element.
311+
*
312+
* @example
313+
* ```typescript
314+
* this.actionStrip.hide();
315+
* ```
281316
*/
282317
public hide(): void {
283318
this.hidden = true;

0 commit comments

Comments
 (0)