books-ui
UI component library for use in pay theory Books web app
Hooks
- Hooks maintain the application state between pages and components
- They wrap portions of the application providing context
- imported via
import { BooksHooks } from "@paytheory/books-ui/dist/BooksUI" - JSX example
<BooksHooks.context.menu.Provider value={generateMenu()}>
<BooksComponents.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
- imported via
import { BooksComponents } from "@paytheory/books-ui/dist/BooksUI" - JSX example
<BooksComponents.BodyHead />
General Use
- BodyHead
- CardRow
- CardTable
- ClickToCopyText
- DynamicList
- FormHead
- GlobalStyle
- InnerTable
- ModalContent
- ModalSpinner
- NavigationDrawer
- PortalHead
- SubsectionHead
- TabMenu
- TabPage
- TextEntry
- TextEntryCurrency
- TextEntryPercentage
- UtilityBar
User Accounts
User Roles
Connections
District
Donation / Payment Item
- DonationItemEntry
- PaymentItemPublishCard
- PaymentItemDiscontinueCard
- PaymentItemTable
- ModalCreatePaymentItem