@shopify/shopify-app-remix
Version:
Shopify Remix - to simplify the building of Shopify Apps with Remix
36 lines • 1.32 kB
TypeScript
export interface AppProxyLinkProps extends React.DetailedHTMLProps<React.AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement> {
href: string;
}
/**
* Sets up an `<a />` HTML element that works when rendered behind an app proxy.
*
* Supports any properties accepted by the `<a />` HTML element.
*
* @example
* <caption>Link to a different route.</caption>
* <description>Use an `AppProxyLink` within an `AppProxyProvider` to link to a different proxied route.</description>
* ```ts
* // /app/routes/**\/*.ts
* import {authenticate} from '~/shopify.server';
* import {AppProxyProvider, AppProxyLink} from '@shopify/shopify-app-remix/react';
*
* export async function loader({ request }) {
* await authenticate.public.appProxy(request);
*
* return json({ appUrl: process.env.SHOPIFY_APP_URL });
* }
*
* export default function App() {
* const { appUrl } = useLoaderData();
*
* return (
* <AppProxyProvider appUrl={appUrl}>
* <AppProxyLink href="/other-proxy-route">Link to another route</AppProxyLink>
* </AppProxyProvider>
* );
* }
* ```
* @publicDocs
*/
export declare const AppProxyLink: import("react").ForwardRefExoticComponent<Omit<AppProxyLinkProps, "ref"> & import("react").RefAttributes<HTMLAnchorElement>>;
//# sourceMappingURL=AppProxyLink.d.ts.map