Documentation Index
Fetch the complete documentation index at: https://autorender.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Installation
npm install @autorender/sdk-nextjs
Next.js configuration
Wrap your config with withAutorender in next.config.js or next.config.ts:
import type { NextConfig } from 'next';
import { withAutorender } from '@autorender/sdk-nextjs/next-config';
const nextConfig: NextConfig = {
// your other options
};
export default withAutorender(nextConfig);
Upload SDK Usage
'use client';
import { AutorenderUploader } from '@autorender/sdk-nextjs';
import '@autorender/sdk-nextjs/styles';
export default function UploadPage() {
return (
<AutorenderUploader
apiKey={process.env.NEXT_PUBLIC_AUTORENDER_API_KEY!}
folderPath="uploads"
/>
);
}
ViewTag SDK Usage
Setup Provider
'use client';
import { AutoRenderProvider } from '@autorender/sdk-nextjs';
export default function RootLayout({ children }) {
return (
<AutoRenderProvider
baseUrl="https://assets.autorender.io"
workspace="ws_123"
defaults={{}}
>
{children}
</AutoRenderProvider>
);
}
Use ARImage Component
'use client';
import { ARImage } from '@autorender/sdk-nextjs';
export default function ProductPage() {
return (
<ARImage
src="products/shoe.jpg"
width={400}
height={400}
alt="Shoe"
transformations={{ fit: 'cover' }}
responsive={true}
lazy={true}
/>
);
}
Use ARVideo Component
'use client';
import { ARVideo } from '@autorender/sdk-nextjs';
export default function ProductVideoPage() {
return (
<ARVideo
src="docs/skateboarding.mp4"
width={960}
height={540}
controls
preload="metadata"
transformations={{ w: 960, h: 540 }}
/>
);
}
'use client';
import { ARImage } from '@autorender/sdk-nextjs';
import type { TransformOptions } from '@autorender/sdk-core';
export default function HeroPage() {
const transform: TransformOptions = {
w: 1200,
h: 800,
fit: 'cover',
ar: '16:9',
position: 'center',
improve: true,
sharpen: 50,
layers: [
{
type: 'image',
imagePath: 'logo.png',
width: 200,
placement: 'north-east',
}
],
blend: 'overlay',
};
return (
<ARImage
src="hero.jpg"
width={1200}
height={800}
alt="Hero image"
transformations={transform}
responsive={true}
className="hero-image"
/>
);
}