Skip to main content

WorkPayCore Frontend Documentation

Welcome to the comprehensive documentation for the utility functions, helpers, components, and libraries used in the WorkPayCore Frontend application.

📚 What's Documented​

This documentation covers all the utility functions, helpers, constants, components, and libraries that power the WorkPayCore frontend application. Each utility is documented with:

  • Purpose: What the utility does
  • Parameters: Input parameters and types
  • Return Values: What the function returns
  • Usage Examples: How to use the utility in your code
  • Related Functions: Other utilities that work well together

🗂️ Organization​

Our utilities are organized into several categories:

🔧 Core Utils​

  • String Utilities: Text manipulation and formatting functions
  • Number Utilities: Mathematical operations and number formatting
  • Object & Array Utilities: Data structure manipulation helpers
  • Date & Time Utilities: Date formatting, parsing, and manipulation

🏗️ Helpers​

  • General Helpers: Common utility functions used throughout the app
  • Feature Flags: Feature flag management utilities
  • Encryption: Security and encryption helpers
  • Analytics: Analytics tracking helpers
  • Phone Number: Phone number validation and formatting
  • Country Helpers: Country-specific utilities

📋 Constants​

  • Feature Flags: Application feature flag definitions
  • File Types: MIME type constants
  • Options: Dropdown and selection options
  • Session Keys: Session storage key definitions
  • Settings: Application configuration constants
  • Status Codes: Various status code definitions

🎨 Components​

  • Layout Components: Page templates, sidebars, navigation, and wrapper components
  • Form Components: Input fields, selects, date/time pickers, and form layouts
  • Display Components: Tables, dashboards, status displays, charts, and data visualization
  • Interactive Components: Buttons, modals, drawers, tabs, and dropdown menus
  • Utility Components: Loaders, skeletons, error states, notifications, and tooltips
  • Icon Components: Custom icons, WP icon library, and icon utilities
  • Specialized Components: Calendar, maps, integrations, and domain-specific components

📦 Libraries​

  • API Utilities: HTTP request and response handling
  • Axios Configuration: HTTP client setup and interceptors
  • Execution Utilities: Function execution helpers

🚀 Getting Started​

Navigate through the sidebar to explore different categories of utilities and components. Each section provides detailed documentation with practical examples.

💡 Quick Tips​

  • Use the search bar to quickly find specific utilities or components
  • Each utility includes TypeScript definitions for better development experience
  • Code examples are provided with copy-to-clipboard functionality
  • Related utilities are cross-referenced for easier discovery
  • Component documentation includes props, usage examples, and best practices

This documentation is automatically generated and maintained alongside the codebase.