Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ src/generated
src/types/i18nresources.d.ts
docs/reference/endpoint-inventory.json
docs/reference/endpoint-reference.md
docs/api/
.claude/settings.local.json
85 changes: 40 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,52 @@
# 🦎 Gusto Embedded React SDK
# Gusto Embedded React SDK

[![CI](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml/badge.svg)](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml)

To install:
A React component library for building embedded payroll experiences on top of the Gusto Embedded API.

```bash
npm install @gusto/embedded-react-sdk
```
npm add @gusto/embedded-react-sdk
```

Examples at:

https://codesandbox.io/p/sandbox/gusto-embedded-sdk-demo-employeelist-nzpslw
[Try the CodeSandbox demo](https://codesandbox.io/p/devbox/happy-ardinghelli-nzpslw)

## Documentation

Live documentation is available at: https://docs.gusto.com/embedded-payroll/docs/what-is-the-gep-react-sdk

- [What is the GEP React SDK](docs/what-is-the-gep-react-sdk.md)
- [Deciding to build with the SDK](docs/deciding-to-build-with-the-sdk/deciding-to-build-with-the-sdk.md)
- [Build Pathways - SDK, Flows & APIs](docs/deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api.md)
- [Component Types](docs/deciding-to-build-with-the-sdk/component-types.md)
- [Getting Started](docs/getting-started/getting-started.md)
- [Authentication](docs/getting-started/authentication.md)
- [Integration Guide](docs/integration-guide/integration-guide.md)
- [Versioning](docs/integration-guide/versioning.md)
- [Event Handling](docs/integration-guide/event-handling.md)
- [Event Types](docs/integration-guide/event-types.md)
- [Error Handling](docs/integration-guide/error-handling.md)
- [Composition](docs/integration-guide/composition.md)
- [Providing your own data](docs/integration-guide/providing-your-own-data.md)
- [Translation](docs/integration-guide/translation.md)
- [Routing](docs/integration-guide/routing.md)
- [Request Interceptors](docs/integration-guide/request-interceptors.md)
- [Customizing SDK UI](docs/integration-guide/customizing-sdk-ui.md)
- [Theming](docs/theming/theming.md)
- [Theming Guide](docs/theming/theming-guide.md)
- [Theme Variables](docs/theming/theme-variables.md)
- [Component Adapter](docs/component-adapter/component-adapter.md)
- [How the Component Adapter Works](docs/component-adapter/how-the-component-adapter-works.md)
- [Component Adapter Types](docs/component-adapter/component-adapter-types.md)
- [Setting up your Component Adapter](docs/component-adapter/setting-up-your-component-adapter.md)
- [Component Inventory](docs/component-adapter/component-inventory.md)
- [Component Adapter FAQ](docs/component-adapter/component-adapter-faq.md)
- [Workflows Overview](docs/workflows-overview/workflows-overview.md)
- [Company Onboarding](docs/workflows-overview/company-onboarding.md)
- [Contractor Onboarding](docs/workflows-overview/contractor-onboarding.md)
- [Employee Onboarding](docs/workflows-overview/employee-onboarding/employee-onboarding.md)
- [Employee Self-Onboarding](docs/workflows-overview/employee-onboarding/employee-self-onboarding.md)
- [Run Payroll](docs/workflows-overview/run-payroll.md)
- [Off-Cycle Payroll (Bonus & Correction)](docs/workflows-overview/off-cycle-payroll.md)
- [Dismissal Payroll](docs/workflows-overview/dismissal-payroll.md)
- [Transition Payroll](docs/workflows-overview/transition-payroll.md)
- [Hooks (Experimental)](docs/hooks/hooks.md)
- [What is the SDK?](docs/what-is-the-gep-react-sdk.md)
- **Quickstart**
- [Your First 5 Minutes](docs/quickstart/quickstart.md)
- [Your First Flow](docs/quickstart/first-flow.md)
- [Next Steps](docs/quickstart/next-steps.md)
- **Concepts**
- [Flows and Blocks](docs/concepts/flows-and-blocks.md)
- [Provider and Configuration](docs/concepts/provider-and-configuration.md)
- [Events](docs/concepts/events.md)
- [Authentication and Proxy](docs/concepts/authentication-and-proxy.md)
- [Composition](docs/concepts/composition.md)
- [Theming and Customization](docs/concepts/theming-and-customization.md)
- [Error Handling](docs/concepts/error-handling.md)
- [Internationalization](docs/concepts/i18n.md)
- **Components**
- [Components Overview](docs/components/components.md)
- [Company](docs/components/company/company.md)
- [Employee](docs/components/employee/employee.md)
- [Contractor](docs/components/contractor/contractor.md)
- [Payroll](docs/components/payroll/payroll.md)
- [Information Requests](docs/components/information-requests/information-requests.md)
- **Guides**
- [Versioning](docs/guides/versioning.md)
- [Routing](docs/guides/routing.md)
- [Request Interceptors](docs/guides/request-interceptors.md)
- [Providing Your Own Data](docs/guides/providing-your-own-data.md)
- [Observability](docs/guides/observability.md)
- [Component Adapter](docs/guides/component-adapter.md)
- [Proxy Setup](docs/guides/proxy-setup.md)
- [Theme Variables](docs/guides/theme-variables.md)
- **Hooks (Experimental)**
- [Hooks Overview](docs/hooks/hooks.md)
- [useEmployeeDetailsForm](docs/hooks/useEmployeeDetailsForm.md)
- [useCompensationForm](docs/hooks/useCompensationForm.md)
- [useWorkAddressForm](docs/hooks/useWorkAddressForm.md)
- [usePayScheduleForm](docs/hooks/usePayScheduleForm.md)
- [useSignCompanyForm](docs/hooks/useSignCompanyForm.md)
- [useSignEmployeeForm](docs/hooks/useSignEmployeeForm.md)
20 changes: 20 additions & 0 deletions docs/api/ach-transactions.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: ach-transactions
title: "ACH Transactions"
description: "ACH Transactions"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/bank-accounts.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: bank-accounts
title: "Bank Accounts"
description: "Bank Accounts"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/companies.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: companies
title: "Companies"
description: "Companies"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/company-attachment.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: company-attachment
title: "Company Attachment"
description: "Company Attachment"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/company-benefits.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: company-benefits
title: "Company Benefits"
description: "Company Benefits"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/company-forms.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: company-forms
title: "Company Forms"
description: "Company Forms"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/contractor-documents.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: contractor-documents
title: "Contractor Documents"
description: "Contractor Documents"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/contractor-forms.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: contractor-forms
title: "Contractor Forms"
description: "Contractor Forms"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/contractor-payment-groups.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: contractor-payment-groups
title: "Contractor Payment Groups"
description: "Contractor Payment Groups"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/contractor-payment-method.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: contractor-payment-method
title: "Contractor Payment Method"
description: "Contractor Payment Method"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/contractor-payments.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: contractor-payments
title: "Contractor Payments"
description: "Contractor Payments"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

20 changes: 20 additions & 0 deletions docs/api/contractors.tag.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
id: contractors
title: "Contractors"
description: "Contractors"
custom_edit_url: null
---







```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
```

1 change: 1 addition & 0 deletions docs/api/delete-department.ParamsDetails.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"parameters":[{"name":"department_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the department"},{"name":"X-Gusto-API-Version","in":"header","required":false,"description":"Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
1 change: 1 addition & 0 deletions docs/api/delete-department.RequestSchema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"title":"Body"}
1 change: 1 addition & 0 deletions docs/api/delete-department.StatusCodes.json

Large diffs are not rendered by default.

Loading
Loading