Skip to content

pay-theory/pay-theory-ui

Repository files navigation

pay-theory-ui

UI component library for use in Pay Theory web apps

Codacy Badge Codacy Badge Known Vulnerabilities NPM JavaScript Style Guide

Install

npm install --save pay-theory-ui

Hooks

  • Hooks maintain the application state between pages and components
  • They wrap portions of the application providing context
  • imported via import { BooksHooks } from "@paytheory/pay-theory-ui"
  • JSX example
<BooksHooks.Context.Menu.Provider value={generateMenu()}>
	<NavigationDrawer />
</BooksHooks.Context.Menu.Provider>

Application Hooks

  • checkout - provides base URL for checkout links
  • menu - provides menu items for the navigation drawer
  • page - provides page meta data
  • parent - provides navigation details for child pages

Application Data Hooks

User Accounts

  • account - basic user account detail (used for user menu)
  • member - detailed user account detail (used for user overview)
  • accounts - list of user accounts

Districts

  • district - district detail
  • districts - district list

Partners

  • partner - partner detail
  • partners - partner list

Payment Items

  • payment-item - payment item detail
  • payment-items - payment item list

Receipts

  • receipt - receipt detail
  • receipts - receipt list

Roles

  • role - role detail
  • roles - role list

Components

  • Components are custom HTML elements that encapsulate pay theory branding and user experience
  • They are composed into pages by our application to deliver our app
  • each component imported individually via import { BodyHead } from "@paytheory/pay-theory-ui"
  • JSX example <BodyHead />

Common

Auth

Admin

Admin User Accounts

User Roles

Connections

District

Donation / Payment Item

Partner

Receipts Components

Sales

USAS Account Codes

License

MIT © pay-theory

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •