Skip to content

Commit

Permalink
feat(docs): update link component documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
alicanerdurmaz committed Sep 18, 2024
1 parent 32484da commit d08c681
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions documentation/docs/routing/components/link/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: <Link />

`<Link />` is a component that is used to navigate to different pages in your application.

It's uses [`routerProvider.Link`](/docs/routing/router-provider/#link) under the hood, if [`routerProvider`](/docs/routing/router-provider) is not provided, it will be use [`<a>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) HTML element.
It uses [`routerProvider.Link`](/docs/routing/router-provider/#link) under the hood, if [`routerProvider`](/docs/routing/router-provider) is not provided, it will be use [`<a>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) HTML element.

## Usage

Expand All @@ -20,7 +20,7 @@ const MyComponent = () => {
<Link
go={{
query: {
// `useTable` or `useDataGrid` automatically use this filters to fetch data if `syncWithLocation` is true.
// `useTable` or `useDataGrid` automatically uses these filters to fetch data if `syncWithLocation` is true.
filters: [
{
operator: "eq",
Expand All @@ -44,7 +44,8 @@ const MyComponent = () => {

## Props

The `<Link />` component takes all the props from the [`routerProvider.Link`](/docs/routing/router-provider/#link) and the props that an `<a>` HTML element uses.
The `<Link />` component takes all the props from the [`routerProvider.Link`](/docs/routing/router-provider/#link) and the props that an `<a>` HTML element uses. In addition to these props, it also accepts the `go`
and `to` props to navigate to a specific `resource` defined in the `<Refine />` component.

### go

Expand Down

0 comments on commit d08c681

Please sign in to comment.