⚠️ Notice ⚠️

This library is no longer maintained, please use ssi-sdk instead.

Important: This repository is no longer maintained. It has been moved to the attestations-es monorepo.

Share Kit React

React wrapper for Share Kit

• Share Kit React
  • Installation
  • Usage
  • More

Installation

npm install --save @bloomprotocol/share-kit-react

Usage

RequestElement will render a QR code or button based on the client's platform. By defualt it will render a button when the client is mobile or tablet and on iOS.

import * as React from 'react'
import {RequestElement, RequestData, QROptions, ButtonOptions} from '@bloomprotocol/share-kit-react'

const requestData: RequestData = {...}
const buttonOptions: ButtonOptions = {
  callbackUrl: 'https://mysite.com/bloom-callback',
}

<RequestElement
  requestData={requestData}
  buttonOptions={buttonOptions}
/>

// Setting QR Options

const qrOptions: Partial<QROptions> = {
  size: 200,
}

<RequestElement
  requestData={requestData}
  buttonOptions={buttonOptions}
  qrOptions={qrOptions}
/>

// Overriding shouldRenderButton
<RequestElement
  requestData={requestData}
  buttonOptions={buttonOptions}
  shouldRenderButton={(parsedResult) => {
    if (parsedResult.platform.type === 'mobile') return true

    return false
  }}
/>

// Passing props to the container
<RequestElement
  requestData={requestData}
  buttonOptions={buttonOptions}
  className="request-element-container"
/>

More

For more information and documentation see Share Kit