Blocks

Individual form and UI components with SDK logic built in — use these for custom layouts, step reordering, or inserting your own content between SDK steps. See the Component types guide for a comparison of workflows, blocks, and hooks.

🧩 Blocks

Component	Description
CompanyOnboarding.AssignSignatory	Lets a user either create a new signatory with full details or invite someone else to become the signatory.
CompanyOnboarding.BankAccount	Manages a company's bank account — adding, viewing, and verifying it.
CompanyOnboarding.CreateSignatory	Standalone form for creating or editing a company signatory, including name, contact details, SSN, date of birth, and home address.
CompanyOnboarding.DocumentList	Displays the list of company documents to be signed and lets the user manage signatories.
CompanyOnboarding.DocumentSigner	Company onboarding step for reading and signing required company documents.
CompanyOnboarding.FederalTaxes	Collects company federal tax information including EIN, tax payer type, filing form, and legal name.
CompanyOnboarding.Industry	Selects and saves the company's industry classification (NAICS code).
CompanyOnboarding.InviteSignatory	Standalone form for inviting someone else to become the company signatory.
CompanyOnboarding.LocationForm	Standalone form for creating a new company location or editing an existing one.
CompanyOnboarding.Locations	Orchestrated component for managing a company's mailing and filing addresses.
CompanyOnboarding.LocationsList	Displays the list of work locations for a company.
CompanyOnboarding.OnboardingOverview	Displays the company's overall onboarding status, showing completed steps alongside any remaining requirements.
CompanyOnboarding.PaySchedule	Manages a company's pay schedules, including listing existing schedules and creating or editing one.
CompanyOnboarding.SignatureForm	Standalone form for signing an individual company document.
CompanyOnboarding.StateTaxes	Orchestrated flow for managing a company's state tax setup.
CompanyOnboarding.StateTaxesForm	Standalone form for editing a company's state tax requirements for a single state.
CompanyOnboarding.StateTaxesList	Displays the list of state tax requirements for a company with their setup status.
CompanyOnboarding.TaxRateManagement	Standalone view of a company's effective-dated state tax rate history, with the ability to schedule a new future-dated rate.
ContractorManagement.ContractorList	Renders a tabbed list of a company's contractors split across Active, Onboarding, and Dismissed tabs, with per-row actions tailored to each tab (edit, delete, view details, dismiss, rehire, cancel a scheduled dismissal or rehire).
ContractorManagement.CreatePayment	Form for creating a contractor payment group, including date selection, per-contractor edits, preview, and submission blockers.
ContractorManagement.PaymentHistory	Displays a contractor payment group, including each individual contractor payment, with actions to view details or cancel.
ContractorManagement.PaymentsList	Displays a list of contractor payment groups for a company.
ContractorManagement.PaymentStatement	Displays a single contractor's payment statement within a payment group, including wage breakdown, bonuses, reimbursements, and a receipt card for funded direct-deposit payments.
ContractorManagement.PaymentSummary	Displays a summary of a created contractor payment group, including payment totals, debit information, contractor details, and wire transfer instructions when required.
ContractorOnboarding.Address	Form for collecting and updating a contractor's mailing address. Renders a business or home address title based on the contractor type.
ContractorOnboarding.ContractorList	Lists a company's contractors with controls to add, edit, delete, cancel self-onboarding, and continue onboarding.
ContractorOnboarding.ContractorProfile	Form for creating or editing a contractor profile, supporting both individual and business contractor types.
ContractorOnboarding.ContractorSubmit	Finalizes contractor onboarding by updating the onboarding status, and in the self-onboarding flow can trigger an invitation to the contractor.
ContractorOnboarding.DocumentSigner	Contractor onboarding step for reading and signing required contractor documents.
ContractorOnboarding.DocumentsList	Lists a contractor's documents and lets the contractor open each one for signing.
ContractorOnboarding.Landing	Landing page for the contractor self-onboarding flow. Displays a welcome message and the list of onboarding steps the contractor needs to complete.
ContractorOnboarding.NewHireReport	Collects new hire reporting information for a contractor and persists it to the contractor record.
ContractorOnboarding.OnboardingSummary	Confirmation screen shown at the end of the contractor self-onboarding flow. Lets the contractor know their information has been submitted and emits contractor/selfOnboarding/done when they acknowledge it.
ContractorOnboarding.PaymentMethod	Manages a contractor's payment method, capturing a bank account for direct deposit or recording check as the payment method.
ContractorOnboarding.SignatureForm	Standalone form for signing an individual contractor document (W-9).
EmployeeManagement.Compensation	Self-contained block for viewing and managing an employee's jobs and compensation — the same experience the dashboard surfaces, but as a drop-in component that doesn't require the surrounding dashboard chrome.
EmployeeManagement.CompensationAddAnotherJobForm	Standalone form for adding a secondary job and compensation to an employee from the management surface.
EmployeeManagement.CompensationAddJobForm	Standalone form for adding an employee's first job and compensation from the management surface.
EmployeeManagement.CompensationCard	Standalone "Compensation" management card that displays an employee's current jobs and compensation, surfaces pending future-dated changes, and exposes edit, add, and delete affordances.
EmployeeManagement.CompensationEditForm	Standalone form that edits the compensation for a single job, branching automatically between editing the current compensation and an already-scheduled future-dated change.
EmployeeManagement.Dashboard	Employee self-service dashboard summarizing a single employee's basic details, job and pay, taxes, and documents.
EmployeeManagement.Deductions	Self-contained block for viewing and managing an employee's post-tax deductions — the same experience the dashboard surfaces, but as a drop-in component that doesn't require the surrounding dashboard chrome.
EmployeeManagement.DeductionsCard	Standalone read-only card listing an employee's active deductions, with affordances to add, edit, or delete a deduction.
EmployeeManagement.DeductionsEditForm	Standalone add/edit surface for a single employee deduction.
EmployeeManagement.DocumentManager	Read-only document viewer for the admin-facing employee dashboard. Renders the selected form's PDF — including unsigned forms, which are shown as-is. Signing is intentionally not offered here; forms are signed by the employee during onboarding, not by an admin viewing the dashboard.
EmployeeManagement.Documents	Standalone employee documents management flow.
EmployeeManagement.DocumentsCard	Standalone "Documents" (forms) card. Owns its own data fetch via useDocumentsList and renders the employee's forms in a table with a per-row "View" action. Emits employee/management/documents/card/viewRequested with { employeeId, formId } when a row's View CTA is clicked. The card is read-only — viewing or signing a form happens in the screen the parent routes to — and renders no alerts: alert rendering is the parent's responsibility.
EmployeeManagement.EmployeeList	Renders a tabbed list of a company's employees split across Active, Onboarding, and Dismissed tabs, with per-row actions tailored to each tab (edit, delete, dismiss, rehire).
EmployeeManagement.FederalTaxes	Self-contained block for viewing and editing an employee's federal tax (W-4) withholdings — the same experience the dashboard surfaces, but as a drop-in component that doesn't require the surrounding dashboard chrome.
EmployeeManagement.FederalTaxesCard	Standalone "Federal taxes" card. Owns its own data fetch via useFederalTaxesSummary and emits EMPLOYEE_MANAGEMENT_FEDERAL_TAXES_CARD_EDIT_REQUESTED when the Edit button is clicked. The card has no alert API — alert rendering (when introduced) is the orchestrator's responsibility.
EmployeeManagement.FederalTaxesEditForm	Standalone form for editing an employee's federal tax (W-4) withholdings — filing status, multiple-jobs flag, dependents, other income, deductions, and extra withholding.
EmployeeManagement.HomeAddress	Standalone employee home address management flow.
EmployeeManagement.HomeAddressCard	Standalone employee home address summary card.
EmployeeManagement.HomeAddressEditForm	Standalone employee home address edit form for creating, updating, and deleting addresses.
EmployeeManagement.PaymentMethod	Management flow for editing an employee's payment method.
EmployeeManagement.PaymentMethodBankForm	Standalone bank-account form for the management flow.
EmployeeManagement.PaymentMethodCard	Standalone "Payment" card.
EmployeeManagement.PaymentMethodSplitForm	Standalone split-paycheck form for the management flow.
EmployeeManagement.PaystubsCard	Standalone "Paystubs" card. Owns its own data fetch via usePaystubsList and renders the paginated paystubs table with a per-row PDF download action. Emits the management block's scoped events (EMPLOYEE_MANAGEMENT_PAYSTUBS_CARD_*) on download request and on download success. The card has no edit transitions and no alert API — paystubs is a read-only surface whose only action is a download side effect that opens the PDF in a new tab.
EmployeeManagement.Profile	Management surface for viewing and editing an employee's basic profile details after onboarding.
EmployeeManagement.ProfileCard	Read-only card showing an employee's basic profile details with an Edit action.
EmployeeManagement.ProfileEditForm	Standalone edit form for an employee's basic profile details.
EmployeeManagement.StateTaxes	Standalone state-tax management flow for a given employee. Renders the read-only summary card and the edit form, switching between them as the partner-emitted events from StateTaxesCard and StateTaxesEditForm drive the internal state machine.
EmployeeManagement.StateTaxesCard	Standalone read-only summary card showing an employee's per-state tax withholding answers. Fetches its own data and surfaces an Edit button that emits an event for the orchestrator to swap in the edit form.
EmployeeManagement.StateTaxesEditForm	Standalone edit screen for the state-tax management flow. Renders the shared state-tax form against the Employee.Management.StateTaxes namespace and emits scoped management events on submit and cancel, so partner copy overrides on the management namespace do not leak into the onboarding flow.
EmployeeManagement.TerminateEmployee	Standalone form for capturing an employee's termination details — last day of work and how to process final payroll.
EmployeeManagement.TerminationSummary	Termination summary with edit, cancel, and run-payroll actions plus an offboarding checklist.
EmployeeManagement.WorkAddress	Standalone employee work address management flow.
EmployeeManagement.WorkAddressCard	Standalone employee work address summary card.
EmployeeManagement.WorkAddressEditForm	Standalone employee work address edit form for creating, updating, and deleting addresses.
EmployeeOnboarding.Compensation	Onboarding step for collecting an employee's role and compensation details.
EmployeeOnboarding.Deductions	Onboarding step for collecting an employee's post-tax deductions and court-ordered garnishments.
EmployeeOnboarding.DocumentList	Lists the employee's documents pending signature.
EmployeeOnboarding.DocumentSigner	Onboarding step for signing employee documents.
EmployeeOnboarding.EditCompensation	Renders a form for creating or editing one of an employee's jobs together with its compensation.
EmployeeOnboarding.EmployeeDocuments	Onboarding step for selecting which documents the employee must complete.
EmployeeOnboarding.EmployeeList	Renders a paginated list of a company's employees with per-row onboarding actions (edit, delete, review, cancel self-onboarding) and an "Add employee" entry point.
EmployeeOnboarding.EmploymentEligibility	Captures the employee's I-9 employment eligibility (Section 1) before signing.
EmployeeOnboarding.FederalTaxes	Onboarding step for collecting an employee's federal tax (W-4) withholdings — filing status, multiple-jobs flag, dependents, other income, deductions, and extra withholding.
EmployeeOnboarding.I9SignatureForm	Presents the employee's I-9 form for review and signature.
EmployeeOnboarding.JobsList	Lists an employee's jobs alongside their compensation details, with controls to add, edit, or remove a job.
EmployeeOnboarding.Landing	Landing page for the employee self-onboarding flow. Displays a welcome message and the list of onboarding steps the employee needs to complete.
EmployeeOnboarding.OnboardingSummary	Displays a summary of an employee's onboarding status, listing completed and outstanding steps. Rendered as a standalone step inside OnboardingFlow.
EmployeeOnboarding.PaymentMethod	Onboarding step for setting up an employee's payment method.
EmployeeOnboarding.Profile	Onboarding step for collecting an employee's basic profile and addresses.
EmployeeOnboarding.SignatureForm	Presents a single employee document for review and signature.
EmployeeOnboarding.StateTaxes	Onboarding step that collects an employee's per-state tax withholding answers. The set of fields is driven by the API response for each state on record.
InformationRequests.InformationRequestForm	Dynamic response form for a single information request.
InformationRequests.InformationRequestList	Displays the list of outstanding information requests for a company with a "Respond" CTA on each open request.
Payroll.ConfirmWireDetails	Wire transfer confirmation workflow for payroll funding.
Payroll.DismissalPayPeriodSelection	Pay period selection step for the dismissal payroll workflow.
Payroll.OffCycleCreation	Creation form for off-cycle (bonus or correction) payrolls.
Payroll.OffCycleDeductionsSetting	Radio control for choosing whether an off-cycle payroll skips regular deductions and contributions.
Payroll.OffCycleReasonSelection	Presents the reason selection UI for choosing between a bonus and correction off-cycle payment.
Payroll.PayrollBlockerList	Displays the list of blockers preventing payroll from being processed for a company.
Payroll.PayrollConfiguration	Handles the configuration phase of payroll processing, allowing users to review and modify employee compensation before calculating the payroll.
Payroll.PayrollEditEmployee	Editor for an individual employee's compensation within a payroll run.
Payroll.PayrollHistory	Displays historical payroll records with filtering and management capabilities.
Payroll.PayrollLanding	Main landing surface for payroll operations, with tabs for running payroll and viewing payroll history, plus inline navigation to a payroll's overview and receipt.
Payroll.PayrollList	Lists upcoming payrolls and lets users start running them.
Payroll.PayrollOverview	Final review screen for a calculated payroll before submission, with submit, cancel, and edit controls. After submission, tracks processing status and surfaces the receipt and per-employee paystub downloads once complete.
Payroll.PayrollReceipts	Displays a detailed receipt for a completed payroll, including the debited total, per-category breakdown, tax breakdown, and a per-employee summary of payment method, garnishments, reimbursements, taxes, and net pay.
Payroll.RecoveryCases	Displays open recovery cases for a company and provides an in-modal resubmit workflow for resolving them.
Payroll.TransitionCreation	Creation form for transition payrolls covering the gap between an old and new pay schedule.
TimeOff.AddEmployeesHoliday	Employee selection screen for assigning employees to a company's holiday pay policy.
TimeOff.AddEmployeesToPolicy	Employee selection screen for assigning employees to a sick or vacation time off policy.
TimeOff.HolidaySelectionForm	Lets a user select which US federal holidays are observed by the company's holiday pay policy.
TimeOff.PolicyConfigurationForm	Form for creating or editing the details of a sick or vacation time off policy — its name and accrual configuration.
TimeOff.PolicyList	Displays all active time off policies (sick, vacation, and holiday) for a company.
TimeOff.PolicySettings	Configures additional policy limits and rules for a sick or vacation policy. This step is skipped for policies with unlimited accrual.
TimeOff.PolicySettingsPresentation	Presentation-only form for configuring time off policy limits and rules.
TimeOff.PolicyTypeSelector	Selection screen for choosing which kind of time-off policy to create — sick, vacation, or holiday.
TimeOff.TimeOffPolicyDetail	Detail view for a sick or vacation time-off policy.
TimeOff.TimeOffPolicyDetailPresentation	Presentational detail view for sick and vacation time-off policies.
TimeOff.ViewHolidayEmployees	Displays the holiday policy detail view with the employees tab selected.
TimeOff.ViewHolidayPolicyDetails	Displays the holiday pay policy for a company with tabbed views of the included holidays and the enrolled employees.
TimeOff.ViewHolidaySchedule	Displays the holiday policy detail view with the holidays tab selected.

BaseComponentInterface

Props for SDK feature components that participate in the standard error/loading/observability surface.

Remarks

Extends CommonComponentInterface with the onEvent callback that emits component events and optional overrides for the error-boundary fallback and loading indicator. This is the prop shape mixed into every public SDK feature component.

Extends

• CommonComponentInterface<TResourceKey>

Extended by

• InformationRequestListProps
• InformationRequestFormProps
• PayrollConfigurationProps
• PayrollEditEmployeeProps
• PayrollHistoryProps
• PayrollLandingProps
• PayrollListBlockProps
• OffCycleReasonSelectionProps
• PayrollOverviewProps
• PayrollFlowProps
• PayrollReceiptsProps
• ConfirmWireDetailsProps
• PayrollBlockerListProps
• OffCycleCreationProps
• DismissalPayPeriodSelectionProps
• TransitionCreationProps
• PolicyListProps
• PolicyTypeSelectorProps
• PolicyConfigurationFormProps
• PolicySettingsProps
• AddEmployeesToPolicyProps
• HolidaySelectionFormProps
• AddEmployeesHolidayProps
• ViewHolidayEmployeesProps
• ViewHolidayPolicyDetailsProps
• ViewHolidayScheduleProps
• TimeOffPolicyDetailProps
• TimeOffFlowProps
• OnboardingFlowProps
• SelfOnboardingFlowProps
• EmployeeListProps
• OnboardingSummaryProps
• LandingProps
• DocumentSignerProps
• EmploymentEligibilityProps
• DocumentListProps
• SignatureFormProps
• I9SignatureFormProps
• EmployeeDocumentsProps
• ProfileProps
• CompensationProps
• JobsListProps
• FederalTaxesProps
• StateTaxesProps
• DeductionsProps
• PaymentMethodProps
• ManagementEmployeeListProps
• EmployeeListFlowProps
• DocumentsProps
• DocumentManagerProps
• DashboardFlowProps
• DashboardProps
• HomeAddressProps
• HomeAddressEditFormProps
• WorkAddressProps
• WorkAddressEditFormProps
• FederalTaxesProps
• FederalTaxesEditFormProps
• StateTaxesProps
• StateTaxesEditFormProps
• ProfileProps
• ProfileEditFormProps
• PaymentMethodProps
• DeductionsProps
• DeductionsEditFormProps
• CompensationProps
• TerminateEmployeeProps
• TerminationSummaryProps
• TerminationFlowProps
• OnboardingFlowProps
• OnboardingOverviewProps
• DocumentSignerProps
• DocumentListProps
• SignatureFormProps
• IndustryProps
• BankAccountProps
• LocationsProps
• LocationFormProps
• LocationsListProps
• PayScheduleProps
• FederalTaxesProps
• StateTaxesProps
• StateTaxesFormProps
• StateTaxesListProps
• TaxRateManagementProps
• AssignSignatoryProps
• CreateSignatoryProps
• InviteSignatoryProps
• OnboardingFlowProps
• SelfOnboardingFlowProps
• LandingProps
• OnboardingSummaryProps
• ContractorListProps
• ContractorProfileAdminProps
• ContractorProfileSelfOnboardingProps
• PaymentMethodProps
• NewHireReportProps
• ContractorSubmitProps
• DocumentsListProps
• SignatureFormProps
• ManagementContractorListProps
• PaymentFlowProps
• PaymentsListProps
• CreatePaymentProps
• PaymentHistoryProps
• PaymentStatementProps

Type Parameters

Type Parameter	Default type	Description
TResourceKey extends keyof Resources	keyof Resources	The i18n resource namespace key whose dictionary entries can be overridden.

Properties

Property	Type	Description
onEvent	OnEventType<EventType, unknown>	Callback invoked each time the component emits an event — user interactions, successful API responses, step transitions, or errors. Receives the event type constant and an optional payload whose shape varies by event. See the Event Handling guide and each component's event table for the full list of emitted events.
children?	ReactNode	Optional child content rendered inside the component's layout.
className?	string	CSS class name applied to the component's root element.
defaultValues?	unknown	Initial values pre-populated into the component's form fields before the user interacts. The exact shape depends on the specific component — refer to each component's own props type.
dictionary?	ResourceDictionary<TResourceKey>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.
FallbackComponent?	(props: FallbackProps) => Element	Custom React component rendered in place of the component when an unhandled error is caught by the component-level error boundary. Receives error and resetErrorBoundary as props. Defaults to the SDK's built-in InternalError fallback.
LoaderComponent?	(__namedParameters: object) => Element	Custom loading indicator rendered while the component's async data is fetching. Overrides the indicator configured on GustoProvider for this component instance only.

---

CommonComponentInterface

Props common to all SDK feature components, including children, an optional className, default form values, and an i18n resource dictionary override.

Extended by

• BaseComponentInterface
• OffCycleDeductionsSettingProps
• EditCompensationProps
• CompensationEditFormProps
• CompensationAddJobFormProps
• CompensationAddAnotherJobFormProps

Type Parameters

Type Parameter	Default type	Description
TResourceKey extends keyof Resources	keyof Resources	The i18n resource namespace key whose dictionary entries can be overridden.

Properties

Property	Type	Description
children?	ReactNode	Optional child content rendered inside the component's layout.
className?	string	CSS class name applied to the component's root element.
defaultValues?	unknown	Initial values pre-populated into the component's form fields before the user interacts. The exact shape depends on the specific component — refer to each component's own props type.
dictionary?	ResourceDictionary<TResourceKey>	Overrides for the component's i18n strings. Supply a partial object whose keys match the component's resource namespace — any omitted keys fall back to SDK defaults. See the Translation guide for details.

---

RequireAtLeastOne

RequireAtLeastOne<T> = { [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>> }[keyof T]

Requires at least one property of T to be provided while leaving the rest optional.

Type Parameters

Type Parameter	Description
T	The object type whose properties are individually optional but collectively required.