Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): add description to deprecated props on refine component #6351

Merged
merged 2 commits into from
Sep 19, 2024
Merged

feat(docs): add description to deprecated props on refine component #6351

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
481e759
feat(docs): add description to deprecated props on refine component
alicanerdurmaz Sep 18, 2024
62e7478
fix(docs): code sample
alicanerdurmaz Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion documentation/docs/core/refine-component/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,8 @@ Callback to handle all live events.

## ~~catchAll~~ <PropTag deprecated />

| 🚨 Use the `<CustomErrorPage />` component in your routes instead.

When the app is navigated to a non-existent route, Refine shows a default error page. A custom error component can be used for this error page by passing the customized component to the `catchAll` property:

```tsx title="App.tsx"
Expand All @@ -736,6 +738,8 @@ const App = () => (

## ~~LoginPage~~ <PropTag deprecated />

| 🚨 Use the `<AuthPage />` component in your routes instead.

Refine has a default login page form which is served on the `/login` route when the `authProvider` configuration is provided.

Custom login component can be passed to the `LoginPage` property.
Expand All @@ -754,6 +758,8 @@ const App = () => (

## ~~DashboardPage~~ <PropTag deprecated />

| 🚨 Use the `<DashboardPage />` component in your routes instead.
alicanerdurmaz marked this conversation as resolved.
Show resolved Hide resolved

A custom dashboard page can be passed to the `DashboardPage` prop which is accessible on the root route.

The dashboard item will appear at the top of the sider menu. If `DashboardPage` is not given, the first resource of `resources` will be shown.
Expand Down Expand Up @@ -790,12 +796,16 @@ const App = () => (

## ~~Sider~~ <PropTag deprecated />

| 🚨 Use `Sider` prop of `<ThemedLayoutV2 />` component instead.

The default sidebar can be customized by using Refine hooks and passing custom components to the `Sider` property.

> For more information, refer to the [`useMenu` hook documentation &#8594](/docs/core/hooks/utilities/use-menu)

## ~~Footer~~ <PropTag deprecated />

| 🚨 Use `Footer` prop of `<ThemedLayoutV2 />` component instead.

The default app footer can be customized by passing the `Footer` property.

```tsx title="App.tsx"
Expand All @@ -812,7 +822,7 @@ const App = () => (

## ~~Header~~ <PropTag deprecated />

The default app header can be customized by passing the `Header` property.
| 🚨 Use `Header` prop of `<ThemedLayoutV2 />` component instead.

```tsx title="App.tsx"
// highlight-next-line
Expand All @@ -828,6 +838,8 @@ const App = () => (

## ~~Layout~~ <PropTag deprecated />

| 🚨 Use `<ThemedLayoutV2 />` as children of `<Refine />` instead.

The default layout can be customized by passing the `Layout` property.

Layout property will receive individual layout components as property.
Expand Down Expand Up @@ -873,6 +885,8 @@ const App = () => (

## ~~OffLayoutArea~~ <PropTag deprecated />

| 🚨 Use `OffLayoutArea` prop of `<ThemedLayoutV2 />` component instead.

The component wanted to be placed out of the app layout structure can be set by passing to the `OffLayoutArea` prop.

```tsx title="App.tsx"
Expand All @@ -888,6 +902,8 @@ const App = () => (

## ~~Title~~ <PropTag deprecated />

| 🚨 Use `Title` prop of `<ThemedLayoutV2 />` component instead.

The app title can be set by passing the `Title` property.

```tsx title="App.tsx"
Expand Down
Loading