npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dsadada

v1.1.2

Published

React custom hook - generating card token

Downloads

2

Readme

useToolkit

useToolkit is a custom hook used to generate a card token.

Installation

run npm i @rapyd/use-toolkit

Usage

import { ToolkitWrap, useToolkit } from '@rapyd/use-toolkit';

ToolkitWrap is the component wrapper which holds the div element, that the iframe will be rendered into.

useToolkit is the custom hook which enables to get a card token by filling card details.

Information

useToolkit can accept the following parameters:

callback functions ->

onSuccess - a callback function that should run after generating the card succeeded

onFail - a callback function that should run after generating the card failed

onValidationFail - a callback function that should run when there is a validation error in one of the fields ( after submitting )

onFormStatusUpdate - a callback function that should run when form completion status is being changed

styles - a custom object which can be injected to control the styles. can be an object or a function which will be triggered when there is a change in the element style. the function being executed with the following params: name (the name of the field) touched (if the field was being touched) error (the error of the current field, empty string if valid)

validation - a custom object which can be injected to control the validation of the fields. every field can get a custom validation passed from outside, except the 'card_number' field which uses luhn algorithm to validate the card number.

the object includes key value pairs -> key is the field name, value is an object with the following shape: { empty: 'empty error message', validate: [ { regex: /^.{3,5}$/, errorMessage: 'not 3-5 chars' }, { regex: /^.{10,12}$/, errorMessage: 'not 10-12 chars' } ] }

formatting - a custom array which represents the name of the fields that should be formatted. supported fields with formatting are: 'card_number', 'cvv'.

env - a string, one of : 'development', 'qa', 'sandbox', 'production', 'intg' (every env has also support for passing passive)

The hook exposes a function, which responsible for submitting the form.

Example

Params that can be passed to useToolkit:

const styles = {
  fonts: [], // url string of google fonts, example: ['https://fonts.googleapis.com/css2?family=Rubik:wght@300&display=swap']

  inputs: (obj) => {
    const { name, touched, error } = obj;
      if (touched) return {
        border: '1px solid yellow'
      }
      if (error) return {
        border: '1px solid red'
      }
      return {
        border: '1px solid green'
      }
    },

  inputWrapper: {},

  inputLabel: {},

  input: {
    border: '1px solid red',
  },

  expiration: {},

  inputError: {},
};

const validations = {
  name: {
    {
      empty: 'empty error message',
      validate: [
        { regex: /^.{3,5}$/, errorMessage: 'not 3-5 chars' },
        { regex: /^.{10,12}$/, errorMessage: 'not 10-12 chars' }
      ]
    }
  }
};

const formatting = ['card_number', 'cvv'];

const onSuccess = (data) => {
  console.log('success ? ', data);
};

const onFail = (error) => {
  console.log('fail ? ', error);
};

const onValidationFail = (errors) => {
  console.log('validation fail ? ', errors);
};

const onFormStatusUpdate = (status) => {
  console.log('form status update ? ', status);
};

const toolkitParams = {
  onSuccess,

  onFail,

  onValidationFail,

  onFormStatusUpdate,

  styles,

  validations,

  formatting,

  env: 'development',
};

Usage of useToolkit:

submit function can get one param, should be an object. expected: 'access_key', 'payment_method_type'.

const toolkit = useToolkit(toolkitParams);

const { submit } = toolkit;

Usage of ToolkitWrap:

under the hood toolkit wrap will render a div with id = 'rapyd-checkout'.

return <ToolkitWrap />;