Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.authplugin.com/llms.txt

Use this file to discover all available pages before exploring further.

Auth Plugin generates an AuthPluginOverrides.ts file with code overrides that you can apply to any Framer element — not just Auth Plugin components.

​
How to Use

  1. Insert Code Overrides from the Components page
  2. The override file appears in your Framer project’s code
  3. Select any element on your canvas
  4. In the right panel, click Code Overrides
  5. Select AuthPluginOverrides and choose the override

​
Available Overrides

​
Visibility Overrides

OverrideDescription
ShowWhenAuthenticatedElement is visible only when the user is signed in
ShowWhenGuestElement is visible only when the user is NOT signed in

​
Data Injection Overrides

OverrideDescription
IdentityNameReplaces element’s text content with the user’s full name
IdentityEmailReplaces element’s text content with the user’s email address

​
Action Overrides

OverrideDescription
TriggerSignOutSigns out the user when the element is clicked

​
Examples

​
Show a “Sign In” button only to guests

Apply ShowWhenGuest override to the button element.

​
Show “Welcome, John” text

  1. Add a text element with placeholder text
  2. Apply IdentityName override
  3. The text automatically changes to the user’s name when signed in

​
Sign out from any element

Apply TriggerSignOut override to any button or link — clicking it will sign out the user.