Skip to content

Commit 32e760f

Browse files
authored
Fix stale Angular API links for renamed events and progress components (#362)
1 parent 47ef92b commit 32e760f

6 files changed

Lines changed: 19 additions & 19 deletions

File tree

docs/angular/src/content/en/components/circular-progress.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,22 +86,22 @@ To have a better understanding how everything works, let's create a simple examp
8686
After that, we should have the demo sample in your browser.
8787

8888
<DocsAside type="info">
89-
The **igx-circular-bar** emits <ApiLink type="ProgressBarGradientDirective" member="onProgressChanged" label="onProgressChanged" /> event that outputs an object like this `{currentValue: 65, previousValue: 64}` on each step.
89+
The **igx-circular-bar** emits <ApiLink type="CircularProgressBar" member="progressChanged" label="progressChanged" /> event that outputs an object like this `{currentValue: 65, previousValue: 64}` on each step.
9090
</DocsAside>
9191
<DocsAside type="info">
92-
The default progress increments by **1% of the <ApiLink type="ProgressBarGradientDirective" member="max" label="max" /> value** per update cycle, this happens if the <ApiLink type="ProgressBarGradientDirective" member="step" label="step" /> value is not defined. To change the update rate, the <ApiLink type="ProgressBarGradientDirective" member="step" label="step" /> value should be defined.```
92+
The default progress increments by **1% of the <ApiLink type="CircularProgressBar" member="max" label="max" /> value** per update cycle, this happens if the <ApiLink type="CircularProgressBar" member="step" label="step" /> value is not defined. To change the update rate, the <ApiLink type="CircularProgressBar" member="step" label="step" /> value should be defined.
9393
</DocsAside>
9494

9595
### Indeterminate Progress
9696

97-
If you want to track a process that is not determined precisely, you can set the <ApiLink type="ProgressBarGradientDirective" member="indeterminate" label="indeterminate" /> input property to `true`.
97+
If you want to track a process that is not determined precisely, you can set the <ApiLink type="CircularProgressBar" member="indeterminate" label="indeterminate" /> input property to `true`.
9898

9999
```html
100100
<igx-circular-bar [animate]="false" [indeterminate]="true" [textVisibility]="false"></igx-circular-bar>
101101
```
102102

103103
<DocsAside type="info">
104-
You can hide the text of the circular progress bar by setting the <ApiLink type="ProgressBarGradientDirective" member="textVisibility" label="textVisibility" /> property to `false`.
104+
You can hide the text of the circular progress bar by setting the <ApiLink type="CircularProgressBar" member="textVisibility" label="textVisibility" /> property to `false`.
105105
</DocsAside>
106106

107107
The final result should be:
@@ -185,7 +185,7 @@ Add some styles:
185185
### Gradient Progress
186186

187187
One way to customize the progress bar is by using a color gradient instead of a solid color.
188-
This can be done in one of two ways - by using the <ApiLink type="ProgressBarGradientDirective" member="gradienttemplate" label="IgxProgressBarGradientDirective" /> directive or by implementing a custom theme, which supports up to two color stops.
188+
This can be done in one of two ways - by using the <ApiLink type="CircularProgressBar" member="gradientTemplate" label="IgxProgressBarGradientDirective" /> directive or by implementing a custom theme, which supports up to two color stops.
189189

190190
To create a gradient with just two color stops using a custom theme, you need to create a list of colors and pass it to the `$fill-color-default` theme parameter:
191191

docs/angular/src/content/en/components/linear-progress.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ You can set the type of your bar, using the <ApiLink type="LinearProgressBar" me
8787

8888
### Striped Progress
8989

90-
You can make the bar striped, using the <ApiLink type="LinearProgressBar" member="type" label="striped" /> property and by setting it to `true`.
90+
You can make the bar striped, using the <ApiLink type="LinearProgressBar" member="striped" label="striped" /> property and by setting it to `true`.
9191

9292
Let's see how we can create different types of progress bars that can be both striped or not.
9393

@@ -111,11 +111,11 @@ So if we set up everything correctly, you should see the following in your brows
111111

112112
### Indeterminate Progress
113113

114-
If you want to track a process that is not determined precisely, you can set the <ApiLink type="ProgressBarGradientDirective" member="indeterminate" label="indeterminate" /> input property to `true`.
114+
If you want to track a process that is not determined precisely, you can set the <ApiLink type="LinearProgressBar" member="indeterminate" label="indeterminate" /> input property to `true`.
115115

116116
### Animation Duration
117117

118-
The <ApiLink type="ProgressBarGradientDirective" member="animationDuration" label="animationDuration" /> input property is used to specify how long the animation cycle should take.
118+
The <ApiLink type="LinearProgressBar" member="animationDuration" label="animationDuration" /> input property is used to specify how long the animation cycle should take.
119119

120120
The following example specifies the animation duration set to 5 seconds.
121121

docs/angular/src/content/en/grids_templates/column-selection.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ The column selection UI has a few more APIs to explore, which are listed below.
225225

226226
<ApiLink type="{ComponentApiType}" /> events:
227227

228-
- <ApiLink type="{ComponentApiType}" member="onColumnsSelectionChange" label="onColumnsSelectionChange" />
228+
- <ApiLink type="{ComponentApiType}" member="columnSelectionChanging" label="columnSelectionChanging" />
229229

230230
## Additional Resources
231231

docs/angular/src/content/en/grids_templates/conditional-cell-styling.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,7 @@ Define a `popin` animation
671671
## Known issues and limitations
672672

673673
- If there are cells bind to the same condition (from different columns) and one cell is updated, the other cells won't be updated based on the new value, if the condition is met.
674-
A pipe check should be performed in order to apply the changes to the rest of the cells. The example below shows how to do that with a `spread operator(...)` on <ApiLink type="Grid" member="onCellEdit" label="onCellEdit" /> event. This will copy the original object with a new instance, and lead pure pipe to be fired.
674+
A pipe check should be performed in order to apply the changes to the rest of the cells. The example below shows how to do that with a `spread operator(...)` on <ApiLink type="Grid" member="cellEdit" label="cellEdit" /> event. This will copy the original object with a new instance, and lead pure pipe to be fired.
675675

676676
```ts
677677
public backgroundClasses = {
@@ -690,7 +690,7 @@ editDone(evt) {
690690
<ComponentBlock for="Grid">
691691

692692
```html
693-
<igx-grid #grid1 [data]="data" height="500px" width="100%" (onCellEdit)="editDone($event)">
693+
<igx-grid #grid1 [data]="data" height="500px" width="100%" (cellEdit)="editDone($event)">
694694
<igx-column field="Col1" dataType="number" [cellClasses]="backgroundClasses"></igx-column>
695695
<igx-column field="Col2" dataType="number" [editable]="true" [cellClasses]="backgroundClasses"></igx-column>
696696
<igx-column field="Col3" header="Col3" dataType="string" [cellClasses]="backgroundClasses"></igx-column>
@@ -701,7 +701,7 @@ editDone(evt) {
701701
<ComponentBlock for="TreeGrid">
702702

703703
```html
704-
<igx-tree-grid #grid1 [data]="data" height="500px" width="100%" (onCellEdit)="editDone($event)">
704+
<igx-tree-grid #grid1 [data]="data" height="500px" width="100%" (cellEdit)="editDone($event)">
705705
<igx-column field="Col1" dataType="number" [cellClasses]="backgroundClasses"></igx-column>
706706
<igx-column field="Col2" dataType="number" [editable]="true" [cellClasses]="backgroundClasses"></igx-column>
707707
<igx-column field="Col3" header="Col3" dataType="string" [cellClasses]="backgroundClasses"></igx-column>
@@ -712,7 +712,7 @@ editDone(evt) {
712712
<ComponentBlock for="HierarchicalGrid">
713713

714714
```html
715-
<igx-hierarchical-grid #grid1 [data]="data" height="500px" width="100%" (onCellEdit)="editDone($event)">
715+
<igx-hierarchical-grid #grid1 [data]="data" height="500px" width="100%" (cellEdit)="editDone($event)">
716716
<igx-column field="Col1" dataType="number" [cellClasses]="backgroundClasses"></igx-column>
717717
<igx-column field="Col2" dataType="number" [editable]="true" [cellClasses]="backgroundClasses"></igx-column>
718718
<igx-column field="Col3" header="Col3" dataType="string" [cellClasses]="backgroundClasses"></igx-column>

docs/angular/src/content/en/grids_templates/row-adding.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -320,10 +320,10 @@ The row adding UI comprises the buttons in the `IgxActionStrip` editing actions,
320320

321321
## API References
322322
- <ApiLink type="{ComponentApiType}" member="rowEditable" label="rowEditable" />
323-
- <ApiLink type="{ComponentApiType}" member="onRowEditEnter" label="onRowEditEnter" />
324-
- <ApiLink type="{ComponentApiType}" member="onRowEdit" label="onRowEdit" />
323+
- <ApiLink type="{ComponentApiType}" member="rowEditEnter" label="rowEditEnter" />
324+
- <ApiLink type="{ComponentApiType}" member="rowEdit" label="rowEdit" />
325325
- <ApiLink type="{ComponentApiType}" member="rowEditDone" label="rowEditDone" />
326-
- <ApiLink type="{ComponentApiType}" member="onRowEditCancel" label="onRowEditCancel" />
326+
- <ApiLink type="{ComponentApiType}" member="rowEditExit" label="rowEditExit" />
327327
- <ApiLink type="{ComponentApiType}" member="endEdit" label="endEdit" />
328328
- <ApiLink type="{ComponentApiType}" member="primaryKey" label="primaryKey" />
329329
- <ApiLink type="{ComponentApiType}" />

docs/angular/src/content/en/grids_templates/row-editing.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -453,10 +453,10 @@ The sample will not be affected by the selected global theme from `Change Theme`
453453

454454
## API References
455455
- <ApiLink type="{ComponentApiType}" member="rowEditable" label="rowEditable" />
456-
- <ApiLink type="{ComponentApiType}" member="onRowEditEnter" label="onRowEditEnter" />
457-
- <ApiLink type="{ComponentApiType}" member="onRowEdit" label="onRowEdit" />
456+
- <ApiLink type="{ComponentApiType}" member="rowEditEnter" label="rowEditEnter" />
457+
- <ApiLink type="{ComponentApiType}" member="rowEdit" label="rowEdit" />
458458
- <ApiLink type="{ComponentApiType}" member="rowEditDone" label="rowEditDone" />
459-
- <ApiLink type="{ComponentApiType}" member="onRowEditCancel" label="onRowEditCancel" />
459+
- <ApiLink type="{ComponentApiType}" member="rowEditExit" label="rowEditExit" />
460460
- <ApiLink type="{ComponentApiType}" member="endEdit" label="endEdit" />
461461
- <ApiLink type="Column" member="field" label="field" />
462462
- <ApiLink type="Column" member="editable" label="editable" />

0 commit comments

Comments
 (0)