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.

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

Adopt v2_meta future flag #738

Merged
merged 3 commits into from
Mar 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
74 changes: 74 additions & 0 deletions .changeset/angry-months-pay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
'@shopify/hydrogen': patch
---

Adopt Remix [`v2_meta`](https://remix.run/docs/en/main/route/meta#metav2) future flag

### `v2_meta` migration steps

1. For any routes that you used `meta` route export, convert it to the `V2_MetaFunction` equivalent.

**Before** - returns an object;

```jsx
export const meta: MetaFunction = () => {
return {
title: 'Login',
};
};
```

**After** - returns an array of object:

```jsx
export const meta: V2_MetaFunction = () => {
return [
{
title: 'Login',
},
];
};
```

2. If you are using data from loaders

**Before** - returns an object;

```jsx
export const meta: MetaFunction = ({data}) => ({
title: `Order ${data?.order?.name}`,
});
```

**After** - returns an array of object:

```jsx
export const meta: V2_MetaFunction<typeof loader> = ({data}) => {
return [
{
title: `Order ${data?.order?.name}`,
},
];
};
```

3. If you are using `meta` route export in `root`, convert it to [Global Meta](https://remix.run/docs/en/main/route/meta#global-meta)

```diff
// app/root.tsx

- export const meta: MetaFunction = () => ({
- charset: 'utf-8',
- viewport: 'width=device-width,initial-scale=1',
- });

export default function App() {

return (
<html lang={locale.language}>
<head>
+ <meta charSet="utf-8" />
+ <meta name="viewport" content="width=device-width,initial-scale=1" />
<Seo />
<Meta />
```
10 changes: 4 additions & 6 deletions templates/demo-store/app/root.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import {
defer,
type LinksFunction,
type MetaFunction,
type LoaderArgs,
type AppLoadContext,
} from '@shopify/remix-oxygen';
Expand Down Expand Up @@ -42,11 +41,6 @@ export const links: LinksFunction = () => {
];
};

export const meta: MetaFunction = () => ({
charset: 'utf-8',
viewport: 'width=device-width,initial-scale=1',
});

export async function loader({request, context}: LoaderArgs) {
const [customerAccessToken, cartId, layout] = await Promise.all([
context.session.get('customerAccessToken'),
Expand Down Expand Up @@ -79,6 +73,8 @@ export default function App() {
return (
<html lang={locale.language}>
<head>
<meta charSet="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<Seo />
<Meta />
<Links />
Expand Down Expand Up @@ -136,6 +132,8 @@ export function ErrorBoundary({error}: {error: Error}) {
return (
<html lang={locale.language}>
<head>
<meta charSet="utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<title>Error</title>
<Meta />
<Links />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import clsx from 'clsx';
import {
json,
redirect,
type MetaFunction,
type V2_MetaFunction,
type LoaderArgs,
} from '@shopify/remix-oxygen';
import {useLoaderData} from '@remix-run/react';
Expand All @@ -16,9 +16,9 @@ import type {
} from '@shopify/hydrogen/storefront-api-types';
import {Link, Heading, PageHeader, Text} from '~/components';

export const meta: MetaFunction = ({data}) => ({
title: `Order ${data?.order?.name}`,
});
export const meta: V2_MetaFunction<typeof loader> = ({data}) => {
return [{title: `Order ${data?.order?.name}`}];
};

export async function loader({request, context, params}: LoaderArgs) {
if (!params.id) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
json,
redirect,
type MetaFunction,
type V2_MetaFunction,
type ActionFunction,
} from '@shopify/remix-oxygen';
import {Form, useActionData} from '@remix-run/react';
Expand Down Expand Up @@ -100,10 +100,8 @@ export const action: ActionFunction = async ({
}
};

export const meta: MetaFunction = () => {
return {
title: 'Activate Account',
};
export const meta: V2_MetaFunction = () => {
return [{title: 'Activate Account'}];
};

export default function Activate() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
json,
redirect,
type MetaFunction,
type V2_MetaFunction,
type ActionFunction,
type AppLoadContext,
type LoaderArgs,
Expand Down Expand Up @@ -79,10 +79,8 @@ export const action: ActionFunction = async ({request, context, params}) => {
}
};

export const meta: MetaFunction = () => {
return {
title: 'Login',
};
export const meta: V2_MetaFunction = () => {
return [{title: 'Login'}];
};

export default function Login() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
json,
redirect,
type MetaFunction,
type V2_MetaFunction,
type ActionFunction,
type LoaderArgs,
} from '@shopify/remix-oxygen';
Expand Down Expand Up @@ -53,10 +53,8 @@ export const action: ActionFunction = async ({request, context}) => {
}
};

export const meta: MetaFunction = () => {
return {
title: 'Recover Password',
};
export const meta: V2_MetaFunction = () => {
return [{title: 'Recover Password'}];
};

export default function Recover() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {
type MetaFunction,
type V2_MetaFunction,
redirect,
json,
type ActionFunction,
Expand Down Expand Up @@ -88,10 +88,8 @@ export const action: ActionFunction = async ({request, context, params}) => {
}
};

export const meta: MetaFunction = () => {
return {
title: 'Register',
};
export const meta: V2_MetaFunction = () => {
return [{title: 'Register'}];
};

export default function Register() {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
json,
redirect,
type MetaFunction,
type V2_MetaFunction,
type ActionFunction,
} from '@shopify/remix-oxygen';
import {Form, useActionData} from '@remix-run/react';
Expand Down Expand Up @@ -97,10 +97,8 @@ export const action: ActionFunction = async ({
}
};

export const meta: MetaFunction = () => {
return {
title: 'Reset Password',
};
export const meta: V2_MetaFunction = () => {
return [{title: 'Reset Password'}];
};

export default function Reset() {
Expand Down
1 change: 1 addition & 0 deletions templates/demo-store/remix.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ module.exports = {
future: {
unstable_postcss: true,
unstable_tailwind: true,
v2_meta: true,
},
};