Skip to main content

EmployeeManagement

Flows and blocks for managing an employee after onboarding.

import { EmployeeManagement } from '@gusto/embedded-react-sdk'

🚂 Workflows

ComponentDescription
DashboardFlowHub for viewing and managing a single employee's profile, pay, and documents.
EmployeeListFlowHub for viewing and managing all employees, including onboarding new ones.
TerminationFlowGuided flow to terminate an employee and arrange their final paycheck.

🧩 Blocks

ComponentDescription
CompensationSelf-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.
CompensationAddAnotherJobFormStandalone form for adding a secondary job and compensation to an employee from the management surface.
CompensationAddJobFormStandalone form for adding an employee's first job and compensation from the management surface.
CompensationCardStandalone "Compensation" management card that displays an employee's current jobs and compensation, surfaces pending future-dated changes, and exposes edit, add, and delete affordances.
CompensationEditFormStandalone form that edits the compensation for a single job, branching automatically between editing the current compensation and an already-scheduled future-dated change.
DashboardEmployee self-service dashboard summarizing a single employee's basic details, job and pay, taxes, and documents.
DeductionsSelf-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.
DeductionsCardStandalone read-only card listing an employee's active deductions, with affordances to add, edit, or delete a deduction.
DeductionsEditFormStandalone add/edit surface for a single employee deduction.
DocumentManagerRead-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.
DocumentsStandalone employee documents management flow.
DocumentsCardStandalone "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.
EmployeeListRenders 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).
FederalTaxesSelf-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.
FederalTaxesCardStandalone "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.
FederalTaxesEditFormStandalone form for editing an employee's federal tax (W-4) withholdings — filing status, multiple-jobs flag, dependents, other income, deductions, and extra withholding.
HomeAddressStandalone employee home address management flow.
HomeAddressCardStandalone employee home address summary card.
HomeAddressEditFormStandalone employee home address edit form for creating, updating, and deleting addresses.
PaymentMethodManagement flow for editing an employee's payment method.
PaymentMethodBankFormStandalone bank-account form for the management flow.
PaymentMethodCardStandalone "Payment" card.
PaymentMethodSplitFormStandalone split-paycheck form for the management flow.
PaystubsCardStandalone "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.
ProfileManagement surface for viewing and editing an employee's basic profile details after onboarding.
ProfileCardRead-only card showing an employee's basic profile details with an Edit action.
ProfileEditFormStandalone edit form for an employee's basic profile details.
StateTaxesStandalone 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.
StateTaxesCardStandalone 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.
StateTaxesEditFormStandalone 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.
TerminateEmployeeStandalone form for capturing an employee's termination details — last day of work and how to process final payroll.
TerminationSummaryTermination summary with edit, cancel, and run-payroll actions plus an offboarding checklist.
WorkAddressStandalone employee work address management flow.
WorkAddressCardStandalone employee work address summary card.
WorkAddressEditFormStandalone employee work address edit form for creating, updating, and deleting addresses.