\n\n- Unframer exports your Framer components as simple .js files\n- Works with any React framework (Next.js, Remix, Vite, Astro, etc)\n- Includes all your components dependencies\n- Works with breakpoints, Framer fetch, Forms, color styles, dark mode (via `dark` class), etc\n- Full Typescript support, inferred from your component variables (like `variant`)\n\n## Usage\n\nYou can watch a [Video Tutorial on YouTube here](https://www.youtube.com/watch?v=RL2BWqNSPhU) to see an overview of the process.\n\n1. Install unframer and update react to 19\n\n ```sh\n npm install unframer react@19 react-dom@19\n ```\n\n1. Install the [`React Export` Framer plugin](https://framer.link/TGWRs2U), open it and select which components you want to export.\n\n1. Run the command `npx unframer {projectId} --outDir ./src/framer` to download the components and their types in the `outDir` directory.\n Run this command every time you add a new Framer component.\n\n1. Import the components inside your `jsx` files together with `styles.css`, for example\n\n```tsx\nimport './framer/styles.css' // load base Framer styles\nimport Menu from './framer/menus'\n\nexport default function App() {\n return (\n
\n \n
\n )\n}\n```\n\n1. To make sure everything works correctly install React 19 (latest version) and disable React Strict Mode in your app. Strict mode renders your components twice and this can cause issues with Framer animations.\n\n## Using responsive variants\n\n```tsx\nimport './framer/styles.css'\nimport Logos from './framer/logos'\n\nexport default function App() {\n return (\n
\n {/* Changes component variant based on breakpoint */}\n \n
\n )\n}\n```\n\n## Styling\n\nYou can use `className` or `style` props to style your components\n\nNotice that you will often need to use `!important` to override styles already defined in framer like `width` and `height`\n\n```tsx\nimport './framer/styles.css'\nimport Logos from './framer/logos'\n\nexport default function App() {\n return (\n
\n {/* Changes component variant based on breakpoint */}\n \n
\n )\n}\n```\n\n## Sizing components\n\nFramer components can have a fixed size, this comes from the root element in the Framer component editor. To override this size you will need to use the `style` prop or use a class with high specificity.\n\n```tsx\nimport './framer/styles.css'\nimport Logos from './framer/logos'\n\nexport default function App() {\n return (\n
\n \n
\n )\n}\n```\n\n## Changing locale\n\nYou can change locale of your component by passing `locale` prop to the component. The locale must be one of the country codes configured in your Framer project.\n\n```tsx\nimport './framer/styles.css'\nimport Logos from './framer/logos'\n\nexport default function App() {\n return (\n
\n \n
\n )\n}\n```\n\n## Dark Mode\n\nUnframer supports dark mode through CSS classes:\n\n1. Add the `dark` class to any parent element of your component\n2. This will automatically switch all color style variables to use the dark mode values defined in Framer\n\nThat's all you need to enable dark mode for your Framer components!\n\n> This is also how Tailwind's dark mode works - when you add the `dark` class to a parent element, any Tailwind dark mode classes (like `dark:bg-gray-900`) within that element will be activated. So you can seamlessly combine Framer and Tailwind dark mode by using the same `dark` class:\n\n```tsx\nimport './framer/styles.css'\nimport Logos from './framer/logos'\n\nexport default function App() {\n return (\n
\n \n
\n )\n}\n```\n\n## Using the Framer color styles as CSS variables\n\nUnframer will export your color styles as CSS variables, for example:\n\n> You can use Framer CSS variables in your own code, for example in tailwind with ``\n\n```css\n:root {\n --unframer-chambray: rgb(72, 86, 150);\n --unframer-gray: rgb(231, 231, 231);\n --unframer-off-black: rgb(16, 16, 16);\n --unframer-300: rgb(255, 160, 122);\n --unframer-500: rgb(252, 62, 19);\n --unframer-dark-gray: rgb(169, 169, 169);\n --unframer-400: rgb(254, 102, 57);\n --unframer-100: rgb(255, 227, 212);\n --unframer-50: rgb(255, 243, 237);\n --unframer-25: rgb(255, 252, 250);\n --unframer-white: rgb(255, 255, 255);\n --unframer-primary: rgb(231, 34, 8);\n}\n\n.dark {\n --unframer-chambray: rgb(161, 180, 255);\n --unframer-gray: rgb(42, 42, 42);\n --unframer-off-black: rgb(255, 255, 255);\n --unframer-300: rgb(255, 160, 122);\n --unframer-500: rgb(252, 62, 19);\n --unframer-dark-gray: rgb(176, 176, 176);\n --unframer-400: rgb(254, 102, 57);\n --unframer-100: rgb(58, 58, 58);\n --unframer-50: rgb(40, 40, 40);\n --unframer-25: rgb(30, 30, 30);\n --unframer-white: rgb(16, 16, 16);\n --unframer-primary: rgb(231, 34, 8);\n}\n```\n\n## When should I run the plugin again?\n\nYou can just run the `unframer` cli to get changes from the existing components.\n\nThe Framer plugin should be reopened when:\n\n- When you add a new component\n- When changing color styles\n- When adding new pages (this is necessary to make relative links to those pages work)\n- When adding new locales\n- When changing breakpoints\n- When changing breakpoints\n\n## Watching for changes\n\nYou can use the `--watch` flag to automatically re-export components when they change in Framer: notice that you will need to click the Publish button in Framer to trigger the cli, Framer only updates the JavaScript modules when you publish your website.\n\n\nHow it works\nUnframer cli will poll your website url every 2 seconds with a HEAD request, when the `etag` header changes it will re-export the components. This means that the --watch flag may not work if your components are not used in your main page of your Framer website.\n\n\n## Using client navigation for links\n\nIf you use a framework like Next.js or react-router you can pass a navigate function to let Unframer use client navigation instead of full page refreshes for relative links.\n\nAll Unframer components below will use this navigate function to go to the new page.\n\n```tsx\nimport { useRouter } from 'next/navigation'\nimport { UnframerProvider } from 'unframer'\n\nexport function Providers({ children }: { children: React.ReactNode }) {\n const router = useRouter()\n\n return (\n {children}\n )\n}\n```\n\n## Passing locale prop to all components with `UnframerProvider`\n\nYou can change the locale of all components under the provider passing locale prop to UnframerProvider.\n\n```tsx\nimport { UnframerProvider } from 'unframer'\n\nexport function Providers({ children }) {\n return {children}\n}\n```\n\n## How does unframer cli work?\n\nThe Framer React Export plugin saves your Framer components JavaScript url in the Unframer database. When you run the Unframer cli the components urls are fetched and bundled with esbuild. The bundler will also resolve npm dependencies in your Framer overrides and code components using the latest version.\n\nYou can customize the npm dependencies versions using the `--external` flag and installing them manually with `npm install`.\n\nUnframer will also create a `styles.css` file with the Framer global styles and the fonts used in your components.\n\nTo generate TypeScript types for your components Unframer runs your downloaded components with Node.js and extracts the TypeScript types from the component `propertyControls` field, which is used to populate the Framer right bar controls.\n\nThe Responsive component renders your components for each different breakpoint and only shows the current breakpoint via a CSS media query. The unused breakpoints are removed before hydration thanks to React [`useSyncExternalStore`](https://react.dev/reference/react/useSyncExternalStore).\n\n## Troubleshooting\n\nIf you find any errors rendering your components:\n\n- Check you have the latest version of `unframer` installed\n- If an animation is now working as expected try disabled React strict mode and updating to React 19.\n- Try downloading new versions of the components by running again `npx unframer {projectId}`, Framer may already have fixed the problem.\n- Try disabling React strict mode, this can cause many issues in Framer components.\n- If the export fails because Esbuild cannot find an export from a package (like `No matching export in \"/:https://esm.sh/zustand\" for import \"default\"`) you can use the `--external` option to externalie npm packages used by Framer, then install them manually with the right version with `npm install`.\n Framer sometimes uses legacy versions of npm packages in their components, for example with Zustand which is usually still in version 3.x. This happens because Framer packages must be the same in the whole project and their versions are fixed at the time the npm package is used in a code component or override.\n\n## Supported component props\n\n`unframer` will add TypeScript definitions for your Framer components props and variables, some example variables you can use are:\n\n- `variant`, created when you use variants in Framer\n- functions, created when you use an `event` variable in Framer\n- Any scalar variable like String, Number, Boolean, Date, etc\n- Image variables (object with `src`, `srcSet` and `alt`), created when you use an `image` variable in Framer\n- Link strings, created when you make a link a variable in Framer\n- Rich text, created when you use a `richText` variable in Framer\n- Color, a string\n- React component, created when you use a `component` variable in Framer, for example in the Ticker component\n\n## Known limitations:\n\n- You may face React warnings like:\n - `Accessing element.ref was removed in React 19.` This warning appears because Framer still uses the old `element.ref` API which was removed in React 19. This warning is harmless and will be fixed when Framer updates their codebase to use the new React 19 APIs.\n - `A tree hydrated but some attributes of the server rendered HTML didn't match the client properties.` This warning sometimes appears when using SVG icons, it should be harmless, it only happens in development mode.\n\n## Future Compatibility\n\nEvery Framer runtime change is upstreamed automatically via Github Actions to this [file](https://github.com/remorses/unframer/blob/main/unframer/src/framer.js) and an example app is deployed [here](https://unframer-nextjs-app.vercel.app/). This means that if something breaks it's easy to bisect the specific change and fix it.\n\nFor example in May 2024 Framer upgraded to React 19 and unframer broke, the reason was that framer runtime no longer injected ssr styles to `head` because react should do it automatically from version 19, this however broke unframer when using react 18, but i was able to quickly fix it by adding back the code to inject styles to `head` in unframer.\n\n## Performance\n\nUnframer renders your components with server side rendering, giving your good performance and SEO, in pair with the Framer deployed websites.\n\nHere is the below landing page Lighthouse score when using Astro:\n\n> **Important**: For best performance in development, disable React strict mode. Strict mode causes components to mount and unmount twice, which can cause issues with Framer animations and state management.\n\n\n\n## Example\n\nLook at the [nextjs-app source code folder](https://github.com/remorses/unframer/tree/main/nextjs-app) for an example and [the deployed website here](https://unframer-nextjs-app.vercel.app/)\n\n## MCP CLI Commands\n\nUnframer can act as a command-line client for the [Framer MCP plugin](https://www.framer.com/marketplace/plugins/mcp/), allowing you to interact with your Framer project directly from the terminal.\n\n### Setup\n\n```sh\n# Login with your MCP URL (get it from the Framer MCP plugin)\nnpx unframer mcp login\n```\n\nAfter login, all MCP commands become available. Run `npx unframer --help` to see the full list.\n\n### Example Commands\n\n```sh\n# Get project structure as XML\nnpx unframer mcp getProjectXml\n\n# Get a specific node's XML by ID\nnpx unframer mcp getNodeXml --nodeId \"abc123\"\n\n# Update node text or attributes\nnpx unframer mcp updateXmlForNode --nodeId \"abc123\" --xml 'New text'\n\n# Search for fonts\nnpx unframer mcp searchFonts --query \"Inter\"\n\n# Export React components\nnpx unframer mcp exportReactComponents\n\n# Get published website URL\nnpx unframer mcp getProjectWebsiteUrl\n```\n\n### CMS Operations\n\n```sh\n# List all CMS collections\nnpx unframer mcp getCMSCollections\n\n# Get items from a collection\nnpx unframer mcp getCMSItems --collectionId \"col123\"\n\n# Create or update a CMS item\nnpx unframer mcp upsertCMSItem --collectionId \"col123\" --slug \"my-post\" --fieldData '{\"title\": \"Hello\"}'\n```\n\n### Code Files\n\n```sh\n# Create a new code component\nnpx unframer mcp createCodeFile --name \"MyComponent.tsx\" --content \"export default function MyComponent() { return