Function: usePresent()

export function usePresent()

Defined in: hooks/usePresent.ts:5

Returns

object

present

present: (slug, options?) => FlowHandle<FlowResult>

Parameters

slug

string

options?

any

Returns

FlowHandle<FlowResult>

presenting

presenting: boolean

Example

usePresent() returns an awaitable present function and a presenting flag. Use it inside PlandalfProvider.

import { usePresent } from '@plandalf/react'

export function UpgradeButton() {
  const { present, presenting } = usePresent()
  async function upgrade() {
    const result = await present('upgrade')
    if (result.status === 'complete') {
      // Ask your server for the customer's current entitlement.
    }
  }
  return <button disabled={presenting} onClick={upgrade}>Upgrade</button>
}

See the full React example.