isClaimEnabled

Controls whether the claim call to action is clickable. Set it to false to turn off and gray out the claim button while still showing the offer.

Structure

Encore.isClaimEnabled: boolean   // default true; read and assigned directly

When to use it

Turn it off when a claim would fail or conflict for reasons only your app knows, and showing the offer unavailable beats hiding it:

The user is mid-checkout in one of your own flows.
Their account is in a state the advertiser rejects.
You are running a maintenance window on your side of the integration.

// Entering a flow where claiming would conflict
Encore.isClaimEnabled = false;

// Leaving it
Encore.isClaimEnabled = true;

const result = await Encore.placement('milestone_reached', { useCase: 'rewardUsers' }).show();

Behavior

Aspect	Behavior
Rendering	The offer, copy, and imagery still render. Only the claim button changes: it grays out and no longer responds to a click.
Coverage	Applies to every claim surface: the per-card Claim button in the built-in `'reduceChurn'` carousel, the single bottom call to action in the built-in `'rewardUsers'` sheet, and every claim button in a served variant.
With a custom claim button	Applies there too. A `claimButton` appearance slot is your styling, but the claim stays the SDK’s, and so does this gate.
Dismissal	Always available. The built-in `'rewardUsers'` sheet’s “No thanks”, the close button, and backdrop dismissal are never affected.
Reporting	A sheet shown with claiming off is a real presentation, and resolves through `show()` like any other.

The flag is read when the sheet is built, so it applies from the next show() onward. Assigning it while a sheet is on screen does not change the sheet in front of the user.

Marking up your own claim button

If you supply your own claim button through the claimButton appearance slot, the SDK still owns whether it acts, and turning this flag off makes your element unavailable along with everything else. It cannot carry the native disabled attribute, because that attribute only means something on a <button> and your element is mounted inside a role="button" host. The host carries aria-disabled="true" instead and leaves the tab order, so assistive technology and keyboard users get the same answer as everyone else. If you style the unavailable state yourself, target both forms:

/* The SDK's own button */
.encore-reward-cta-primary:disabled { opacity: 0.5; }

/* Your element's host, when you supplied a claimButton slot */
.encore-reward-cta-primary[aria-disabled='true'] { opacity: 0.5; }

placement(): the sheet this gate applies to.
show(): the result contract, which this flag does not change.
Advanced UI: supplying your own claim button, which this gate still applies to.

iOS

Android

Web

Bridges

isClaimEnabled

Structure

When to use it

Behavior

Marking up your own claim button

Structure

When to use it

Behavior

Marking up your own claim button

Related