Skip to content

Commit

Permalink
[docs] Link API object in the apiRef sections (#8106)
Browse files Browse the repository at this point in the history
  • Loading branch information
MBilalShafi authored Mar 3, 2023
1 parent 34836e9 commit 4d6f62e
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/data/data-grid/cell-selection/cell-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ If a single cell is selected, all classes above are applied to the same element.

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`.
The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

:::warning
Only use this API as the last option. Give preference to the props to control the grid.
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/column-pinning/column-pinning.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ The demo below contains an example of both features enabled:

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

{{"demo": "ColumnPinningApiNoSnap.js", "bg": "inline", "hideToolbar": true}}

## API
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/editing/editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,8 @@ See [Editing recipes](/x/react-data-grid/recipes-editing/) for more advanced use

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

{{"demo": "EditApiNoSnap.js", "bg": "inline", "hideToolbar": true}}

## API
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/export/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,8 @@ You will be able to copy and paste items to and from the data grid using the sys

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

:::warning
Only use this API as the last option. Give preference to the props to control the data grid.
:::
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/filtering/filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,8 @@ In the following demo, the quick filter value `"Saint Martin, Saint Lucia"` will

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

:::warning
Only use this API as the last option. Give preference to the props to control the data grid.
:::
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/master-detail/master-detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ Notice that the toggle column is pinned to make sure that it will always be visi

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

{{"demo": "DetailPanelApiNoSnap.js", "bg": "inline", "hideToolbar": true}}

## API
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/pagination/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ You can customize the rendering of the pagination in the footer following [the c

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

:::warning
Only use this API as the last option. Give preference to the props to control the data grid.
:::
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/row-grouping/row-grouping.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,8 @@ See [Row grouping recipes](/x/react-data-grid/recipes-row-grouping/) for more ad

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

{{"demo": "RowGroupingApiNoSnap.js", "bg": "inline", "hideToolbar": true}}

## API
Expand Down
2 changes: 1 addition & 1 deletion docs/data/data-grid/row-selection/row-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The following demo shows the prop in action:

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`.
The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

:::warning
Only use this API as the last option. Give preference to the props to control the data grid.
Expand Down
2 changes: 2 additions & 0 deletions docs/data/data-grid/scrolling/scrolling.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ The following demo explores the usage of this API:

## apiRef

The grid exposes a set of methods that enables all of these features using the imperative `apiRef`. To know more about how to use it, check the [API Object](/x/react-data-grid/api-object/) section.

:::warning
Only use this API as the last option. Give preference to the props to control the data grid.
:::
Expand Down

0 comments on commit 4d6f62e

Please sign in to comment.