Skip to content

Documentation / @frak-labs/components / ButtonShareProps

Type Alias: ButtonShareProps

ButtonShareProps = { classname?: string; clickAction?: "embedded-wallet" | "share-modal" | "sharing-page"; noRewardText?: string; placement?: string; targetInteraction?: InteractionTypeKey; text?: string; useReward?: boolean; }

Defined in: sdk/components/src/components/ButtonShare/types.ts:7

The props type for ButtonShare.

Extended by

Properties

classname?

optional classname?: string

Defined in: sdk/components/src/components/ButtonShare/types.ts:18

Classname to apply to the button


clickAction?

optional clickAction?: "embedded-wallet" | "share-modal" | "sharing-page"

Defined in: sdk/components/src/components/ButtonShare/types.ts:36

Which UI to open on click

Default Value

"embedded-wallet"


noRewardText?

optional noRewardText?: string

Defined in: sdk/components/src/components/ButtonShare/types.ts:27

Fallback text if the reward isn't found


placement?

optional placement?: string

Defined in: sdk/components/src/components/ButtonShare/types.ts:8


targetInteraction?

optional targetInteraction?: InteractionTypeKey

Defined in: sdk/components/src/components/ButtonShare/types.ts:31

Target interaction behind this sharing action (will be used to get the right reward to display)


text?

optional text?: string

Defined in: sdk/components/src/components/ButtonShare/types.ts:14

Text to display on the button

  • To specify where the reward should be displayed, use the placeholder {REWARD}, e.g. Share and earn up to \{REWARD\}!

Default Value

"Share and earn!"


useReward?

optional useReward?: boolean

Defined in: sdk/components/src/components/ButtonShare/types.ts:23

Do we display the reward on the share modal?

Default Value

false