Skip to content

fix: change from version to draft #42

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.

Sign up for GitHub

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

Merged
iiroj merged 1 commit into from
Oct 21, 2025
Merged

fix: change from version to draft #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,11 @@ interface UsercentricsScriptProps
settingsId: string

/**
* Whether to run Usercentrics in "production" or "preview" mode
* @default "production"
* Whether to run Usercentrics in draft mode
* @default `false`
* @see https://usercentrics.com/docs/web/implementation/ui/optional-steps/#draft-script
*/
version?: 'production' | 'preview'
draft?: boolean

src?: never
}
Expand All @@ -114,7 +115,7 @@ interface UsercentricsScriptProps
;() => <UsercentricsScript settingsId="1234" />

/** Preview mode for development */
;() => <UsercentricsScript settingsId="1234" version="preview" />
;() => <UsercentricsScript settingsId="1234" draft={true} />

/* Fixed language code */
;() => <UsercentricsScript settingsId="1234" language="fi" />
Expand Down
11 changes: 6 additions & 5 deletions src/components/UsercentricsScript.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ interface UsercentricsScriptProps
settingsId: string

/**
* Whether to run Usercentrics in "production" or "preview" mode.
* @default "production"
* Whether to run Usercentrics in draft mode
* @default `false`
* @see https://usercentrics.com/docs/web/implementation/ui/optional-steps/#draft-script
*/
version?: 'production' | 'preview'
draft?: boolean

src?: never
}
Expand All @@ -41,7 +42,7 @@ export const UsercentricsScript: FC<UsercentricsScriptProps> = ({
id = 'usercentrics-cmp',
language,
settingsId,
version,
draft = false,
...rest
}) => {
return (
Expand All @@ -50,7 +51,7 @@ export const UsercentricsScript: FC<UsercentricsScriptProps> = ({
async={'async' in rest ? rest.async : true}
data-language={language}
data-settings-id={settingsId}
data-version={version}
data-draft={draft ? true : undefined}
id={id}
src={USERCENTRICS_WEB_CMP_LOADER_SCRIPT_URL}
/>
Expand Down
4 changes: 2 additions & 2 deletions tests/components/UsercentricsScript.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ describe('Usercentrics', () => {
})

it('should render preview attribute', () => {
const result = renderToStaticMarkup(<UsercentricsScript settingsId="1234" version="preview" />)
const result = renderToStaticMarkup(<UsercentricsScript settingsId="1234" draft={true} />)

expect(result).toMatch('data-version="preview"')
expect(result).toMatch('data-draft="true"')
})

it('should allow disabling default async prop', () => {
Expand Down